Microsoft Azure Glossary API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Glossary API
schemes:
- https
tags:
- name: Glossary
paths:
  /atlas/v2/glossary:
    get:
      tags:
      - Glossary
      description: Get all glossaries registered with Atlas. Recommend using limit/offset to get pagination result. Recommended using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /catalog/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/catalog/api/atlas/v2/glossary/{glossaryGuid}/categories'.
      operationId: microsoftAzureGlossaryListglossaries
      x-ms-examples:
        Glossary_ListGlossaries:
          $ref: ./examples/Glossary_ListGlossaries.json
      parameters:
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      responses:
        '200':
          description: An array of existing glossaries fitting the search criteria or empty list if nothing matches.
          schema:
            type: array
            items:
              $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary
    post:
      tags:
      - Glossary
      description: Create a glossary.
      operationId: microsoftAzureGlossaryCreateglossary
      x-ms-examples:
        Glossary_CreateGlossary:
          $ref: ./examples/Glossary_CreateGlossary.json
      parameters:
      - in: body
        name: atlasGlossary
        description: 'Glossary definition, terms & categories can be anchored to a glossary.

          Using the anchor attribute when creating the Term/Category.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossary'
      responses:
        '200':
          description: OK. If glossary creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary
  /atlas/v2/glossary/categories:
    post:
      tags:
      - Glossary
      description: Create glossary category in bulk.
      operationId: microsoftAzureGlossaryCreateglossarycategories
      x-ms-examples:
        Glossary_CreateGlossaryCategories:
          $ref: ./examples/Glossary_CreateGlossaryCategories.json
      parameters:
      - in: body
        name: glossaryCategory
        description: An array of glossary category definitions to be created.
        required: true
        schema:
          type: array
          description: An array of glossary category definitions.
          items:
            $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If bulk glossary category creation was successful.
          schema:
            type: array
            description: An array of glossary category created successfully in bulk.
            items:
              $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Categories
  /atlas/v2/glossary/category:
    post:
      tags:
      - Glossary
      description: Create a glossary category.
      operationId: microsoftAzureGlossaryCreateglossarycategory
      x-ms-examples:
        Glossary_CreateGlossaryCategory:
          $ref: ./examples/Glossary_CreateGlossaryCategory.json
      parameters:
      - in: body
        name: glossaryCategory
        description: 'The glossary category definition. A category must be anchored to a Glossary when creating.

          Optionally, terms belonging to the category and the hierarchy can also be defined during creation.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If glossary category creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Category
  /atlas/v2/glossary/category/{categoryGuid}:
    get:
      tags:
      - Glossary
      description: Get specific glossary category by its GUID.
      operationId: microsoftAzureGlossaryGetglossarycategory
      x-ms-examples:
        Glossary_GetGlossaryCategory:
          $ref: ./examples/Glossary_GetGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      responses:
        '200':
          description: OK. If glossary category exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid
    put:
      tags:
      - Glossary
      description: Update the given glossary category by its GUID.
      operationId: microsoftAzureGlossaryUpdateglossarycategory
      x-ms-examples:
        Glossary_UpdateGlossaryCategory:
          $ref: ./examples/Glossary_UpdateGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - in: body
        name: glossaryCategory
        description: The glossary category to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryCategory'
      responses:
        '200':
          description: OK. If glossary category partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Category Categoryguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary category.
      operationId: microsoftAzureGlossaryDeleteglossarycategory
      x-ms-examples:
        Glossary_DeleteGlossaryCategory:
          $ref: ./examples/Glossary_DeleteGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      responses:
        '204':
          description: OK. If glossary category deletion is successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Category Categoryguid
  /atlas/v2/glossary/category/{categoryGuid}/partial:
    put:
      tags:
      - Glossary
      description: Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.
      operationId: microsoftAzureGlossaryPartialupdateglossarycategory
      x-ms-examples:
        Glossary_PartialUpdateGlossaryCategory:
          $ref: ./examples/Glossary_PartialUpdateGlossaryCategory.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values for partial update.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary category partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Category Categoryguid Partial
  /atlas/v2/glossary/category/{categoryGuid}/related:
    get:
      tags:
      - Glossary
      description: Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
      operationId: microsoftAzureGlossaryListrelatedcategories
      x-ms-examples:
        Glossary_ListRelatedCategories:
          $ref: ./examples/Glossary_ListRelatedCategories.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. Gets an array of related categories.
          schema:
            type: object
            description: An array of related categories.
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/AtlasRelatedCategoryHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid Related
  /atlas/v2/glossary/category/{categoryGuid}/terms:
    get:
      tags:
      - Glossary
      description: Get all terms associated with the specific category.
      operationId: microsoftAzureGlossaryListcategoryterms
      x-ms-examples:
        Glossary_ListCategoryTerms:
          $ref: ./examples/Glossary_ListCategoryTerms.json
      parameters:
      - $ref: '#/parameters/categoryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: An array of terms for the given category or an empty list.
          schema:
            type: array
            description: An array of terms for the given category or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Category Categoryguid Terms
  /atlas/v2/glossary/term:
    post:
      tags:
      - Glossary
      description: Create a glossary term.
      operationId: microsoftAzureGlossaryCreateglossaryterm
      x-ms-examples:
        Glossary_CreateGlossaryTerm:
          $ref: ./examples/Glossary_CreateGlossaryTerm.json
        Glossary_CreateGlossaryTermWithTermTemplate:
          $ref: ./examples/Glossary_CreateGlossaryTermWithTermTemplate.json
      parameters:
      - in: body
        name: glossaryTerm
        description: 'The glossary term definition. A term must be anchored to a Glossary at the time of creation.

          Optionally it can be categorized as well.'
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary term creation was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Term
  /atlas/v2/glossary/term/{termGuid}:
    get:
      tags:
      - Glossary
      description: Get a specific glossary term by its GUID.  Recommend using 'excludeRelationshipTypes=AtlasGlossarySemanticAssignment' to get term and using 'GET /catalog/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities' to get term assignment separately.
      operationId: microsoftAzureGlossaryGetglossaryterm
      x-ms-examples:
        Glossary_GetGlossaryTerm:
          $ref: ./examples/Glossary_GetGlossaryTerm.json
        Glossary_GetGlossaryTerm_WithoutAssets:
          $ref: ./examples/Glossary_GetGlossaryTerm_WithoutAssets.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - name: excludeRelationshipTypes
        in: query
        description: An array of relationship types which need to be excluded.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
        x-ms-client-name: excludeRelationshipTypeList
      responses:
        '200':
          description: OK. If glossary term exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Term Termguid
    put:
      tags:
      - Glossary
      description: Update the given glossary term by its GUID.
      operationId: microsoftAzureGlossaryUpdateglossaryterm
      x-ms-examples:
        Glossary_UpdateGlossaryTerm:
          $ref: ./examples/Glossary_UpdateGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: glossaryTerm
        description: The glossary term to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary term update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Term Termguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary term.
      operationId: microsoftAzureGlossaryDeleteglossaryterm
      x-ms-examples:
        Glossary_DeleteGlossaryTerm:
          $ref: ./examples/Glossary_DeleteGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      responses:
        '204':
          description: OK. If glossary term delete was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Term Termguid
  /atlas/v2/glossary/term/{termGuid}/partial:
    put:
      tags:
      - Glossary
      description: Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
      operationId: microsoftAzureGlossaryPartialupdateglossaryterm
      x-ms-examples:
        Glossary_PartialUpdateGlossaryTerm:
          $ref: ./examples/Glossary_PartialUpdateGlossaryTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values to be updated.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Term Termguid Partial
  /atlas/v2/glossary/terms:
    post:
      tags:
      - Glossary
      description: Create glossary terms in bulk.
      operationId: microsoftAzureGlossaryCreateglossaryterms
      x-ms-examples:
        Glossary_CreateGlossaryTerms:
          $ref: ./examples/Glossary_CreateGlossaryTerms.json
      parameters:
      - in: body
        name: glossaryTerm
        description: An array of glossary term definitions to be created in bulk.
        required: true
        schema:
          type: array
          description: An array of glossary term definitions.
          items:
            $ref: '#/definitions/AtlasGlossaryTerm'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If bulk glossary terms creation was successful.
          schema:
            type: array
            description: If bulk glossary terms creation was successful.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Terms
  /atlas/v2/glossary/terms/{termGuid}/assignedEntities:
    get:
      tags:
      - Glossary
      description: Get all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryGetentitiesassignedwithterm
      x-ms-examples:
        Glossary_GetEntitiesAssignedWithTerm:
          $ref: ./examples/Glossary_ListEntitiesAssignedWithTerm.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of related objects (if any) for the given glossary or an empty list.
          schema:
            type: array
            description: An array of related objects (if any) for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedObjectId'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Terms Termguid Assignedentities
    post:
      tags:
      - Glossary
      description: Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.
      operationId: microsoftAzureGlossaryAssigntermtoentities
      x-ms-examples:
        Glossary_AssignTermToEntities:
          $ref: ./examples/Glossary_AssignTermToEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs to which the term has to be associated.
        required: true
        schema:
          type: array
          description: An array of related object IDs to which the term has to be associated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If the term assignment was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Glossary Terms Termguid Assignedentities
    put:
      tags:
      - Glossary
      description: Delete the term assignment for the given list of related objects. This API is not recommended since duplicated with 'DELETE /catalog/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities'. Please use later one instead.
      operationId: microsoftAzureGlossaryRemovetermassignmentfromentities
      x-ms-examples:
        Glossary_RemoveTermAssignmentFromEntities:
          $ref: ./examples/Glossary_RemoveTermAssignmentFromEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs from which the term has to be dissociated.
        required: true
        schema:
          type: array
          description: An array of related object IDs from which the term has to be dissociated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If glossary term dissociation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Terms Termguid Assignedentities
    delete:
      tags:
      - Glossary
      description: Delete the term assignment for the given list of related objects.
      operationId: microsoftAzureGlossaryDeletetermassignmentfromentities
      x-ms-examples:
        Glossary_RemoveTermAssignmentFromEntities:
          $ref: ./examples/Glossary_RemoveTermAssignmentFromEntities.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - in: body
        name: relatedObjectIds
        description: An array of related object IDs from which the term has to be dissociated.
        required: true
        schema:
          type: array
          description: An array of related object IDs from which the term has to be dissociated.
          items:
            $ref: '#/definitions/AtlasRelatedObjectId'
      responses:
        '204':
          description: OK. If glossary term dissociation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Terms Termguid Assignedentities
  /atlas/v2/glossary/terms/{termGuid}/related:
    get:
      tags:
      - Glossary
      description: Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
      operationId: microsoftAzureGlossaryListrelatedterms
      x-ms-examples:
        Glossary_ListRelatedTerms:
          $ref: ./examples/Glossary_ListRelatedTerms.json
      parameters:
      - $ref: '#/parameters/termGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. An array of related glossary terms for the given glossary or an empty list.
          schema:
            type: object
            description: An array of related glossary terms for the given glossary or an empty list.
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Terms Termguid Related
  /atlas/v2/glossary/{glossaryGuid}:
    get:
      tags:
      - Glossary
      description: Get a specific Glossary by its GUID.
      operationId: microsoftAzureGlossaryGetglossary
      x-ms-examples:
        Glossary_GetGlossary:
          $ref: ./examples/Glossary_GetGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      responses:
        '200':
          description: OK. If glossary with given guid exists.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid
    put:
      tags:
      - Glossary
      description: Update the given glossary.
      operationId: microsoftAzureGlossaryUpdateglossary
      x-ms-examples:
        Glossary_UpdateGlossary:
          $ref: ./examples/Glossary_UpdateGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      - in: body
        name: updatedGlossary
        description: The glossary definition to be updated.
        required: true
        schema:
          $ref: '#/definitions/AtlasGlossary'
      responses:
        '200':
          description: OK. If glossary update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Glossaryguid
    delete:
      tags:
      - Glossary
      description: Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.
      operationId: microsoftAzureGlossaryDeleteglossary
      x-ms-examples:
        Glossary_DeleteGlossary:
          $ref: ./examples/Glossary_DeleteGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      responses:
        '204':
          description: OK. If glossary delete was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Glossary Glossaryguid
  /atlas/v2/glossary/{glossaryGuid}/categories:
    get:
      tags:
      - Glossary
      description: Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarycategories
      x-ms-examples:
        Glossary_ListGlossaryCategories:
          $ref: ./examples/Glossary_ListGlossaryCategories.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary categories for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary categories for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryCategory'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Categories
  /atlas/v2/glossary/{glossaryGuid}/categories/headers:
    get:
      tags:
      - Glossary
      description: Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarycategoriesheaders
      x-ms-examples:
        Glossary_ListGlossaryCategoriesHeaders:
          $ref: ./examples/Glossary_ListGlossaryCategoriesHeaders.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary category headers for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary category headers for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedCategoryHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Categories Headers
  /atlas/v2/glossary/{glossaryGuid}/detailed:
    get:
      tags:
      - Glossary
      description: Get a specific glossary with detailed information. This API is not recommend. Recommended fetch terms/categories details separately using 'GET /catalog/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/catalog/api/atlas/v2/glossary/{glossaryGuid}/categories'.
      operationId: microsoftAzureGlossaryGetdetailedglossary
      x-ms-examples:
        Glossary_GetDetailedGlossary:
          $ref: ./examples/Glossary_GetDetailedGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      responses:
        '200':
          description: OK. If glossary exists for given GUID.
          schema:
            $ref: '#/definitions/AtlasGlossaryExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Detailed
  /atlas/v2/glossary/{glossaryGuid}/partial:
    put:
      tags:
      - Glossary
      description: Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
      operationId: microsoftAzureGlossaryPartialupdateglossary
      x-ms-examples:
        Glossary_PartialUpdateGlossary:
          $ref: ./examples/Glossary_PartialUpdateGlossary.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/ignoreTermsAndCategories'
      - in: body
        name: partialUpdates
        description: A map containing keys as attribute names and values as corresponding attribute values.
        required: true
        schema:
          type: object
          description: A map containing keys as attribute names and values as corresponding attribute values.
      responses:
        '200':
          description: OK. If glossary partial update was successful.
          schema:
            $ref: '#/definitions/AtlasGlossary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Glossary Glossaryguid Partial
  /atlas/v2/glossary/{glossaryGuid}/terms:
    get:
      tags:
      - Glossary
      description: Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossaryterms
      x-ms-examples:
        Glossary_ListGlossaryTerms:
          $ref: ./examples/Glossary_ListGlossaryTerms.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/includeTermHierarchy'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary terms for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary terms for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasGlossaryTerm'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossaryguid Terms
  /atlas/v2/glossary/{glossaryGuid}/terms/headers:
    get:
      tags:
      - Glossary
      description: Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
      operationId: microsoftAzureGlossaryListglossarytermheaders
      x-ms-examples:
        Glossary_ListGlossaryTermHeaders:
          $ref: ./examples/Glossary_ListGlossaryTermHeaders.json
      parameters:
      - $ref: '#/parameters/glossaryGuid'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/sort'
      responses:
        '200':
          description: OK. An array of glossary terms for the given glossary or an empty list.
          schema:
            type: array
            description: An array of glossary terms for the given glossary or an empty list.
            items:
              $ref: '#/definitions/AtlasRelatedTermHeader'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Glossary Glossa

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