-- YML module extracted from ITU-T Q.819 (01/2022)

openapi: 3.0.0
info:
  title: ITU-T_ContainmentService
  description: ''This is the formal definition of the ITU-T Containment Service.''
  termsOfService: https://www.itu.int/en/ITU-T/about/Pages/default.aspx
  contact:
    email: zlwang@bupt.edu.cn
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
externalDocs:
  description: See Recommendation ITU-T Q.819
  url: https://www.itu.int/itu-t/recommendations/index.aspx?ser=X
servers:
- url: http://www.itu.int/sg2/rest/ContainmentService/v1.0.0
- url: https://www.itu.int/sg2/rest/ContainmentService/v1.0.0
tags:
- name: ContainmentService
  description: All APIs realted to the ITU-T Containment Service
  externalDocs:
    description: Find out more
    url: https://www.itu.int/itu-t/recommendations/index.aspx?ser=X

paths:
  /ContainmentService/exists/{moInstance}:
    parameters:
      - name: moInstance
        in: path
        description: "The DN(URI) of the specified MO"
        required: true
        schema:
          type: string
          format: uri
  
    get:
      tags:
      - ContainmentService
      summary: "check whether the specified MO instance is registered in the containment service or not."
      description: "returns true if the specified MO instance exists in the containment service, otherewise it returns false"
      operationId: "exists"
      responses:
        200:
          description: "The specified MO is found in the containment services."
          content: {}
        404:
          description: "The specified MO is not found in the containment services."
          content: {}
        500:
          description: "Internal Server Error"   
          content: {}
  
  /ContainmentService/getContained/{baseMO}/{scope}:
    parameters:
      - name: baseMO
        in: path
        description: "The DN of the specified base MO which is the root of a subtree"
        required: true
        schema:
          type: string
          format: uri
      - name: scope
        in: path
        description: "The scope of the containment information to be returned associated with the root MO"
        required: true
        schema:
          $ref: ''#/components/schemas/ScopeType''
  
    get:
      tags:
      - ContainmentService
      summary: "returns the MO instance list which are contained by the specified base MO instance."
      description: "returns the list of MO instance that are contained bu the base MO instance. the scope parameter can be of 4 possible values: BaseObjectOnly, WholeSubTree, IndividualLevel, IndividualLevel"
      operationId: "getContained"
      responses:
        200:
          description: "The operation is executed successfully, and the list of contained MO instances are returned"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/MOList''
        404:
          description: "The specified MO is not found in the containment services."
          content: {}        
        500:
          description: "Internal Server Error"   
          content: {}
    
  /ContainmentService/getContainedByClass/{baseMO}/{scope}/{class}:
    parameters:
      - name: baseMO
        in: path
        description: "The DN of the specified base MO which is the root of a subtree"
        required: true
        schema:
          type: string
          format: uri
      - name: scope
        in: path
        description: "The scope of the containment information to be returned associated with the root MO"
        required: true
        schema:
          $ref: ''#/components/schemas/ScopeType''
      - name: class
        in: path
        description: "The class of the contained information to be returned associated with the root MO"
        required: true
        schema:
          type: string

    get:
      tags:
      - ContainmentService
      summary: "returns the MO instance list which are contained by the specified base MO instance."
      description: "returns the list of MO instance that are contained bu the base MO instance. the scope parameter can be of 4 possible values: BaseObjectOnly, WholeSubTree, IndividualLevel, IndividualLevel, and the returned MO list is filtered by the class specified in the input parameter"
      operationId: "getContainedByClass"
      responses:
        200:
          description: "The operation is executed successfully, and the list of contained MO instances are returned"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/MOList''
        404:
          description: "The specified MO is not found in the containment services."
          content: {}
        500:
          description: "Internal Server Error"   
          content: {}

components:
  schemas:

    ScopeEnumType:
      type: string
      format: enum
        - BasicObjectOnly
        - WholeSubtree
        - IndividualLevel
        - BaseToLevel
    
    ScopeType:
      type: object
      properties:  
        scopeInd:
          $ref: ''#/components/schemas/ScopeEnumType''
        level:
          type: integer
  
    MOList:
      type: array
      items:
        type: string
        format: uri