Microsoft Azure $schemaGroups API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Schema Registry $schema Groups API
  version: '2023-07-01'
  description: SchemaRegistryClient is a client for registering and retrieving schemas from the Azure Schema Registry service.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://eventhubs.azure.net/.default
tags:
- name: $schemaGroups
paths:
  /$schemaGroups:
    get:
      operationId: microsoftAzureListschemagroups
      summary: Microsoft Azure Get List Of Schema Groups
      description: Gets the list of schema groups user is authorized to access.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaGroups'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        List Schema Groups:
          $ref: ./examples/ListSchemaGroups.json
      x-ms-pageable:
        nextLinkName: NextLink
      tags:
      - $schemaGroups
  /$schemaGroups/{groupName}/schemas/{schemaName}:get-id:
    post:
      operationId: microsoftAzureGetschemapropertiesbycontent
      summary: Microsoft Azure Get Properties For Existing Schema
      description: Gets the properties referencing an existing schema within the specified schema group, as matched by schema content comparison.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: Name of schema group.
        required: true
        schema:
          type: string
      - name: schemaName
        in: path
        description: Name of schema.
        required: true
        schema:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9][^\\/$:]*$
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            Location:
              description: URL location of schema, identified by schema group, schema name, and version.
              schema:
                type: string
            Schema-Group-Name:
              description: References schema group.
              schema:
                type: string
            Schema-Id:
              description: References specific schema in registry namespace.
              schema:
                type: string
            Schema-Id-Location:
              description: URL location of schema, identified by schema ID.
              schema:
                type: string
            Schema-Name:
              description: References schema name.
              schema:
                type: string
            Schema-Version:
              description: Version of the returned schema.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Get Schema Properties By Content:
          $ref: ./examples/GetSchemaPropertiesByContent.json
      tags:
      - $schemaGroups
      requestBody:
        content:
          application/json; serialization=Avro:
            schema:
              type: string
              format: binary
          application/json; serialization=Json:
            schema:
              type: string
              format: binary
          text/plain; charset=utf-8:
            schema:
              type: string
              format: binary
          text/vnd.ms.protobuf:
            schema:
              type: string
              format: binary
        description: String representation (UTF-8) of the schema.
        required: true
  /$schemaGroups/{groupName}/schemas/{schemaName}:
    put:
      operationId: microsoftAzureRegisterschema
      summary: Microsoft Azure Register New Schema
      description: Register new schema. If schema of specified name does not exist in specified group, schema is created at version 1. If schema of specified name exists already in specified group, schema is created at latest version + 1.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: Name of schema group.
        required: true
        schema:
          type: string
      - name: schemaName
        in: path
        description: Name of schema.
        required: true
        schema:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9][^\\/$:]*$
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            Location:
              description: URL location of schema, identified by schema group, schema name, and version.
              schema:
                type: string
            Schema-Group-Name:
              description: References schema group.
              schema:
                type: string
            Schema-Id:
              description: References specific schema in registry namespace.
              schema:
                type: string
            Schema-Id-Location:
              description: URL location of schema, identified by schema ID.
              schema:
                type: string
            Schema-Name:
              description: References schema name.
              schema:
                type: string
            Schema-Version:
              description: Version of the returned schema.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Register Schema:
          $ref: ./examples/RegisterSchema.json
      tags:
      - $schemaGroups
      requestBody:
        content:
          application/json; serialization=Avro:
            schema:
              type: string
              format: binary
          application/json; serialization=Json:
            schema:
              type: string
              format: binary
          text/plain; charset=utf-8:
            schema:
              type: string
              format: binary
          text/vnd.ms.protobuf:
            schema:
              type: string
              format: binary
        description: String representation (UTF-8) of the schema.
        required: true
  /$schemaGroups/{groupName}/schemas/{schemaName}/versions:
    get:
      operationId: microsoftAzureListschemaversions
      summary: Microsoft Azure List Schema Versions
      description: Gets the list of all versions of one schema.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: Name of schema group.
        required: true
        schema:
          type: string
      - name: schemaName
        in: path
        description: Name of schema.
        required: true
        schema:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9][^\\/$:]*$
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaVersions'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        List Schema Versions:
          $ref: ./examples/ListSchemaVersions.json
      x-ms-pageable:
        nextLinkName: NextLink
      tags:
      - $schemaGroups
  /$schemaGroups/{groupName}/schemas/{schemaName}/versions/{schemaVersion}:
    get:
      operationId: microsoftAzureGetschemabyversion
      summary: Microsoft Azure Get Specific Schema Versions
      description: Gets one specific version of one schema.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: Name of schema group.
        required: true
        schema:
          type: string
      - name: schemaName
        in: path
        description: Name of schema.
        required: true
        schema:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9][^\\/$:]*$
      - name: schemaVersion
        in: path
        description: Version number of specific schema.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Content-Type:
              description: The content type for given schema.
              x-ms-enum:
                name: SchemaContentTypeValues
                modelAsString: false
                values:
                - name: avro
                  value: application/json; serialization=Avro
                - name: json
                  value: application/json; serialization=Json
                - name: custom
                  value: text/plain; charset=utf-8
                - name: protobuf
                  value: text/vnd.ms.protobuf
              schema:
                type: string
                enum:
                - application/json; serialization=Avro
                - application/json; serialization=Json
                - text/plain; charset=utf-8
                - text/vnd.ms.protobuf
            Location:
              description: URL location of schema, identified by schema group, schema name, and version.
              schema:
                type: string
            Schema-Group-Name:
              description: References schema group.
              schema:
                type: string
            Schema-Id:
              description: References specific schema in registry namespace.
              schema:
                type: string
            Schema-Id-Location:
              description: URL location of schema, identified by schema ID.
              schema:
                type: string
            Schema-Name:
              description: References schema name.
              schema:
                type: string
            Schema-Version:
              description: Version of the returned schema.
              schema:
                type: integer
                format: int32
          content:
            application/json; serialization=Avro:
              schema:
                type: string
                format: binary
            application/json; serialization=Json:
              schema:
                type: string
                format: binary
            text/plain; charset=utf-8:
              schema:
                type: string
                format: binary
            text/vnd.ms.protobuf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json; serialization=Avro:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json; serialization=Json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            text/plain; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            text/vnd.ms.protobuf:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Get Schema by Version:
          $ref: ./examples/GetSchemaByVersion.json
      tags:
      - $schemaGroups
  /$schemaGroups/$schemas/{id}:
    get:
      operationId: microsoftAzureGetschemabyid
      summary: Microsoft Azure Get A Registered Schema By Its Unique Id Reference
      description: Gets a registered schema by its unique ID. Azure Schema Registry guarantees that ID is unique within a namespace. Operation response type is based on serialization of schema requested.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: id
        in: path
        description: Schema ID that uniquely identifies a schema in the registry namespace.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Content-Type:
              description: The content type for given schema.
              x-ms-enum:
                name: SchemaContentTypeValues
                modelAsString: false
                values:
                - name: avro
                  value: application/json; serialization=Avro
                - name: json
                  value: application/json; serialization=Json
                - name: custom
                  value: text/plain; charset=utf-8
                - name: protobuf
                  value: text/vnd.ms.protobuf
              schema:
                type: string
                enum:
                - application/json; serialization=Avro
                - application/json; serialization=Json
                - text/plain; charset=utf-8
                - text/vnd.ms.protobuf
            Location:
              description: URL location of schema, identified by schema group, schema name, and version.
              schema:
                type: string
            Schema-Group-Name:
              description: References schema group.
              schema:
                type: string
            Schema-Id:
              description: References specific schema in registry namespace.
              schema:
                type: string
            Schema-Id-Location:
              description: URL location of schema, identified by schema ID.
              schema:
                type: string
            Schema-Name:
              description: References schema name.
              schema:
                type: string
            Schema-Version:
              description: Version of the returned schema.
              schema:
                type: integer
                format: int32
          content:
            application/json; serialization=Avro:
              schema:
                type: string
                format: binary
            application/json; serialization=Json:
              schema:
                type: string
                format: binary
            text/plain; charset=utf-8:
              schema:
                type: string
                format: binary
            text/vnd.ms.protobuf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json; serialization=Avro:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json; serialization=Json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            text/plain; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            text/vnd.ms.protobuf:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Get Schema by ID:
          $ref: ./examples/GetSchemaById.json
      tags:
      - $schemaGroups
components:
  schemas:
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          x-ms-identifiers: []
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    SchemaGroups:
      type: object
      description: The list of schema group names with server paging support.
      properties:
        Value:
          type: array
          description: The collection of pageable schema group name items.
          items:
            type: string
        NextLink:
          type: string
          description: The link to the next page of items
      required:
      - Value
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    SchemaVersions:
      type: object
      description: The list of schema versions with server paging support.
      properties:
        Value:
          type: array
          description: The collection of schema version pageable items.
          items:
            type: integer
            format: int32
        NextLink:
          type: string
          description: The link to the next page of items
      required:
      - Value
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://eventhubs.azure.net/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
  hostTemplate: https://{fullyQualifiedNamespace}
  useSchemePrefix: false
  parameters:
  - name: fullyQualifiedNamespace
    in: path
    description: The Schema Registry service endpoint, for example 'my-namespace.servicebus.windows.net'.
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true