tapi-common@2019-03-31.yaml

---
swagger: "2.0"
info:
  description: "\r\n        This module contains TAPI Common Model definitions.\r\n\
    \        Source: TapiCommon.uml\r\n        Copyright (c) 2018 Open Networking\
    \ Foundation (ONF). All rights reserved.\r\n        License: This module is distributed\
    \ under the Apache License 2.0\r\n        - The TAPI YANG models included in this\
    \ TAPI release are a *normative* part of the TAPI SDK.\r\n        - The YANG specifications\
    \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\
    \ mapping tool]\r\n        <https://github.com/OpenNetworkingFoundation/EagleUmlYang>\r\
    \n        and further edited manually to comply with the [ONF IISOMI UML2YANG\
    \ mapping guidelines]\r\n        <https://wiki.opennetworking.org/display/OIMT/UML+-+YANG+Guidelines>\r\
    \n        - Status of YANG model artifacts can be determined by referring to the\
    \ corresponding UML artifacts.\r\n        As described in the UML models, some\
    \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\
    \n        - The ONF TAPI release process does not guarantee backward compatibility\
    \ of YANG models across major versions of TAPI releases.\r\n        The YANG model\
    \ backward compatibility criteria are outlined in section 11 of <https://tools.ietf.org/html/rfc7950>.\r\
    \n        YANG models included in this release may not be backward compatible\
    \ with previous TAPI releases."
  version: "2.2.0"
  title: "tapi-common API"
