# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure ApiManagementClient API Schema API
  version: 1.0.0
extends: openapi/microsoft-azure-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}/workspaces/{workspaceId}/apis/{apiId}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List the schemas of an API in a workspace
      effect: read
      questions:
      - Which schemas are attached to an API in my API Management workspace?
      - Can I filter an API's schemas by content type?
      instructions:
      - text: List the schemas defined on API {api} in workspace {workspace}, service {service}.
        slots:
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show workspace API schemas matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one schema of a workspace API
      effect: read
      questions:
      - What does a specific schema on my workspace API contain?
      - Can I read a single API schema definition by its ID?
      instructions:
      - text: Get schema {schema} from API {api} in workspace {workspace} on service {service}.
        slots:
          schema: path.schemaId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show the document of workspace API schema {schema}.
        slots:
          schema: path.schemaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a schema on a workspace API
      effect: write
      questions:
      - How do I upload a JSON schema to an API in an API Management workspace?
      - Can I replace an existing schema definition on a workspace API?
      instructions:
      - text: Add schema {schema} to API {api} in workspace {workspace} on service {service}.
        slots:
          schema: path.schemaId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Replace the existing definition of workspace API schema {schema}.
        slots:
          schema: path.schemaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a schema from a workspace API
      effect: destructive
      questions:
      - How do I remove a schema that operations still reference?
      - Can I force-delete an API schema in a workspace?
      instructions:
      - text: Delete schema {schema} from API {api} in workspace {workspace} on service {service}.
        slots:
          schema: path.schemaId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Force delete workspace API schema {schema} when {force} is true.
        slots:
          schema: path.schemaId
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check the ETag version of a workspace API schema
      effect: read
      questions:
      - Has a workspace API schema changed since I last read it?
      - Can I get just a schema's ETag without downloading the body?
      instructions:
      - text: Get the current ETag of schema {schema} on API {api} in workspace {workspace}, service {service}.
        slots:
          schema: path.schemaId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check whether workspace API schema {schema} exists using a HEAD request.
        slots:
          schema: path.schemaId
      method: generated
      generated: '2026-10-01'