openapi: 3.2.0
info:
  title: Mef Tapi Path Computation API
  version: 2018R2
  description: 'Operations tagged tapi-path-computation across 3 of this provider''s published API definitions: mef-lso-presto-nrp-openapi.yml, mef-lso-presto-nrp-rcp-only-openapi.yml, mef-lso-presto-nrp-simplified-hierarchy-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:1234/restconf
tags:
- name: tapi-path-computation
paths:
  /operations/compute-p-2-p-path/:
    post:
      tags:
      - tapi-path-computation
      responses:
        200:
          description: Correct response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.ComputeP2PPathOutput'
            application/xml:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.ComputeP2PPathOutput'
        201:
          description: No response
        400:
          description: Internal error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.ComputeP2PPathInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.ComputeP2PPathInput'
    servers:
    - url: https://localhost:1234/restconf
  /operations/delete-p-2-p-path/:
    post:
      tags:
      - tapi-path-computation
      responses:
        200:
          description: Correct response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.DeleteP2PPathOutput'
            application/xml:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.DeleteP2PPathOutput'
        201:
          description: No response
        400:
          description: Internal error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.DeleteP2PPathInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.DeleteP2PPathInput'
    servers:
    - url: https://localhost:1234/restconf
  /operations/optimize-p-2-p-path/:
    post:
      tags:
      - tapi-path-computation
      responses:
        200:
          description: Correct response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.OptimizeP2PPathOutput'
            application/xml:
              schema:
                $ref: '#/components/schemas/tapi.path.computation.OptimizeP2PPathOutput'
        201:
          description: No response
        400:
          description: Internal error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.OptimizeP2PPathInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/tapi.path.computation.OptimizeP2PPathInput'
    servers:
    - url: https://localhost:1234/restconf