host: "localhost:1234"
consumes:
- "application/yang-data+json"
produces:
- "application/yang-data+json"
paths:
  /data/context/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.TapiContext"
      description: "none"
      parameters: []
      responses:
        200:
          description: "tapi.common.TapiContext"
          schema:
            $ref: "#/definitions/tapi.common.TapiContext"
        400:
          description: "Internal error"
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.TapiContext"
      description: "none"
      parameters:
      - in: "body"
        name: "tapi.common.TapiContext.body-param"
        description: "tapi.common.TapiContext to be added to list"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.TapiContext"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
    put:
      tags:
      - "tapi-common"
      summary: "creates or updates tapi.common.TapiContext"
      description: "none"
      parameters:
      - in: "body"
        name: "tapi.common.TapiContext.body-param"
        description: "tapi.common.TapiContext to be added or updated"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.TapiContext"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        204:
          description: "Object modified"
    delete:
      tags:
      - "tapi-common"
      summary: "removes tapi.common.TapiContext"
      description: "none"
      parameters: []
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /data/context/name/:
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - in: "body"
        name: "tapi.common.NameAndValue.body-param"
        description: "tapi.common.NameAndValue to be added to list"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.NameAndValue"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
  /data/context/name={value-name}/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.NameAndValue"
          schema:
            $ref: "#/definitions/tapi.common.NameAndValue"
        400:
          description: "Internal error"
    put:
      tags:
      - "tapi-common"
      summary: "creates or updates tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      - in: "body"
        name: "tapi.common.NameAndValue.body-param"
        description: "tapi.common.NameAndValue to be added or updated"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.NameAndValue"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        204:
          description: "Object modified"
    delete:
      tags:
      - "tapi-common"
      summary: "removes tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /data/context/service-interface-point/:
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.ServiceInterfacePoint"
      description: "none"
      parameters:
      - in: "body"
        name: "tapi.common.ServiceInterfacePoint.body-param"
        description: "tapi.common.ServiceInterfacePoint to be added to list"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
  /data/context/service-interface-point={uuid}/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.ServiceInterfacePoint"
      description: "none"
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.ServiceInterfacePoint"
          schema:
            $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
        400:
          description: "Internal error"
    put:
      tags:
      - "tapi-common"
      summary: "creates or updates tapi.common.ServiceInterfacePoint"
      description: "none"
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      - in: "body"
        name: "tapi.common.ServiceInterfacePoint.body-param"
        description: "tapi.common.ServiceInterfacePoint to be added or updated"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        204:
          description: "Object modified"
    delete:
      tags:
      - "tapi-common"
      summary: "removes tapi.common.ServiceInterfacePoint"
      description: "none"
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /data/context/service-interface-point={uuid}/available-capacity/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.Capacity"
      description: "Capacity available to be assigned."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.Capacity"
          schema:
            $ref: "#/definitions/tapi.common.Capacity"
        400:
          description: "Internal error"
  /data/context/service-interface-point={uuid}/available-capacity/total-size/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.CapacityValue"
      description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\
        \ this is expected to same as the committedInformationRate."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.CapacityValue"
          schema:
            $ref: "#/definitions/tapi.common.CapacityValue"
        400:
          description: "Internal error"
  /data/context/service-interface-point={uuid}/name/:
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      - in: "body"
        name: "tapi.common.NameAndValue.body-param"
        description: "tapi.common.NameAndValue to be added to list"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.NameAndValue"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
  /data/context/service-interface-point={uuid}/name={value-name}/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.NameAndValue"
          schema:
            $ref: "#/definitions/tapi.common.NameAndValue"
        400:
          description: "Internal error"
    put:
      tags:
      - "tapi-common"
      summary: "creates or updates tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      - in: "body"
        name: "tapi.common.NameAndValue.body-param"
        description: "tapi.common.NameAndValue to be added or updated"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.NameAndValue"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        204:
          description: "Object modified"
    delete:
      tags:
      - "tapi-common"
      summary: "removes tapi.common.NameAndValue"
      description: "List of names. This value is unique in some namespace but may\
        \ change during the life of the entity.\r\n                A name carries\
        \ no semantics with respect to the purpose of the entity."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      - name: "value-name"
        in: "path"
        description: "Id of name"
        required: true
        type: "string"
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /data/context/service-interface-point={uuid}/total-potential-capacity/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.Capacity"
      description: "An optimistic view of the capacity of the TopologicalEntity assuming\
        \ that any shared capacity is available to be taken."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.Capacity"
          schema:
            $ref: "#/definitions/tapi.common.Capacity"
        400:
          description: "Internal error"
  /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.CapacityValue"
      description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\
        \ this is expected to same as the committedInformationRate."
      parameters:
      - name: "uuid"
        in: "path"
        description: "Id of service-interface-point"
        required: true
        type: "string"
      responses:
        200:
          description: "tapi.common.CapacityValue"
          schema:
            $ref: "#/definitions/tapi.common.CapacityValue"
        400:
          description: "Internal error"
  /operations/get-service-interface-point-details/:
    post:
      tags:
      - "tapi-common"
      summary: "operates on tapi.common.GetServiceInterfacePointDetails"
      description: "operates on tapi.common.GetServiceInterfacePointDetails"
      parameters:
      - in: "body"
        name: "tapi.common.getserviceinterfacepointdetails.Input.body-param"
        required: false
        schema:
          properties:
            input:
              $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input"
      responses:
        200:
          description: "Correct response"
          schema:
            $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails"
        201:
          description: "No response"
        400:
          description: "Internal error"
  /operations/get-service-interface-point-list/:
    post:
      tags:
      - "tapi-common"
      parameters: []
      responses:
        200:
          description: "Correct response"
          schema:
            $ref: "#/definitions/tapi.common.GetServiceInterfacePointList"
        201:
          description: "No response"
        400:
          description: "Internal error"
  /operations/update-service-interface-point/:
    post:
      tags:
      - "tapi-common"
      summary: "operates on tapi.common.UpdateServiceInterfacePoint"
      description: "operates on tapi.common.UpdateServiceInterfacePoint"
      parameters:
      - in: "body"
        name: "tapi.common.updateserviceinterfacepoint.Input.body-param"
        required: false
        schema:
          properties:
            input:
              $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input"
      responses:
        201:
          description: "No response"
        400:
          description: "Internal error"
