tapi-connectivity.yaml

# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
swagger: "2.0"
info:
  description: "\r\n        This module contains TAPI Notification Model definitions.\r\
    \n        Source: TapiNotification.uml\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://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/EagleUmlYang__;!!OSsGDw!d_dJlNtYLmD585It0DKukzB2TS5KZqBZQ-pdI1D-6c6c5hRDotd6G4QHf0bG$\
    \ >\r\n          and further edited manually to comply with the [ONF IISOMI UML2YANG\
    \ mapping guidelines]\r\n          <https://urldefense.com/v3/__https://wiki.opennetworking.org/display/OIMT/UML*-*YANG*Guidelines__;Kysr!!OSsGDw!d_dJlNtYLmD585It0DKukzB2TS5KZqBZQ-pdI1D-6c6c5hRDotd6G8IIivez$\
    \ >\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://urldefense.com/v3/__https://tools.ietf.org/html/rfc7950__;!!OSsGDw!d_dJlNtYLmD585It0DKukzB2TS5KZqBZQ-pdI1D-6c6c5hRDotd6G3bKxRf2$\
    \ >.\r\n          YANG models included in this release may not be backward compatible\
    \ with previous TAPI releases.\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        This module contains TAPI Connectivity Model\
    \ definitions.\r\n        Source: TapiConnectivity.uml\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://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/EagleUmlYang__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_6pxiNxl$\
    \ >\r\n        and further edited manually to comply with the [ONF IISOMI UML2YANG\
    \ mapping guidelines]\r\n        <https://urldefense.com/v3/__https://wiki.opennetworking.org/display/OIMT/UML*-*YANG*Guidelines__;Kysr!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_wxKUbJ_$\
    \ >\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://urldefense.com/v3/__https://tools.ietf.org/html/rfc7950__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_zcAY1P4$\
    \ >.\r\n        YANG models included in this release may not be backward compatible\
    \ with previous TAPI releases.\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        This module contains TAPI Topology Model\
    \ definitions.\r\n        Source: TapiTopology.uml\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://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/EagleUmlYang__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_6pxiNxl$\
    \ >\r\n          and further edited manually to comply with the [ONF IISOMI UML2YANG\
    \ mapping guidelines]\r\n          <https://urldefense.com/v3/__https://wiki.opennetworking.org/display/OIMT/UML*-*YANG*Guidelines__;Kysr!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_wxKUbJ_$\
    \ >\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://urldefense.com/v3/__https://tools.ietf.org/html/rfc7950__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_zcAY1P4$\
    \ >.\r\n          YANG models included in this release may not be backward compatible\
    \ with previous TAPI releases.\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        This module contains TAPI Common Model definitions.\r\
    \n        Source: TapiCommon.uml\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.\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        This module contains TAPI Path Computation\
    \ Model definitions.\r\n        Source: TapiPathComputation.uml\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.\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."
  version: "2.1.3"
  title: "tapi-notification,tapi-connectivity,tapi-topology,tapi-common,tapi-path-computation\
    \ API"
host: "localhost:1234"
consumes:
- "application/yang-data+json"
produces:
- "application/yang-data+json"
paths:
  /data/tapi-common:context/:
    get:
      tags:
      - "tapi-common"
      summary: "returns tapi.common.Context"
      description: "none"
      parameters: []
      responses:
        200:
          description: "tapi.common.Context"
          schema:
            $ref: "#/definitions/tapi.common.ContextWrapper"
        400:
          description: "Internal error"
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.Context"
      description: "none"
      parameters:
      - in: "body"
        name: "tapi.common.Context.body-param"
        description: "tapi.common.Context to be added to list"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.ContextWrapper"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
    put:
      tags:
      - "tapi-common"
      summary: "creates or updates tapi.common.Context"
      description: "none"
      parameters:
      - in: "body"
        name: "tapi.common.Context.body-param"
        description: "tapi.common.Context to be added or updated"
        required: false
        schema:
          $ref: "#/definitions/tapi.common.ContextWrapper"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        204:
          description: "Object modified"
    delete:
      tags:
      - "tapi-common"
      summary: "removes tapi.common.Context"
      description: "none"
      parameters: []
      responses:
        400:
          description: "Internal error"
        204:
          description: "Object deleted"
  /data/tapi-common:context/name/:
    post:
      tags:
      - "tapi-common"
      summary: "creates tapi.common.NameAndValue"
      description: "List of names. A property of an entity with a value that is unique\
        \ in some namespace but may change during the life of the entity. 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.NameAndValueWrapper"
      responses:
        201:
          description: "Object created"
        400:
          description: "Internal error"
        409:
          description: "Object already exists"
  /data/tapi-common:context/name={value-name}/:
    get:
      tags:
      - "tapi-common"