Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations Certificates API

6 actions 6 updates phrasing extends openapi/apigee-certificates-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates'].get

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates'].post

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].get

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].delete

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].patch

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 Apigee Integrations Certificates API
  version: 1.0.0
extends: openapi/apigee-certificates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration TLS certificates
      effect: read
      questions:
      - Which TLS certificates are available to my integrations?
      - Can I filter the integration certificates by status?
      instructions:
      - text: List certificates for product {productId} in project {projectId}, location {locationId}.
        slots:
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show integration certificates matching {filter} for product {productId} in {projectId}/{locationId}.
        slots:
          filter: query.filter
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a certificate for integrations
      effect: write
      questions:
      - How do I add an SSL certificate for an integration that needs mutual TLS?
      - Can I set validity dates when I upload an integration certificate?
      instructions:
      - text: Create a certificate named {displayName} for product {productId} in project {projectId}, location {locationId}.
        slots:
          displayName: requestBody.displayName
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Upload raw certificate {rawCertificate} for product {productId} in {projectId}/{locationId}.
        slots:
          rawCertificate: requestBody.rawCertificate
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration certificate
      effect: read
      questions:
      - When does one of my integration certificates expire?
      - What status is a specific integration certificate in?
      instructions:
      - text: Get certificate {certificateId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          certificateId: path.certificateId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show validity dates of integration certificate {certificateId} in {projectId}/{locationId}, product {productId}.
        slots:
          certificateId: path.certificateId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration certificate
      effect: destructive
      questions:
      - Can I delete a certificate that an active integration version still references?
      - How do I remove an old TLS certificate from integrations?
      instructions:
      - text: Delete certificate {certificateId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          certificateId: path.certificateId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove integration certificate {certificateId} from {projectId}/{locationId}, product {productId}.
        slots:
          certificateId: path.certificateId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/certificates/{certificateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration certificate
      effect: write
      questions:
      - How do I replace the certificate data on an existing integration certificate?
      - Can I change a certificate's status without recreating it?
      instructions:
      - text: Update certificate {certificateId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          certificateId: path.certificateId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Set status {certificateStatus} on certificate {certificateId} in {projectId}/{locationId}, product {productId}, mask {updateMask}.
        slots:
          certificateStatus: requestBody.certificateStatus
          certificateId: path.certificateId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'