definitions:
  tapi.common.AdminStatePac:
    type: "object"
    properties:
      operational-state:
        description: "none"
        $ref: "#/definitions/tapi.common.OperationalState"
      lifecycle-state:
        description: "none"
        $ref: "#/definitions/tapi.common.LifecycleState"
      administrative-state:
        description: "none"
        $ref: "#/definitions/tapi.common.AdministrativeState"
  tapi.common.AdministrativeState:
    type: "string"
    enum:
    - "LOCKED"
    - "UNLOCKED"
  tapi.common.Capacity:
    type: "object"
    properties:
      total-size:
        description: "Total capacity of the TopologicalEntity in MB/s. In case of\
          \ bandwidthProfile, this is expected to same as the committedInformationRate."
        $ref: "#/definitions/tapi.common.CapacityValue"
  tapi.common.CapacityPac:
    type: "object"
    properties:
      available-capacity:
        description: "Capacity available to be assigned."
        $ref: "#/definitions/tapi.common.Capacity"
      total-potential-capacity:
        description: "An optimistic view of the capacity of the TopologicalEntity\
          \ assuming that any shared capacity is available to be taken."
        $ref: "#/definitions/tapi.common.Capacity"
  tapi.common.CapacityUnit:
    type: "string"
    enum:
    - "TB"
    - "TBPS"
    - "GB"
    - "GBPS"
    - "MB"
    - "MBPS"
    - "KB"
    - "KBPS"
    - "GHz"
    - "MHz"
  tapi.common.CapacityValue:
    type: "object"
    properties:
      value:
        type: "integer"
        format: "int32"
        description: "none"
      unit:
        description: "none"
        $ref: "#/definitions/tapi.common.CapacityUnit"
  tapi.common.GetServiceInterfacePointDetails:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output"
  tapi.common.GetServiceInterfacePointList:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output"
  tapi.common.GlobalClass:
    type: "object"
    properties:
      name:
        type: "array"
        description: "List of names. This value is unique in some namespace but may\
          \ change during the life of the entity.\r\n                A name carries\
          \ no semantics with respect to the purpose of the entity."
        items:
          $ref: "#/definitions/tapi.common.NameAndValue"
      uuid:
        type: "string"
        description: "UUID: An identifier that is universally unique within an identifier\
          \ space, where the identifier space is itself globally unique, and immutable.\r\
          \n                An UUID carries no semantics with respect to the purpose\
          \ or state of the entity.\r\n                UUID here uses string representation\
          \ as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\
          \n                Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\
          \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                Example of a UUID\
          \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
  tapi.common.LayerProtocolName:
    type: "string"
    enum:
    - "ODU"
    - "ETH"
    - "DSR"
    - "PHOTONIC_MEDIA"
  tapi.common.LifecycleState:
    type: "string"
    enum:
    - "PLANNED"
    - "POTENTIAL_AVAILABLE"
    - "POTENTIAL_BUSY"
    - "INSTALLED"
    - "PENDING_REMOVAL"
  tapi.common.NameAndValue:
    type: "object"
    properties:
      value-name:
        type: "string"
        description: "The name of the value. The value need not have a name."
      value:
        type: "string"
        description: "The value"
  tapi.common.OperationalState:
    type: "string"
    enum:
    - "DISABLED"
    - "ENABLED"
  tapi.common.ServiceInterfacePoint:
    allOf:
    - $ref: "#/definitions/tapi.common.AdminStatePac"
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        supported-layer-protocol-qualifier:
          type: "array"
          description: "none"
          items:
            type: "string"
        layer-protocol-name:
          description: "Usage of layerProtocolName [>1]  in the ServiceInterfacePoint\
            \ should be considered experimental"
          $ref: "#/definitions/tapi.common.LayerProtocolName"
      description: "The LogicalTerminationPoint (LTP) object class encapsulates the\
        \ termination and adaptation functions of one or more transport layers. \r\
        \n            The structure of LTP supports all transport protocols including\
        \ circuit and packet forms."
  tapi.common.TapiContext:
    allOf:
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        service-interface-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
      description: "The Network Control Domain (NCD) object class represents the scope\
        \ of control that a particular SDN controller has with respect to a particular\
        \ network, (i.e., encompassing a designated set of interconnected (virtual)\
        \ network elements)."
  tapi.common.getserviceinterfacepointdetails.Input:
    type: "object"
    properties:
      uuid:
        type: "string"
        description: "UUID: An identifier that is universally unique within an identifier\
          \ space, where the identifier space is itself globally unique, and immutable.\r\
          \n                    An UUID carries no semantics with respect to the purpose\
          \ or state of the entity.\r\n                    UUID here uses string representation\
          \ as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\
          \n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\
          \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a\
          \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
  tapi.common.getserviceinterfacepointdetails.Output:
    type: "object"
    properties:
      sip:
        description: "none"
        $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
  tapi.common.getserviceinterfacepointlist.Output:
    type: "object"
    properties:
      sip:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.common.ServiceInterfacePoint"
  tapi.common.updateserviceinterfacepoint.Input:
    type: "object"
    properties:
      uuid:
        type: "string"
        description: "UUID: An identifier that is universally unique within an identifier\
          \ space, where the identifier space is itself globally unique, and immutable.\r\
          \n                    An UUID carries no semantics with respect to the purpose\
          \ or state of the entity.\r\n                    UUID here uses string representation\
          \ as defined in RFC 4122.  The canonical representation uses lowercase characters.\r\
          \n                    Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\
          \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n                    Example of a\
          \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
      state:
        description: "none"
        $ref: "#/definitions/tapi.common.AdministrativeState"