Skip to content
GitLab
Commit 95ad2a8c authored by Samir Medjiah's avatar Samir Medjiah
Browse files

SOL005: Consolidation of common data types, endpoint parameters, and responses... 

SOL005: Consolidation of common data types, endpoint parameters, and responses in VNF PM and NS LCM.
parent 0c4b6456
Pipeline #837 failed with stage
in 0 seconds
Expand all Hide whitespace changes
Inline Side-by-side
src/SOL005/NSFaultManagement/NSFaultManagement.yaml
View file @ 95ad2a8c
...@@ -38,6 +38,20 @@ paths: ...@@ -38,6 +38,20 @@ paths:
############################################################################### ###############################################################################
'/alarms': '/alarms':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2 #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get: get:
summary: Query alarms related to NS instances. summary: Query alarms related to NS instances.
description: > description: >
...@@ -78,19 +92,6 @@ paths: ...@@ -78,19 +92,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -164,6 +165,19 @@ paths: ...@@ -164,6 +165,19 @@ paths:
in: path in: path
type: string type: string
required: true required: true
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get: get:
summary: Read individual alarm. summary: Read individual alarm.
description: > description: >
...@@ -183,19 +197,6 @@ paths: ...@@ -183,19 +197,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -263,13 +264,6 @@ paths: ...@@ -263,13 +264,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The Content-Type header shall be set to The Content-Type header shall be set to
...@@ -280,12 +274,6 @@ paths: ...@@ -280,12 +274,6 @@ paths:
type: string type: string
enum: enum:
- application/merge-patch+json - application/merge-patch+json
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -342,6 +330,20 @@ paths: ...@@ -342,6 +330,20 @@ paths:
############################################################################## ##############################################################################
'/subscriptions': '/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4 #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post: post:
summary: Subscribe to alarms related to NSs. summary: Subscribe to alarms related to NSs.
description: > description: >
...@@ -362,13 +364,6 @@ paths: ...@@ -362,13 +364,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The MIME type of the body of the request. The MIME type of the body of the request.
...@@ -376,12 +371,6 @@ paths: ...@@ -376,12 +371,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: body - name: body
in: body in: body
required: true required: true
...@@ -475,13 +464,6 @@ paths: ...@@ -475,13 +464,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The MIME type of the body of the request. The MIME type of the body of the request.
...@@ -489,12 +471,6 @@ paths: ...@@ -489,12 +471,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -571,6 +547,19 @@ paths: ...@@ -571,6 +547,19 @@ paths:
in: path in: path
type: string type: string
required: true required: true
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get: get:
summary: Read an individual subscription. summary: Read an individual subscription.
description: > description: >
...@@ -587,13 +576,6 @@ paths: ...@@ -587,13 +576,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The MIME type of the body of the request. The MIME type of the body of the request.
...@@ -601,12 +583,6 @@ paths: ...@@ -601,12 +583,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -659,20 +635,6 @@ paths: ...@@ -659,20 +635,6 @@ paths:
Terminate Subscription Terminate Subscription
This method terminates an individual subscription. This method terminates an individual subscription.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
204: 204:
description: > description: >
......
src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml
View file @ 95ad2a8c
...@@ -37,6 +37,20 @@ paths: ...@@ -37,6 +37,20 @@ paths:
############################################################################### ###############################################################################
'/ns_instances': '/ns_instances':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2 #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post: post:
summary: Create a NS instance resource. summary: Create a NS instance resource.
description: > description: >
...@@ -49,13 +63,6 @@ paths: ...@@ -49,13 +63,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The MIME type of the body of the request. The MIME type of the body of the request.
...@@ -63,12 +70,6 @@ paths: ...@@ -63,12 +70,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: body - name: body
in: body in: body
required: true required: true
...@@ -201,19 +202,6 @@ paths: ...@@ -201,19 +202,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -290,6 +278,19 @@ paths: ...@@ -290,6 +278,19 @@ paths:
in: path in: path
type: string type: string
required: true required: true
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get: get:
summary: Read an individual NS instance resource. summary: Read an individual NS instance resource.
description: > description: >
...@@ -303,13 +304,6 @@ paths: ...@@ -303,13 +304,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type - name: Content-Type
description: > description: >
The MIME type of the body of the request. The MIME type of the body of the request.
...@@ -317,12 +311,6 @@ paths: ...@@ -317,12 +311,6 @@ paths:
in: header in: header
required: true required: true
type: string type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -381,20 +369,6 @@ paths: ...@@ -381,20 +369,6 @@ paths:
Delete NS Identifier Delete NS Identifier
This method deletes an individual NS instance resource. This method deletes an individual NS instance resource.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses: responses:
204: 204:
description: > description: >
...@@ -492,7 +466,7 @@ paths: ...@@ -492,7 +466,7 @@ paths:
Parameters for the instantiate NS operation, as defined in clause 6.5.2.10. Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -567,7 +541,7 @@ paths: ...@@ -567,7 +541,7 @@ paths:
Parameters for the scale NS operation, as defined in clause 6.5.2.13. Parameters for the scale NS operation, as defined in clause 6.5.2.13.
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -641,7 +615,7 @@ paths: ...@@ -641,7 +615,7 @@ paths:
Parameters for the update NS operation, as defined in clause 6.5.2.11. Parameters for the update NS operation, as defined in clause 6.5.2.11.
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -712,12 +686,12 @@ paths: ...@@ -712,12 +686,12 @@ paths:
in: body in: body
required: true required: true
schema: schema:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest" $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
description: > description: >
Parameters for the heal NS operation, as defined in clause 6.5.2.12. Parameters for the heal NS operation, as defined in clause 6.5.2.12.
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -792,12 +766,12 @@ paths: ...@@ -792,12 +766,12 @@ paths:
in: body in: body
required: true required: true
schema: schema:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest" $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
description: > description: >
The terminate NS request parameters, as defined in clause 6.5.2.14. The terminate NS request parameters, as defined in clause 6.5.2.14.
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -1102,7 +1076,7 @@ paths: ...@@ -1102,7 +1076,7 @@ paths:
type: string type: string
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -1163,7 +1137,7 @@ paths: ...@@ -1163,7 +1137,7 @@ paths:
type: string type: string
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: 401:
...@@ -1218,7 +1192,7 @@ paths: ...@@ -1218,7 +1192,7 @@ paths:
type: string type: string
responses: responses:
202: 202:
$ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty"
400: 400:
$ref: "../responses/SOL005_resp.yaml#/responses/400" $ref: "../responses/SOL005_resp.yaml#/responses/400"
401: