# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure API Management REST API Schema API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-apischema-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['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List the schemas of an API
      effect: read
      questions:
      - Which schemas are attached to one of my APIs?
      - Can I list the request and response schema documents for an API?
      instructions:
      - text: List the schemas defined for API {apiId} in service {serviceName}.
        slots:
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show the API's schema collection.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one schema from an API
      effect: read
      questions:
      - How do I read a specific schema document that belongs to an API?
      - What content type and definitions does an API schema hold?
      instructions:
      - text: Get schema {schemaId} from API {apiId} in service {serviceName}.
        slots:
          schemaId: path.schemaId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show me the API schema by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or replace a schema on an API
      effect: write
      questions:
      - How do I attach a schema definition to an API?
      - Can I overwrite an API's existing schema document?
      instructions:
      - text: Create schema {schemaId} for API {apiId} in service {serviceName}.
        slots:
          schemaId: path.schemaId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Create or replace the API's schema document.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a schema from an API
      effect: destructive
      questions:
      - Can I remove a schema that an API no longer uses?
      - Will deleting an API schema break operations that reference it?
      instructions:
      - text: Delete schema {schemaId} from API {apiId} in service {serviceName}.
        slots:
          schemaId: path.schemaId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Remove the unused API schema.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check an API schema's ETag
      effect: read
      questions:
      - How do I get the ETag of an API schema?
      - Is there a cheap existence check for a schema on an API?
      instructions:
      - text: Get the entity tag version of schema {schemaId} on API {apiId} in service {serviceName}.
        slots:
          schemaId: path.schemaId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Check the API schema's ETag.
      method: generated
      generated: '2026-10-01'