Commit 5051b771 authored by moscatelli's avatar moscatelli

SOL005: API versions endpoint included ad endpoint type + API version updated...

SOL005: API versions endpoint included ad endpoint type + API version updated to 1.2.0 + PDF references updated
parent 9f5f89cf
Pipeline #751 failed with stage
in 0 seconds
...@@ -31,53 +31,7 @@ paths: ...@@ -31,53 +31,7 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api-versions':
get: $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
############################################################################### ###############################################################################
# NS Descriptors # # NS Descriptors #
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.0.0" version: "1.2.0"
title: SOL005 - NS Fault Management Interface title: SOL005 - NS Fault Management Interface
description: > description: >
SOL005 - NS Fault Management Interface SOL005 - NS Fault Management Interface
...@@ -16,8 +16,8 @@ info: ...@@ -16,8 +16,8 @@ info:
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1 description: ETSI GS NFV-SOL 005 V2.5.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: "/nsfm/v1" basePath: "/nsfm/v1"
schemes: schemes:
- https - https
...@@ -30,53 +30,8 @@ paths: ...@@ -30,53 +30,8 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api-versions':
get: $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
############################################################################### ###############################################################################
# Alarms # # Alarms #
############################################################################### ###############################################################################
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.0.0" version: "1.2.0"
title: SOL005 - NS Lifecycle Management Interface title: SOL005 - NS Lifecycle Management Interface
description: > description: >
SOL005 - NS Lifecycle Management Interface SOL005 - NS Lifecycle Management Interface
...@@ -16,8 +16,8 @@ info: ...@@ -16,8 +16,8 @@ info:
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1 description: ETSI GS NFV-SOL 005 V2.5.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: "/nslcm/v1" basePath: "/nslcm/v1"
schemes: schemes:
- https - https
...@@ -30,53 +30,8 @@ paths: ...@@ -30,53 +30,8 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api-versions':
get: $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
############################################################################### ###############################################################################
# NSInstances # # NSInstances #
############################################################################### ###############################################################################
......
...@@ -31,53 +31,7 @@ paths: ...@@ -31,53 +31,7 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api-versions':
get: $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
############################################################################### ###############################################################################
# PM Jobs # # PM Jobs #
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.0.0" version: "1.2.0"
title: SOL005 - VNF Package Management Interface title: SOL005 - VNF Package Management Interface
description: > description: >
SOL005 - VNF Package Management Interface SOL005 - VNF Package Management Interface
...@@ -16,8 +16,8 @@ info: ...@@ -16,8 +16,8 @@ info:
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1 description: ETSI GS NFV-SOL 005 V2.5.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: "/vnfpkgm/v1" basePath: "/vnfpkgm/v1"
schemes: schemes:
- https - https
...@@ -30,53 +30,8 @@ paths: ...@@ -30,53 +30,8 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/api-versions': '/api-versions':
get: $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
############################################################################### ###############################################################################
# VNF Packages # # VNF Packages #
############################################################################### ###############################################################################
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
endpoints:
api-versions:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
responses:
200:
description: >
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
\ No newline at end of file
...@@ -61,6 +61,10 @@ responses: ...@@ -61,6 +61,10 @@ responses:
400: 400:
description: > description: >
BAD REQUEST BAD REQUEST
400 code can be returned in the following specified cases, the specific cause has to be proper specified in the
"ProblemDetails" structure to be returned.
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
query parameters or the payload body contains a syntactically incorrect data structure), query parameters or the payload body contains a syntactically incorrect data structure),
the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment