Microsoft Azure Types API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Types API
schemes:
- https
tags:
- name: Types
paths:
  /types/termtemplatedef/guid/{guid}:
    get:
      operationId: microsoftAzureTypeGettermtemplatedefbyguid
      description: Get the term template definition for the given GUID.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: guid
        in: path
        description: The globally unique identifier of the term template.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TermTemplateDef'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/AtlasErrorResponse'
      x-ms-examples:
        Type_GetTermTemplateDefByGuid:
          $ref: ./examples/Type_GetTermTemplateDefByGuid.json
      summary: Microsoft Azure Get Types Termtemplatedef Guid Guid
      tags:
      - Types
  /types/termtemplatedef/name/{name}:
    get:
      operationId: microsoftAzureTypeGettermtemplatedefbyname
      description: Get the term template definition by its name (unique).
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The unique name of the term template.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TermTemplateDef'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/AtlasErrorResponse'
      x-ms-examples:
        Type_GetTermTemplateDefByName:
          $ref: ./examples/Type_GetTermTemplateDefByName.json
      summary: Microsoft Azure Get Types Termtemplatedef Name Name
      tags:
      - Types
  /atlas/v2/types/businessmetadatadef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the businessMetadata definition for the given guid
      operationId: microsoftAzureTypesGetbusinessmetadatadefbyguid
      x-ms-examples:
        Types_GetBusinessMetadataDefByGuid:
          $ref: ./examples/Types_GetBusinessMetadataDefByGuid.json
      produces:
      - application/json
      parameters:
      - name: guid
        in: path
        type: string
        description: businessMetadata guid
        required: true
      responses:
        '200':
          schema:
            $ref: '#/definitions/AtlasBusinessMetadataDef'
            description: On successful lookup of the the businessMetadata definition by it's guid
          description: On successful lookup of the the businessMetadata definition by it's guid
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Businessmetadatadef Guid Guid
  /atlas/v2/types/businessmetadatadef/name/{name}:
    get:
      tags:
      - Types
      description: Get the businessMetadata definition by it's name (unique)
      operationId: microsoftAzureTypesGetbusinessmetadatadefbyname
      x-ms-examples:
        Types_GetBusinessMetadataDefByName:
          $ref: ./examples/Types_GetBusinessMetadataDefByName.json
      produces:
      - application/json
      parameters:
      - name: name
        in: path
        type: string
        description: businessMetadata name
        required: true
      responses:
        '200':
          schema:
            $ref: '#/definitions/AtlasBusinessMetadataDef'
            description: On successful lookup of the the businessMetadata definition by it's name
          description: On successful lookup of the the businessMetadata definition by it's name
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Businessmetadatadef Name Name
  /atlas/v2/types/classificationdef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the classification definition for the given GUID.
      operationId: microsoftAzureTypesGetclassificationdefbyguid
      x-ms-examples:
        Types_GetClassificationDefByGuid:
          $ref: ./examples/Types_GetClassificationDefByGuid.json
      parameters:
      - $ref: '#/parameters/classificationDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the classification definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasClassificationDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Classificationdef Guid Guid
  /atlas/v2/types/classificationdef/name/{name}:
    get:
      tags:
      - Types
      description: Get the classification definition by its name (unique).
      operationId: microsoftAzureTypesGetclassificationdefbyname
      x-ms-examples:
        Types_GetClassificationDefByName:
          $ref: ./examples/Types_GetClassificationDefByName.json
      parameters:
      - $ref: '#/parameters/classificationDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the classification definition by its name.
          schema:
            $ref: '#/definitions/AtlasClassificationDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Classificationdef Name Name
  /atlas/v2/types/entitydef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the Entity definition for the given GUID.
      operationId: microsoftAzureTypesGetentitydefinitionbyguid
      x-ms-examples:
        Types_GetEntityDefinitionByGuid:
          $ref: ./examples/Types_GetEntityDefinitionByGuid.json
      parameters:
      - $ref: '#/parameters/entityDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the entity definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasEntityDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Entitydef Guid Guid
  /atlas/v2/types/entitydef/name/{name}:
    get:
      tags:
      - Types
      description: Get the entity definition by its name (unique).
      operationId: microsoftAzureTypesGetentitydefinitionbyname
      x-ms-examples:
        Types_GetEntityDefinitionByName:
          $ref: ./examples/Types_GetEntityDefinitionByName.json
      parameters:
      - $ref: '#/parameters/entityDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the entity definition by its name.
          schema:
            $ref: '#/definitions/AtlasEntityDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Entitydef Name Name
  /atlas/v2/types/enumdef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the enum definition for the given GUID.
      operationId: microsoftAzureTypesGetenumdefbyguid
      x-ms-examples:
        Types_GetEnumDefByGuid:
          $ref: ./examples/Types_GetEnumDefByGuid.json
      parameters:
      - $ref: '#/parameters/enumDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the enum definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasEnumDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Enumdef Guid Guid
  /atlas/v2/types/enumdef/name/{name}:
    get:
      tags:
      - Types
      description: Get the enum definition by its name (unique).
      operationId: microsoftAzureTypesGetenumdefbyname
      x-ms-examples:
        Types_GetEnumDefByName:
          $ref: ./examples/Types_GetEnumDefByName.json
      parameters:
      - $ref: '#/parameters/enumDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the enum definition by its name.
          schema:
            $ref: '#/definitions/AtlasEnumDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Enumdef Name Name
  /atlas/v2/types/relationshipdef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the relationship definition for the given GUID.
      operationId: microsoftAzureTypesGetrelationshipdefbyguid
      x-ms-examples:
        Types_GetRelationshipDefByGuid:
          $ref: ./examples/Types_GetRelationshipDefByGuid.json
      parameters:
      - $ref: '#/parameters/relationshipDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the relationship definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasRelationshipDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Relationshipdef Guid Guid
  /atlas/v2/types/relationshipdef/name/{name}:
    get:
      tags:
      - Types
      description: Get the relationship definition by its name (unique).
      operationId: microsoftAzureTypesGetrelationshipdefbyname
      x-ms-examples:
        Types_GetRelationshipDefByName:
          $ref: ./examples/Types_GetRelationshipDefByName.json
      parameters:
      - $ref: '#/parameters/relationshipDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the relationship definition by its name.
          schema:
            $ref: '#/definitions/AtlasRelationshipDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Relationshipdef Name Name
  /atlas/v2/types/structdef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the struct definition for the given GUID.
      operationId: microsoftAzureTypesGetstructdefbyguid
      x-ms-examples:
        Types_GetStructDefByGuid:
          $ref: ./examples/Types_GetStructDefByGuid.json
      parameters:
      - $ref: '#/parameters/structDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the struct definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasStructDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Structdef Guid Guid
  /atlas/v2/types/structdef/name/{name}:
    get:
      tags:
      - Types
      description: Get the struct definition by its name (unique).
      operationId: microsoftAzureTypesGetstructdefbyname
      x-ms-examples:
        Types_GetStructDefByName:
          $ref: ./examples/Types_GetStructDefByName.json
      parameters:
      - $ref: '#/parameters/structDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the struct definition by its name.
          schema:
            $ref: '#/definitions/AtlasStructDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Structdef Name Name
  /atlas/v2/types/typedef/guid/{guid}:
    get:
      tags:
      - Types
      description: Get the type definition for the given GUID.
      operationId: microsoftAzureTypesGettypedefinitionbyguid
      x-ms-examples:
        Types_GetTypeDefinitionByGuid:
          $ref: ./examples/Types_GetTypeDefinitionByGuid.json
      parameters:
      - $ref: '#/parameters/typeDefGuid'
      responses:
        '200':
          description: OK. On successful lookup of the the type definition by its GUID.
          schema:
            $ref: '#/definitions/AtlasTypeDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedef Guid Guid
  /atlas/v2/types/typedef/name/{name}:
    get:
      tags:
      - Types
      description: Get the type definition by its name (unique).
      operationId: microsoftAzureTypesGettypedefinitionbyname
      x-ms-examples:
        Types_GetTypeDefinitionByName:
          $ref: ./examples/Types_GetTypeDefinitionByName.json
      parameters:
      - $ref: '#/parameters/typeDefName'
      responses:
        '200':
          description: OK. On successful lookup of the the type definition by its name.
          schema:
            $ref: '#/definitions/AtlasTypeDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedef Name Name
    delete:
      tags:
      - Types
      description: Delete API for type identified by its name.
      operationId: microsoftAzureTypesDeletetypebyname
      x-ms-examples:
        Types_DeleteTypeByName:
          $ref: ./examples/Types_DeleteTypeByName.json
      parameters:
      - $ref: '#/parameters/typeDefName'
      responses:
        '204':
          description: On successful deletion of the requested type definitions
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Types Typedef Name Name
  /atlas/v2/types/typedefs:
    get:
      tags:
      - Types
      description: Get all type definitions in Atlas in bulk.
      operationId: microsoftAzureTypesGetalltypedefinitions
      x-ms-examples:
        Types_GetAllTypeDefinitions:
          $ref: ./examples/Types_GetAllTypeDefinitions.json
        Types_GetAllTermTemplateDef:
          $ref: ./examples/Types_GetAllTermTemplateDef.json
        Types_GetAllEnumDef:
          $ref: ./examples/Types_GetAllEnumDef.json
      parameters:
      - $ref: '#/parameters/includeTermTemplate'
      - $ref: '#/parameters/type'
      responses:
        '200':
          description: OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedefs
    post:
      tags:
      - Types
      description: Create all atlas type definitions in bulk, only new definitions will be created.<br>Any changes to the existing definitions will be discarded.
      operationId: microsoftAzureTypesCreatetypedefinitions
      x-ms-examples:
        Types_CreateTypeDefinitions:
          $ref: ./examples/Types_CreateTypeDefinitions.json
        Types_CreateBusinessMetadata:
          $ref: ./examples/Types_CreateBusinessMetadata.json
      parameters:
      - in: body
        name: typesDef
        description: A composite wrapper object with corresponding lists of the type definition.
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '200':
          description: OK. On successful update of requested type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Types Typedefs
    put:
      tags:
      - Types
      description: Update all types in bulk, changes detected in the type definitions would be persisted.
      operationId: microsoftAzureTypesUpdateatlastypedefinitions
      x-ms-examples:
        Types_UpdateAtlasTypeDefinitions:
          $ref: ./examples/Types_UpdateAtlasTypeDefinitions.json
      parameters:
      - in: body
        name: typesDef
        description: A composite object that captures all type definition changes.
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '200':
          description: OK. On successful update of requested type definitions.
          schema:
            $ref: '#/definitions/AtlasTypesDef'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Types Typedefs
    delete:
      tags:
      - Types
      description: Delete API for all types in bulk.
      operationId: microsoftAzureTypesDeletetypedefinitions
      x-ms-examples:
        Types_DeleteTypeDefinitions:
          $ref: ./examples/Types_DeleteTypeDefinitions.json
      parameters:
      - in: body
        name: typesDef
        description: A composite object that captures all types to be deleted
        required: true
        schema:
          $ref: '#/definitions/AtlasTypesDef'
      responses:
        '204':
          description: OK. On successful deletion of the requested type definitions.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Types Typedefs
  /atlas/v2/types/typedefs/headers:
    get:
      tags:
      - Types
      description: List all type definitions returned as a list of minimal information header.
      operationId: microsoftAzureTypesListtypedefinitionheaders
      x-ms-examples:
        Types_ListTypeDefinitionHeaders:
          $ref: ./examples/Types_ListTypeDefinitionHeaders.json
      parameters:
      - $ref: '#/parameters/includeTermTemplate'
      - $ref: '#/parameters/type'
      responses:
        '200':
          description: 'An array of AtlasTypeDefHeader matching the search criteria

            or an empty list if no match.'
          schema:
            type: array
            description: 'An array of AtlasTypeDefHeader matching the search criteria

              or an empty list if no match.'
            items:
              $ref: '#/definitions/AtlasTypeDefHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Types Typedefs Headers
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  NumberFormat_2:
    type: object
    title: NumberFormat
    properties:
      availableLocales:
        type: array
        description: The number format.
        items:
          type: string
      currency:
        type: string
        description: The currency.
      currencyInstance:
        $ref: '#/definitions/NumberFormat_2'
      groupingUsed:
        type: boolean
        description: Determines if grouping is used.
      instance:
        $ref: '#/definitions/NumberFormat_2'
      integerInstance:
        $ref: '#/definitions/NumberFormat_2'
      maximumFractionDigits:
        type: integer
        format: int32
        description: The maximum of fraction digits.
      maximumIntegerDigits:
        type: integer
        format: int32
        description: The maximum of integer digits.
      minimumFractionDigits:
        type: integer
        format: int32
        description: The minimum of fraction digits.
      minimumIntegerDigits:
        type: integer
        format: int32
        description: The minimum of integer digits.
      numberInstance:
        $ref: '#/definitions/NumberFormat_2'
      parseIntegerOnly:
        type: boolean
        description: Determines if only integer is parsed.
      percentInstance:
        $ref: '#/definitions/NumberFormat_2'
      roundingMode:
        $ref: '#/definitions/RoundingMode_2'
    description: The number format.
  AtlasRelationshipDef:
    type: object
    title: AtlasRelationshipDef
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    - properties:
        endDef1:
          $ref: '#/definitions/AtlasRelationshipEndDef'
        endDef2:
          $ref: '#/definitions/AtlasRelationshipEndDef'
        relationshipCategory:
          $ref: '#/definitions/RelationshipCategory'
        relationshipLabel:
          type: string
          description: The label of the relationship.
    description: "AtlasRelationshipDef is a TypeDef that defines a relationship.\n<p>\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n<p>\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n<p>\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br>\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br>\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n<p>\nRelationshipDefs introduce new attributes to the entity instances. For example\n<p>\nEntityDef A might have attributes attr1,attr2,attr3 <br>\nEntityDef B might have attributes attr4,attr5,attr6 <br>\nRelationshipDef AtoB might define 2 ends <br>\n\n<pre>\n   end1:  type A, name attr7\n   end2:  type B, name attr8  </pre>\n\n<p>\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br>\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n<p>\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances"
  AtlasConstraintDef_2:
    type: object
    properties:
      params:
        type: object
        description: The parameters of the constraint definition.
        additionalProperties: {}
      type:
        type: string
        description: The type of the constraint.
    title: AtlasConstraintDef
    description: class that captures details of a constraint.
  AtlasTypeDefHeader:
    type: object
    properties:
      category:
        $ref: '#/definitions/TypeCategory_2'
      guid:
        type: string
        description: The GUID of the type definition.
      name:
        type: string
        description: The name of the type definition.
    title: AtlasTypeDefHeader
    description: The basic information of the type definition.
  TermTemplateDef:
    type: object
    description: Term template definition for glossary term.
    properties:
      category:
        $ref: '#/definitions/TypeCategory'
        description: The enum of type category.
      createTime:
        type: integer
        format: int64
        description: The created time of the record.
      createdBy:
        type: string
        description: The user who created the record.
      dateFormatter:
        $ref: '#/definitions/DateFormat'
        description: The date format.
      description:
        type: string
        description: The description of the type definition.
      guid:
        type: string
        description: The GUID of the type definition.
      name:
        type: string
        description: The name of the type definition.
      options:
        type: object
        description: The options for the type definition.
        additionalProperties:
          type: string
      serviceType:
        type: string
        description: The service type.
      typeVersion:
        type: string
        description: The version of the type.
      updateTime:
        type: integer
        format: int64
        description: The update time of the record.
      updatedBy:
        type: string
        description: The user who updated the record.
      version:
        type: integer
        format: int64
        description: The version of the record.
      lastModifiedTS:
        type: string
        description: ETag for concurrency control.
      attributeDefs:
        type: array
        description: An array of attribute definitions.
        items:
          $ref: '#/definitions/AtlasAttributeDef'
        x-ms-identifiers: []
  AtlasTypesDef:
    type: object
    properties:
      businessMetadataDefs:
        readOnly: false
        description: businessMetadataDefs
        type: array
        items:
          $ref: '#/definitions/AtlasBusinessMetadataDef'
      classificationDefs:
        type: array
        description: An array of classification definitions.
        items:
          $ref: '#/definitions/AtlasClassificationDef'
      entityDefs:
        type: array
        description: An array of entity definitions.
        items:
          $ref: '#/definitions/AtlasEntityDef'
      enumDefs:
        type: array
        description: An array of enum definitions.
        items:
          $ref: '#/definitions/AtlasEnumDef'
      relationshipDefs:
        type: array
        description: An array of relationship definitions.
        items:
          $ref: '#/definitions/AtlasRelationshipDef'
      structDefs:
        type: array
        description: An array of struct definitions.
        items:
          $ref: '#/definitions/AtlasStructDef'
      termTemplateDefs:
        type: array
        description: An array of term template definitions.
        items:
          $ref: '#/definitions/TermTemplateDef_2'
    title: AtlasTypesDef
    description: The definitions of types.
  AtlasEnumElementDef:
    type: object
    properties:
      description:
        type: string
        description: The description of the enum element definition.
      ordinal:
        type: number
        description: The ordinal of the enum element definition.
      value:
        type: string
        description: The value of the enum element definition.
    title: AtlasEnumElementDef
    description: class that captures details of an enum-element.
  TimeZone_2:
    type: object
    properties:
      dstSavings:
        type: integer
        format: int32
        description: The value of the daylight saving time.
      id:
        type: string
        description: The ID of the timezone.
      availableIds:
        type: array
        description: An array of available IDs.
        items:
          type: string
      default:
        $ref: '#/definitions/TimeZone_2'
      displayName:
        type: string
        description: The display name of the timezone.
      rawOffset:
        type: integer
        format: int32
        description: The raw offset of the timezone.
    title: TimeZone
    description: The timezone information.
  AtlasErrorResponse:
    type: object
    description: An error response from the service
    properties:
      requestId:
        $ref: '#/definitions/Azure.Core.uuid'
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  CardinalityValue:
    type: string
    description: Cardinality
    enum:
    - SINGLE
    - LIST
    - SET
    x-ms-enum:
      name: CardinalityValue
      modelAsString: true
      values:
      - name: Single
        value: SINGLE
        description: single
      - name: List
        value: LIST
        description: list
      - name: Set
        value: SET
        description: set
  RelationshipCategory:
    type: string
    title: RelationshipCategory
    description: 'The Relationship category determines the style of relationship around containment and lifecycle.

      UML terminology is used for the values.

      <p>

      ASSOCIATION is a relationship with no containment. <br>

      COMPOSITION and AGGREGATION are containment relationships.

      <p>

      The difference being in the lifecycles of the container and its children. In the COMPOSITION case,

      the children cannot exist without the container. For AGGREGATION, the life cycles

      of the container and children are totally independent.'
    enum:
    - ASSOCIATION
    - AGGREGATION
    - COMPOSITION
    x-ms-enum:
      name: RelationshipCategory
      modelAsString: true
  AtlasEnumDef:
    type: object
    title: AtlasEnumDef
    allOf:
    - $ref: '#/definitions/AtlasBaseTypeDef'
    - properties:
        defaultValue:
          type: string
          description: The default value.
        elementDefs:
          type: array
          description: An array of enum element definitions.
          items:
            $ref: '#/definitions/AtlasEnumElementDef'
    description: class that captures details of an enum-type.
  Cardinality:
    type: string
    title: Cardinality
    description: single-valued attribute or multi-valued attribute.
    enum:
    - SINGLE
    - LIST
    - SET
    x-ms-enum:
      name: Cardinality
      modelAsString: true
  RoundingMode_2:
    type: string
    title: RoundingMode
    description: The enum of rounding mode.
    enum:
    - UP
    - DOWN
    - CEILING
    - FLOOR
    - HALF_UP
    - HALF_DOWN
    - HALF_EVEN
    - UNNECESSARY
    x-ms-enum:
      name: RoundingMode
      modelAsString: true
  DateFormat_2:
    type: object
    title: DateFormat
    properties:
      availableLocales:
        type: array
        description: An array of available locales.
        items:
          type: string
      calendar:
        type: number
      dateInstance:
        $ref: '#/definitions/DateFormat_2'
      dateTimeInstance:
        $ref: '#/definitions/DateFormat_2'
      instance:
        $ref: '#/definitions/DateFormat_2'
      lenient:
        type: boolean
        description: Determines the leniency of the date format.
      numberFormat:
        $ref: '#/definitions/NumberFormat_2'
      timeInstance:
        $ref: '#/definitions/DateFormat_2'
      timeZone:
        $ref: '#/definitions/TimeZone_2'
    description: The date format.
  DateFormat:
    type: object
    description: The date format.
    properties:
      availableLocales:
        type: array
        description: An array of available locales.
        items:
          type: string
      calendar:
        type: number
        format: float
        description: Calendar
      dateInstance:
        $ref: '#/definitions/DateFormat'
        description: The date format.
      dateTimeInstance:
        $ref: '#/definitions/DateFormat'
        description: The date format.
      instance:
        $ref: '#/definitions/DateFormat'
        description: The date format.
      lenient:
        type: boolean
        description: Determines the leniency of the date format.
      numberFormat:
        $ref: '#/definitions/NumberFormat'
        description: The number format.
      timeInstance:
        $ref: '#/definitions/DateFormat'
        description: The date format.
      timeZone:
        $ref: '#/definitions/TimeZone'
        description: The timezone information.
  AtlasTypeDef:
    type: object
    allOf:
    - $ref: '#/definitions/AtlasBaseTypeDef'
    - $ref: '#/definitions/AtlasExtraTypeDef'
    title: AtlasTypeDef
    description: The definitions of type.
  AtlasBusinessMetadataDef:
    type: object
    title: AtlasBusinessMetadataDef
    allOf:
    - $ref: '#/definitions/AtlasStructDef'
    - {}
    example:
      attributeDefs:
      - cardinality: SINGLE
        constraints:
        - params:
            property1: {}
            propert

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-types-api-openapi.yml