swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Relationship API
schemes:
- https
tags:
- name: Relationship
paths:
  /atlas/v2/relationship:
    post:
      tags:
      - Relationship
      description: Create a new relationship between entities.
      operationId: microsoftAzureRelationshipCreate
      x-ms-examples:
        Relationship_Create:
          $ref: ./examples/Relationship_Create.json
      parameters:
      - in: body
        name: relationship
        description: The AtlasRelationship object containing the information for the relationship to be created.
        required: true
        schema:
          $ref: '#/definitions/AtlasRelationship'
      responses:
        '200':
          description: OK. The relationship is created.
          schema:
            $ref: '#/definitions/AtlasRelationship'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Relationship
    put:
      tags:
      - Relationship
      description: Update an existing relationship between entities.
      operationId: microsoftAzureRelationshipUpdate
      x-ms-examples:
        Relationship_Update:
          $ref: ./examples/Relationship_Update.json
      parameters:
      - in: body
        name: relationship
        description: The AtlasRelationship object containing the information for the relationship to be created.
        required: true
        schema:
          $ref: '#/definitions/AtlasRelationship'
      responses:
        '200':
          description: OK. The relationship is updated.
          schema:
            $ref: '#/definitions/AtlasRelationship'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Relationship
  /atlas/v2/relationship/guid/{guid}:
    get:
      tags:
      - Relationship
      description: Get relationship information between entities by its GUID.
      operationId: microsoftAzureRelationshipGet
      x-ms-examples:
        Relationship_Get:
          $ref: ./examples/Relationship_Get.json
      parameters:
      - $ref: '#/parameters/relationshipGuid'
      - $ref: '#/parameters/extendedInfo'
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/AtlasRelationshipWithExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Relationship Guid Guid
    delete:
      tags:
      - Relationship
      description: Delete a relationship between entities by its GUID.
      operationId: microsoftAzureRelationshipDelete
      x-ms-examples:
        Relationship_Delete:
          $ref: ./examples/Relationship_Delete.json
      parameters:
      - $ref: '#/parameters/relationshipGuid'
      responses:
        '204':
          description: OK. The relationship is deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Relationship Guid Guid
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  AtlasRelationship:
    type: object
    title: AtlasRelationship
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        createTime:
          type: integer
          format: int64
          description: The created time of the record.
        createdBy:
          type: string
          description: The user who created the record.
        end1:
          $ref: '#/definitions/AtlasObjectId'
        end2:
          $ref: '#/definitions/AtlasObjectId'
        guid:
          type: string
          description: The GUID of the relationship.
        homeId:
          type: string
          description: The home ID of the relationship.
        label:
          type: string
          description: The label of the relationship.
        provenanceType:
          readOnly: false
          description: Used to record the provenance of an instance of an entity or relationship
          type: number
        status:
          $ref: '#/definitions/Status_AtlasRelationship'
        updateTime:
          type: integer
          format: int64
          description: The update time of the record.
        updatedBy:
          type: string
          description: The user who updated the record.
        version:
          type: number
          description: The version of the relationship.
    description: Atlas relationship instance.
  AtlasObjectId:
    type: object
    properties:
      guid:
        type: string
        description: The GUID of the object.
      typeName:
        type: string
        description: The name of the type.
      uniqueAttributes:
        type: object
        description: The unique attributes of the object.
        additionalProperties: {}
    title: AtlasObjectId
    description: Reference to an object-instance of an Atlas type - like entity.
  TimeBoundary:
    type: object
    properties:
      endTime:
        type: string
        description: The end of the time boundary.
      startTime:
        type: string
        description: The start of the time boundary.
      timeZone:
        type: string
        description: The timezone of the time boundary.
    title: TimeBoundary
    description: Captures time-boundary details
  ErrorResponse:
    description: An error response from the service
    type: object
    properties:
      requestId:
        type: string
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  AtlasTermAssignmentHeader:
    type: object
    properties:
      confidence:
        type: integer
        format: int32
        description: The confidence of the term assignment.
      createdBy:
        type: string
        description: The user who created the record.
      description:
        type: string
        description: The description of the term assignment.
      displayText:
        type: string
        description: The display text.
      expression:
        type: string
        description: The expression of the term assignment.
      relationGuid:
        type: string
        description: The GUID of the relationship.
      source:
        type: string
        description: The source of the term.
      status:
        $ref: '#/definitions/AtlasTermAssignmentStatus'
      steward:
        type: string
        description: The steward of the term.
      termGuid:
        type: string
        description: The GUID of the term.
    title: AtlasTermAssignmentHeader
    description: The header for term assignment.
  AtlasEntityHeader:
    type: object
    title: AtlasEntityHeader
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        classificationNames:
          type: array
          description: An array of classification names.
          items:
            type: string
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification'
        displayText:
          type: string
          description: The display text.
        guid:
          type: string
          description: The GUID of the record.
        isIncomplete:
          readOnly: false
          description: Whether it is a shell entity
          type: boolean
        labels:
          readOnly: false
          description: labels
          type: array
          items:
            type: string
        meaningNames:
          type: array
          description: An array of meanings.
          items:
            type: string
        meanings:
          type: array
          description: An array of term assignment headers.
          items:
            $ref: '#/definitions/AtlasTermAssignmentHeader'
        status:
          $ref: '#/definitions/Status'
    description: An instance of an entity - like hive_table, hive_database.
  AtlasTermAssignmentStatus:
    type: string
    title: AtlasTermAssignmentStatus
    description: The status of terms assignment.
    enum:
    - DISCOVERED
    - PROPOSED
    - IMPORTED
    - VALIDATED
    - DEPRECATED
    - OBSOLETE
    - OTHER
    x-ms-enum:
      name: AtlasTermAssignmentStatus
      modelAsString: true
  AtlasStruct:
    type: object
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        $ref: '#/definitions/LastModifiedTS'
    title: AtlasStruct
    description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
  Status:
    type: string
    title: Status
    description: Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status
      modelAsString: true
  AtlasRelationshipWithExtInfo:
    type: object
    properties:
      referredEntities:
        type: object
        description: The referred entity header.
        additionalProperties:
          $ref: '#/definitions/AtlasEntityHeader'
      relationship:
        $ref: '#/definitions/AtlasRelationship'
    title: AtlasRelationshipWithExtInfo
    description: The relationship with extended information.
  Status_AtlasRelationship:
    type: string
    title: Status
    description: The enum of relationship status.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status_AtlasRelationship
      modelAsString: true
  AtlasClassification:
    type: object
    title: AtlasClassification
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        entityGuid:
          type: string
          description: The GUID of the entity.
        entityStatus:
          $ref: '#/definitions/Status'
        removePropagationsOnEntityDelete:
          type: boolean
          description: Determines if propagations will be removed on entity deletion.
        validityPeriods:
          type: array
          description: An array of time boundaries indicating validity periods.
          items:
            $ref: '#/definitions/TimeBoundary'
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
    description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
parameters:
  extendedInfo:
    name: extendedInfo
    description: Limits whether includes extended information.
    in: query
    required: false
    type: boolean
    x-ms-parameter-location: method
  relationshipGuid:
    name: guid
    description: The globally unique identifier of the relationship.
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'