Newer
Older
# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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.
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
---
swagger: "2.0"
info:
description: "connection API generated from yang definitions"
version: "1.0"
title: "connection API"
host: "localhost:1234"
consumes:
- "application/yang-data+json"
produces:
- "application/yang-data+json"
paths:
/data/connection/:
post:
tags:
- "connection"
description: "creates connection.Connection"
parameters:
- in: "body"
name: "connection.Connection.body-param"
description: "connection.Connection to be added to list"
required: false
schema:
$ref: "#/definitions/connection.Connection"
responses:
201:
description: "Object created"
400:
description: "Internal error"
409:
description: "Object already exists"
/data/connection={connection-id}/:
get:
tags:
- "connection"
description: "returns connection.Connection"
parameters:
- name: "connection-id"
in: "path"
description: "Id of connection"
required: true
type: "string"
responses:
200:
description: "connection.Connection"
schema:
$ref: "#/definitions/connection.Connection"
400:
description: "Internal error"
post:
tags:
- "connection"
description: "creates connection.Connection"
parameters:
- name: "connection-id"
in: "path"
description: "Id of connection"
required: true
type: "string"
- in: "body"
name: "connection.Connection.body-param"
description: "connection.Connection to be added to list"
required: false
schema:
$ref: "#/definitions/connection.Connection"
responses:
201:
description: "Object created"
400:
description: "Internal error"
409:
description: "Object already exists"
put:
tags:
- "connection"
description: "creates or updates connection.Connection"
parameters:
- name: "connection-id"
in: "path"
description: "Id of connection"
required: true
type: "string"
- in: "body"
name: "connection.Connection.body-param"
description: "connection.Connection to be added or updated"
required: false
schema:
$ref: "#/definitions/connection.Connection"
responses:
201:
description: "Object created"
400:
description: "Internal error"
204:
description: "Object modified"
delete:
tags:
- "connection"
description: "removes connection.Connection"
parameters:
- name: "connection-id"
in: "path"
description: "Id of connection"
required: true
type: "string"
responses:
400:
description: "Internal error"
204:
description: "Object deleted"
definitions:
connection.Connection:
type: "object"
properties:
target-port:
type: "string"
x-path: "/topology:topology/topology:node/topology:port/topology:port-id"
source-port:
type: "string"
x-path: "/topology:topology/topology:node/topology:port/topology:port-id"
target-node:
type: "string"
x-path: "/topology:topology/topology:node/topology:node-id"
connection-id:
type: "string"
bandwidth:
type: "integer"
format: "int64"
source-node:
type: "string"
x-path: "/topology:topology/topology:node/topology:node-id"
layer-protocol-name:
$ref: "#/definitions/topology.LayerProtocolName"
topology.LayerProtocolName:
type: "string"
enum:
- "ETH"
- "OPTICAL"