# 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 Schema API
  version: 1.0.0
extends: openapi/microsoft-azure-schema-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}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List global schemas in an APIM workspace
      effect: read
      questions:
      - Which shared schemas are registered in my API Management workspace?
      - Can I filter a workspace's schemas by description or type?
      instructions:
      - text: List the global schemas in workspace {workspace} of API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: List workspace 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}/schemas/{schemaId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace global schema
      effect: read
      questions:
      - How do I view the definition of one shared schema in an APIM workspace?
      - What does a registered workspace schema contain?
      instructions:
      - text: Show the details of schema {schema} in workspace {workspace} on service {service}.
        slots:
          schema: path.schemaId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Get the full definition of the named global schema in the workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a workspace global schema
      effect: write
      questions:
      - How do I register a reusable JSON or XML schema in an APIM workspace?
      - Can I overwrite an existing workspace schema with a new definition?
      instructions:
      - text: Create or replace global schema {schema} in APIM workspace {workspace} of service {service}.
        slots:
          schema: path.schemaId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Replace the definition of this existing workspace schema.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace global schema
      effect: destructive
      questions:
      - How do I remove a shared schema from an APIM workspace?
      - Is deleting a workspace schema permanent?
      instructions:
      - text: Delete global schema {schema} from workspace {workspace} on API Management service {service}.
        slots:
          schema: path.schemaId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Remove the named schema from my API Management workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace schema's ETag
      effect: read
      questions:
      - How can I check a workspace schema's current ETag before editing it?
      - Is there a lightweight way to see if a schema has changed?
      instructions:
      - text: Get just the ETag version of schema {schema} in workspace {workspace}, service {service}.
        slots:
          schema: path.schemaId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check the entity state of the schema without downloading it.
      method: generated
      generated: '2026-10-01'