Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Certificate Authorities (iam/v2) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-certificate-authorities-iam-v2-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/iam/v2/certificate-authorities'].get

$.paths['/iam/v2/certificate-authorities'].post

$.paths['/iam/v2/certificate-authorities/{id}'].get

$.paths['/iam/v2/certificate-authorities/{id}'].put

$.paths['/iam/v2/certificate-authorities/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Certificate Authorities (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-certificate-authorities-iam-v2-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/iam/v2/certificate-authorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate authorities for mTLS
      effect: read
      questions:
      - Which certificate authorities are registered for mTLS in my organization?
      - Can I see every trusted certificate authority I've added?
      instructions:
      - text: List my certificate authorities.
      - text: Show all certificate authorities registered for client certificate auth.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a certificate authority
      effect: write
      questions:
      - How do I add a certificate authority so clients can authenticate with mTLS?
      - Can I require a CRL check when registering a certificate authority?
      instructions:
      - text: Create certificate authority {display_name} with certificate chain {certificate_chain}.
        slots:
          display_name: requestBody.display_name
          certificate_chain: requestBody.certificate_chain
      - text: Register a new certificate authority {display_name} using CRL URL {crl_url}.
        slots:
          display_name: requestBody.display_name
          crl_url: requestBody.crl_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a certificate authority
      effect: read
      questions:
      - What certificate chain and CRL settings does one of my CAs have?
      - When does a registered certificate authority expire?
      instructions:
      - text: Get certificate authority {id}.
        slots:
          id: path.id
      - text: Show details of certificate authority {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a certificate authority
      effect: write
      questions:
      - How do I rotate the certificate chain on an existing certificate authority?
      - Can I change the CRL URL on a CA I already registered?
      instructions:
      - text: Replace the certificate chain on certificate authority {id} with {certificate_chain}.
        slots:
          id: path.id
          certificate_chain: requestBody.certificate_chain
      - text: Set the CRL URL of certificate authority {id} to {crl_url}.
        slots:
          id: path.id
          crl_url: requestBody.crl_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a certificate authority
      effect: destructive
      questions:
      - How do I remove a certificate authority I no longer trust?
      - Can I delete a CA used for mTLS client authentication?
      instructions:
      - text: Delete certificate authority {id}.
        slots:
          id: path.id
      - text: Remove certificate authority {id} from my organization.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'