components:
  schemas:
    tapi.path.computation.OptimizeP2PPathInput:
      properties:
        input:
          type: object
          properties:
            routing-constraint:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.RoutingConstraint'
            path-id-or-name:
              type: string
              description: none
            optimization-constraint:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathOptimizationConstraint'
            objective-function:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathObjectiveFunction'
    tapi.path.computation.ComputeP2PPathInput:
      properties:
        input:
          type: object
          properties:
            routing-constraint:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.RoutingConstraint'
            objective-function:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathObjectiveFunction'
            sep:
              type: array
              description: none
              items:
                $ref: '#/components/schemas/tapi.path.computation.PathServiceEndPoint'
    tapi.path.computation.RoutingConstraint:
      allOf:
      - $ref: '#/components/schemas/tapi.common.LocalClass'
      - type: object
        properties:
          path-layer:
            type: array
            description: none
            items:
              $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          requested-capacity:
            description: none
            $ref: '#/components/schemas/tapi.common.Capacity'
          avoid-topology:
            type: array
            description: none
            items:
              type: string
              x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:uuid
          service-level:
            type: string
            description: An abstract value the meaning of which is mutually agreed – typically represents metrics such as - Class of service, priority, resiliency, availability
          cost-characteristic:
            type: array
            description: The list of costs where each cost relates to some aspect of the TopologicalEntity.
            items:
              $ref: '#/components/schemas/tapi.topology.CostCharacteristic'
          include-topology:
            type: array
            description: none
            items:
              $ref: '#/components/schemas/tapi.topology.TopologyRef'
          latency-characteristic:
            type: array
            description: The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.
            items:
              $ref: '#/components/schemas/tapi.topology.LatencyCharacteristic'
        description: none
    tapi.common.PortRole:
      type: string
      enum:
      - SYMMETRIC
      - ROOT
      - LEAF
      - TRUNK
      - UNKNOWN
    tapi.path.computation.PathOptimizationConstraint:
      allOf:
      - $ref: '#/components/schemas/tapi.common.LocalClass'
      - type: object
        properties:
          traffic-interruption:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
        description: none
    tapi.path.computation.DeleteP2PPathInput:
      properties:
        input:
          type: object
          properties:
            path-id-or-name:
              type: string
              description: none
    tapi.path.computation.OptimizeP2PPathOutput:
      properties:
        output:
          type: object
          properties:
            service:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathComputationService'
    tapi.common.PortDirection:
      type: string
      enum:
      - BIDIRECTIONAL
      - INPUT
      - OUTPUT
      - UNIDENTIFIED_OR_UNKNOWN
    tapi.common.BandwidthProfileType:
      type: string
      enum:
      - MEF_10.x
      - RFC_2697
      - RFC_2698
      - RFC_4115
    tapi.common.DirectiveValue:
      type: string
      enum:
      - MINIMIZE
      - MAXIMIZE
      - ALLOW
      - DISALLOW
      - DONT_CARE
    tapi.topology.LatencyCharacteristic:
      type: object
      properties:
        traffic-property-name:
          type: string
          description: The identifier of the specific traffic property to which the queuing latency applies.
        jitter-characteristic:
          type: string
          description: "High frequency deviation from true periodicity of a signal and therefore a small high rate of change of transfer latency.\n                    Applies to TDM systems (and not packet)."
        fixed-latency-characteristic:
          type: string
          description: A TopologicalEntity suffers delay caused by the realization of the servers (e.g. distance related; FEC encoding etc.) along with some client specific processing. This is the total average latency effect of the TopologicalEntity
        wander-characteristic:
          type: string
          description: "Low frequency deviation from true periodicity of a signal and therefore a small low rate of change of transfer latency.\n                    Applies to TDM systems (and not packet)."
        queing-latency-characteristic:
          type: string
          description: The specific queuing latency for the traffic property.
    tapi.topology.CostCharacteristic:
      type: object
      properties:
        cost-value:
          type: string
          description: The specific cost.
        cost-algorithm:
          type: string
          description: The cost may vary based upon some properties of the TopologicalEntity. The rules for the variation are conveyed by the costAlgorithm.
        cost-name:
          type: string
          description: The cost characteristic will related to some aspect of the TopologicalEntity (e.g. $ cost, routing weight). This aspect will be conveyed by the costName.
    tapi.path.computation.DeleteP2PPathOutput:
      properties:
        output:
          type: object
          properties:
            service:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathComputationService'
    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.CapacityValue:
      type: object
      properties:
        value:
          type: integer
          format: int32
          description: none
        unit:
          description: none
          $ref: '#/components/schemas/tapi.common.CapacityUnit'
    tapi.topology.TopologyRef:
      type: object
      properties:
        topology-id:
          type: string
          x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:uuid
    tapi.common.Capacity:
      type: object
      properties:
        bandwidth-profile:
          description: none
          $ref: '#/components/schemas/tapi.common.BandwidthProfile'
        total-size:
          description: Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile, this is expected to same as the committedInformationRate.
          $ref: '#/components/schemas/tapi.common.CapacityValue'
    tapi.path.computation.PathComputationService:
      allOf:
      - $ref: '#/components/schemas/tapi.common.GlobalClass'
      - type: object
        properties:
          path:
            type: array
            description: none
            items:
              $ref: '#/components/schemas/tapi.path.computation.PathRef'
          routing-constraint:
            description: none
            $ref: '#/components/schemas/tapi.path.computation.RoutingConstraint'
          optimization-constraint:
            description: none
            $ref: '#/components/schemas/tapi.path.computation.PathOptimizationConstraint'
          objective-function:
            description: none
            $ref: '#/components/schemas/tapi.path.computation.PathObjectiveFunction'
          end-point:
            type: array
            description: none
            items:
              $ref: '#/components/schemas/tapi.path.computation.PathServiceEndPoint'
        description: none
    tapi.path.computation.PathObjectiveFunction:
      allOf:
      - $ref: '#/components/schemas/tapi.common.LocalClass'
      - type: object
        properties:
          link-utilization:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
          bandwidth-optimization:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
          cost-optimization:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
          resource-sharing:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
          concurrent-paths:
            description: none
            $ref: '#/components/schemas/tapi.common.DirectiveValue'
        description: none
    tapi.path.computation.PathRef:
      type: object
      properties:
        path-id:
          type: string
          x-path: /tapi-common:context/tapi-path-computation:path/tapi-path-computation:uuid
    tapi.common.BandwidthProfile:
      type: object
      properties:
        committed-information-rate:
          description: none
          $ref: '#/components/schemas/tapi.common.CapacityValue'
        coupling-flag:
          type: boolean
          description: none
          default: false
        bw-profile-type:
          description: none
          $ref: '#/components/schemas/tapi.common.BandwidthProfileType'
        peak-information-rate:
          description: none
          $ref: '#/components/schemas/tapi.common.CapacityValue'
        committed-burst-size:
          description: none
          $ref: '#/components/schemas/tapi.common.CapacityValue'
        peak-burst-size:
          description: none
          $ref: '#/components/schemas/tapi.common.CapacityValue'
        color-aware:
          type: boolean
          description: none
          default: false
    tapi.common.GlobalClass:
      type: object
      properties:
        name:
          type: array
          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.
          items:
            $ref: '#/components/schemas/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. An UUID carries no semantics with respect to the purpose or state of the entity.\n                    UUID here uses string representation as defined in RFC 4122.  The canonical representation uses lowercase characters.\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} \n                    Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
    tapi.common.LayerProtocolName:
      type: string
      enum:
      - OTSiA
      - OCH
      - OTU
      - ODU
      - ETH
      - ETY
      - DSR
    tapi.path.computation.ComputeP2PPathOutput:
      properties:
        output:
          type: object
          properties:
            service:
              description: none
              $ref: '#/components/schemas/tapi.path.computation.PathComputationService'
    tapi.common.LocalClass:
      type: object
      properties:
        name:
          type: array
          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.
          items:
            $ref: '#/components/schemas/tapi.common.NameAndValue'
        local-id:
          type: string
          description: none
    tapi.common.CapacityUnit:
      type: string
      enum:
      - TB
      - TBPS
      - GB
      - GBPS
      - MB
      - MBPS
      - KB
      - KBPS
    tapi.path.computation.PathServiceEndPoint:
      allOf:
      - $ref: '#/components/schemas/tapi.common.LocalClass'
      - type: object
        properties:
          service-layer:
            description: none
            $ref: '#/components/schemas/tapi.common.LayerProtocolName'
          role:
            description: 'Each EP of the FC has a role (e.g., working, protection, protected, symmetric, hub, spoke, leaf, root)  in the context of the FC with respect to the FC function. '
            $ref: '#/components/schemas/tapi.common.PortRole'
          service-interface-point:
            type: string
            description: none
            x-path: /tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid
          direction:
            description: The orientation of defined flow at the EndPoint.
            $ref: '#/components/schemas/tapi.common.PortDirection'
        description: "The association of the FC to LTPs is made via EndPoints.\n                The EndPoint (EP) object class models the access to the FC function.\n                The traffic forwarding between the associated EPs of the FC depends upon the type of FC and may be associated with FcSwitch object instances.\n                In cases where there is resilience the EndPoint may convey the resilience role of the access to the FC.\n                It can represent a protected (resilient/reliable) point or a protecting (unreliable working or protection) point.\n                The EP replaces the Protection Unit of a traditional protection model.\n                The ForwadingConstruct can be considered as a component and the EndPoint as a Port on that component"
x-refined-from:
- mef-lso-presto-nrp-openapi.yml
- mef-lso-presto-nrp-rcp-only-openapi.yml
- mef-lso-presto-nrp-simplified-hierarchy-openapi.yml