Commit 11542aeb authored by bernini's avatar bernini

updates related to SOL002_5 and SOL002_6

parent 724fee2d
Pipeline #736 passed with stage
in 0 seconds
......@@ -30,19 +30,19 @@ paths:
# API Versions #
###############################################################################
'/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.
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: >
......
......@@ -30,19 +30,19 @@ paths:
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
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.
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: >
......@@ -81,17 +81,17 @@ paths:
# VNF Configuration #
###############################################################################
'/configuration':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
summary: Read VNF/VNFC configuration from VNF
description: >
The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
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: >
......@@ -138,12 +138,6 @@ paths:
in: body
schema:
$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
......
......@@ -12,5 +12,10 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -40,19 +40,19 @@ paths:
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
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.
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: >
......@@ -97,7 +97,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -235,7 +235,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -384,7 +384,7 @@ paths:
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Escalate Perceived Severity task #
# Escalate Perceived Severity task #
###############################################################################
'/alarms/{alarmId}/escalate':
#SOL002 location: 7.4.4
......@@ -393,7 +393,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -456,7 +456,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -674,7 +674,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......
......@@ -27,5 +27,10 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -2,7 +2,7 @@
swagger: "2.0"
info:
version: "1.1.1"
version: "1.2.0"
title: "SOL002 - VNF Indicator interface"
description: >
VNF Indicator interface of ETSI NFV SOL002.
......@@ -23,8 +23,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
description: ETSI GS NFV-SOL 002 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
basePath: /vnfind/v1
......@@ -49,7 +49,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Retrieve API version information
......@@ -100,7 +100,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Query multiple indicators
......@@ -202,7 +202,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Query multiple indicators related to a VNF instance.
......@@ -315,7 +315,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
......@@ -368,7 +368,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
......@@ -412,7 +412,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
summary: Create a new subscription to VNF indicator change notifications
......@@ -556,7 +556,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an individual subscription.
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.2.0"
title: "SOL002 - VNF Indicator Notification Endpoint interface"
description: >
VNF Indicator Notification Endpoint interface of ETSI NFV SOL002
......@@ -22,9 +22,7 @@ externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
basePath: /callback/v1
schemes:
schemes:
- http
- https
......@@ -38,6 +36,13 @@ produces:
paths:
/notificationendpoint:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
summary: Notification endpoint
description: >
......@@ -59,6 +64,13 @@ paths:
No Content
The notification was delivered successfully. The response body shall be empty.
headers:
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......@@ -83,6 +95,12 @@ paths:
No Content
The notification endpoint was tested successfully. The response body shall be empty.
headers:
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......
......@@ -12,5 +12,10 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -29,6 +29,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
409-another-lcm-operation-ongoing:
......@@ -55,6 +60,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
409-inconsistent-state:
......@@ -78,6 +88,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
409-state-conflict-INSTANTIATED:
......@@ -104,6 +119,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
409-state-conflict-not-FAILED_TEMP:
......@@ -129,6 +149,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
409-state-conflict-NOT-INSTANTIATED:
......@@ -156,5 +181,10 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -45,7 +45,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Retrieve API version information
......@@ -97,7 +97,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -342,7 +342,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -478,7 +478,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -553,7 +553,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -765,7 +765,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -891,7 +891,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -1101,7 +1101,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......
......@@ -18,6 +18,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
202-with-Location:
description: >
Accepted
......@@ -46,6 +51,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
303:
description: >
See Other
......@@ -56,6 +66,12 @@ responses:
The HTTP response shall include a "Location" HTTP header that contains
the resource URI of the existing subscription resource.
The response body shall be empty.
headers:
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400:
description: >
Bad Request
......@@ -97,6 +113,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
400-attr-based-filtering-error:
......@@ -134,6 +155,11 @@ responses:
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
400-attr-selector:
......@@ -171,6 +197,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
401:
......@@ -198,6 +229,11 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
403:
......@@ -215,6 +251,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
404:
......@@ -234,6 +275,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
404-task-resource-not-exists:
......@@ -261,6 +307,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
404-task-resource-not-exists-VNF-LCM:
......@@ -282,6 +333,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
404-task-not-suported:
......@@ -304,6 +360,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
404-task-not-suported-VNF-LCM:
......@@ -327,6 +388,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
405:
......@@ -342,6 +408,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
406:
......@@ -358,6 +429,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
412:
......@@ -375,6 +451,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
413:
......@@ -392,6 +473,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
414:
......@@ -408,6 +494,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -424,6 +515,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
422:
......@@ -445,6 +541,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
429:
......@@ -466,6 +567,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -486,6 +592,11 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1