# 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 Azure Schema Registry $schema Groups API
  version: 1.0.0
extends: openapi/microsoft-azure-schemagroups-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: 6
- target: $.paths['/$schemaGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List schema groups I can access
      effect: read
      questions:
      - Which schema groups in my Schema Registry namespace am I authorized to see?
      - Can I list all the schema groups in an Event Hubs schema registry?
      instructions:
      - text: List the schema groups I have access to.
      - text: Show all schema groups using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$schemaGroups/{groupName}/schemas/{schemaName}:get-id'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a schema's ID by its content
      effect: read
      questions:
      - How do I find the ID of a schema that's already registered by sending its content?
      - Is this exact schema text already registered in my schema group?
      instructions:
      - text: Find the registered ID for schema {schemaName} in group {groupName} by matching its content.
        slots:
          schemaName: path.schemaName
          groupName: path.groupName
      - text: Check whether this content is already registered as {schemaName} in {groupName}.
        slots:
          schemaName: path.schemaName
          groupName: path.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$schemaGroups/{groupName}/schemas/{schemaName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a new schema or schema version
      effect: write
      questions:
      - How do I register a new Avro or JSON schema in a schema group?
      - What happens if I register a schema under a name that already exists in the group?
      instructions:
      - text: Register schema {schemaName} in group {groupName}.
        slots:
          schemaName: path.schemaName
          groupName: path.groupName
      - text: Add a new version of {schemaName} to schema group {groupName}.
        slots:
          schemaName: path.schemaName
          groupName: path.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$schemaGroups/{groupName}/schemas/{schemaName}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all versions of a schema
      effect: read
      questions:
      - How many versions of a schema have been registered?
      - Can I see the version history of one schema in a group?
      instructions:
      - text: List the versions of schema {schemaName} in group {groupName}.
        slots:
          schemaName: path.schemaName
          groupName: path.groupName
      - text: Show the version history for {schemaName}.
        slots:
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$schemaGroups/{groupName}/schemas/{schemaName}/versions/{schemaVersion}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific version of a schema
      effect: read
      questions:
      - How do I fetch an older version of a registered schema?
      - What did version 3 of my schema look like?
      instructions:
      - text: Get version {schemaVersion} of schema {schemaName} in group {groupName}.
        slots:
          schemaVersion: path.schemaVersion
          schemaName: path.schemaName
          groupName: path.groupName
      - text: Show {schemaName} at version {schemaVersion}.
        slots:
          schemaName: path.schemaName
          schemaVersion: path.schemaVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$schemaGroups/$schemas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered schema by its unique ID
      effect: read
      questions:
      - How do I retrieve a schema when all I have is the schema ID from a message?
      - Can a consumer resolve a schema by ID without knowing its group or name?
      instructions:
      - text: Get the schema with ID {id}.
        slots:
          id: path.id
      - text: Resolve schema ID {id} to its definition.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'