Commit 1e7f3d52 authored by Michele Carignani's avatar Michele Carignani
Browse files

Aligned SOL 002 interfaces with look and feel of SOL003,


fixed errors in the headers:
- Bug 40
- Bug 25
- Bug 35

Patch set 2 reinstates the labels or status code

Change-Id: I28fc57587f828f3b3ed05d6e7a6dc77639a36abe
Signed-off-by: Michele Carignani's avatarMichele Carignani <michele.carignani@etsi.org>
parent 90a35965
......@@ -34,8 +34,11 @@ produces:
paths:
###############################################################################
# Configuration #
###############################################################################
/configuration:
#SOL002 location: 9.4.2
get:
summary: Read VNF/VNFC configuration from VNF.
description: >
......
......@@ -93,9 +93,11 @@ definitions:
description: >
Identifier of a VNFC instance to which this set of configuration data applies.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
extCpConfig:
intCpConfig:
description: >
Configuration parameters for the external CPs of the VNFC instance.
Configuration parameters for the internal CPs of the VNFC instance.
type: array
items:
$ref: '#/definitions/CpConfiguration'
dhcpServer:
description: >
......
......@@ -2,10 +2,9 @@ swagger: "2.0"
info:
version: "1.1.1"
title: SOL002 - VNF Configuration interface
title: DRAFT - SOL002 - VNF Fault Management interface
description: >
VNF Configuration interface of ETSI NFV SOL002
DRAFT VNF Fault Management interface of ETSI NFV SOL002
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
......@@ -22,7 +21,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: /vnfconfig/v1
basePath: /vnffm/v1
schemes:
- http
......@@ -40,7 +39,7 @@ paths:
# Alarms #
###############################################################################
'/alarms':
#SOL003 location: 7.4.2
#SOL002 location: 7.4.2
get:
description: >
The client can use this method to retrieve information about the alarm
......@@ -70,8 +69,6 @@ paths:
responses:
200:
description: >
OK
The request has succeeded.
The response body shall contain the list of related alarms.
headers:
......@@ -110,7 +107,7 @@ paths:
# Individual alarm #
###############################################################################
'/alarms/{alarmId}':
#SOL003 location: 7.4.3
#SOL002 location: 7.4.3
parameters:
- name: alarmId
description: >
......@@ -151,8 +148,6 @@ paths:
responses:
200:
description: >
OK
Information about an individual alarm was read successfully.
The response body shall contain a representation of the individual
alarm.
......@@ -193,7 +188,7 @@ paths:
This method modifies an individual alarm resource.
parameters:
- name: AlarmModifications
description: The VNF creation parameters
description: The parameter for the alarm modification
in: body
required: true
schema:
......@@ -207,8 +202,8 @@ paths:
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
The Content-Type header shall be set to "application/mergepatch+json"
Reference: IETF RFC 7396
in: header
required: true
type: string
......@@ -264,10 +259,48 @@ paths:
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Escalate Perceived Severity task #
###############################################################################
'/alarms/{alarmId}/escalate':
#SOL002 location: 7.4.4
post:
description: >
The POST method enables the consumer to escalate the perceived severity
of an alarm that is represented by an ndividual alarm resource.
parameters:
- name: PerceivedSeverityRequest
description: The proposed "escalated perceived severity" value
in: body
schema:
$ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest"
responses:
200:
description: >
OK
The VNFM has received the proposed "escalated perceived severity" value
successfully. The response body shall be empty.
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Subscriptions #
###############################################################################
'/alarms/subscriptions':
#SOL003 location: 7.4.4
#SOL002 location: 7.4.5
post:
description: >
The POST method creates a new subscription.
......@@ -331,6 +364,8 @@ paths:
minimum: 0
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
303:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -418,7 +453,7 @@ paths:
# Individual subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#SOL003 location: 7.4.5
#SOL002 location: 7.4.5
parameters:
- name: subscriptionId
description: >
......
......@@ -114,3 +114,5 @@ definitions:
# notified alarm is correlated. Shall be present if the VNF
# instance information is accessible as a resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
PerceivedSeverityRequest:
type: string
\ No newline at end of file
......@@ -3,9 +3,9 @@ swagger: "2.0"
info:
version: "1.1.1"
title: "SOL002 - VNF Indicator interface"
title: DRAFT - SOL002 - VNF Indicator interface
description: >
VNF Indicator interface of ETSI NFV SOL002.
DRAFT VNF Indicator interface of ETSI NFV SOL002.
This API allows the EM/VNF to provide information on value changes of VNF related indicators.
VNF related indicators are declared in the VNFD.
......@@ -40,11 +40,13 @@ produces:
paths:
###############################################################################
# VNF Indicators #
###############################################################################
/indicators:
get:
summary: Query multiple indicators
description: Get a list of indicators. Support of attribute based filtering via query parameters.
description: The GET method queries multiple VNF indicators.
# parameters:
# - name: id.eq
# in: query
......@@ -237,9 +239,10 @@ paths:
type: string
required: true
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
summary: Read an inidividual VNF indicator.
description: >
Read an individual VNF indicator related to a specific VNF instance.
The GET method reads an individual VNF indicator.
NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a
POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body
of that response.
......
......@@ -36,10 +36,11 @@ produces:
paths:
###############################################################################
# Notification endpoint VnfIndicatorValueChangeNotification #
###############################################################################
/notificationendpoint:
#SOL002 location: 8.4.7
post:
summary: Notification endpoint
description: >
......@@ -58,8 +59,6 @@ paths:
responses:
204:
description: >
No Content
The notification was delivered successfully. The response body shall be empty.
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
......@@ -75,8 +74,6 @@ paths:
get:
summary: Test notification endpoint.
description: >
Service Unavailable
The GET method allows the server to test the notification endpoint that is provided
by the client, e.g. during subscription.
responses:
......
......@@ -2,10 +2,9 @@ swagger: "2.0"
info:
version: "1.1.1"
title: "SOL002 - VNF Configuration interface"
title: "DRAFT - SOL002 - VNF Performance Management interface"
description: >
VNF Configuration interface of ETSI NFV SOL002
DRAFT - SOL002 - VNF Performance Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
......@@ -22,7 +21,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: /vnfconfig/v1
basePath: /vnfpm/v1
schemes:
- http
......@@ -34,13 +33,12 @@ consumes:
produces:
- application/json
paths:
###############################################################################
# PM jobs #
###############################################################################
'/pm_jobs':
#SOL003 location: 6.4.2
#SOL002 location: 6.4.2
post:
description: >
The POST method creates a PM job.
......@@ -75,8 +73,6 @@ paths:
responses:
201:
description: >
Created
The PM job was created successfully. The response body shall
contain a representation of the created PM job resource.
The HTTP response shall include a "Location" HTTP header that
......@@ -138,8 +134,6 @@ paths:
responses:
200:
description: >
OK
Information about zero or more PM jobs was queried successfully.
The response body shall contain representations of zero or more PM
jobs.
......@@ -174,7 +168,7 @@ paths:
# Individual PM job #
###############################################################################
'/pm_jobs/{pmJobId}':
#SOL003 location: 6.4.3
#SOL002 location: 6.4.3
parameters:
- name: pmJobId
description: >
......@@ -207,8 +201,6 @@ paths:
responses:
200:
description: >
OK
Information about an individual PM job was queried successfully.
The response body shall contain a representation of the PM job
resource.
......@@ -251,8 +243,6 @@ paths:
responses:
204:
description: >
No Content
The PM job was deleted successfully.
The response body shall be empty.
headers:
......@@ -282,7 +272,7 @@ paths:
# Individual performance report #
###############################################################################
'/pm_jobs/{pmJobId}/reports/{reportId}':
#SOL003 location: 6.4.4
#SOL002 location: 6.4.4
parameters:
- name: pmJobId
description: >
......@@ -318,8 +308,6 @@ paths:
responses:
200:
description: >
OK
Information of an individual performance report was read
successfully.
The response body shall contain a representation of the
......@@ -353,7 +341,7 @@ paths:
# Thresholds #
###############################################################################
'/thresholds':
#SOL003 location: 6.4.5
#SOL002 location: 6.4.5
post:
description: >
The POST method can be used by the client to create a threshold.
......@@ -445,8 +433,6 @@ paths:
responses:
200:
description: >
OK
Information about zero or more thresholds was queried
successfully.
The response body shall contain representations of zero
......@@ -486,7 +472,7 @@ paths:
# Individual threshold #
###############################################################################
'/thresholds/{thresholdId}':
#SOL003 location: 6.4.6
#SOL002 location: 6.4.6
parameters:
- name: thresholdId
description: >
......@@ -519,8 +505,6 @@ paths:
responses:
200:
description: >
OK
Information about an individual threshold was queried
successfully. The response body shall contain a
representation of the threshold.
......@@ -601,7 +585,7 @@ paths:
# Subscriptions #
###############################################################################
'/subscriptions':
#SOL003 location: 6.4.7
#SOL002 location: 6.4.7
post:
description: >
The POST method creates a new subscription.
......@@ -637,8 +621,6 @@ paths:
responses:
201:
description: >
Created
The subscription was created successfully. A representation of the
created subscription resource shall be returned in the response
body.
......@@ -696,8 +678,6 @@ paths:
responses:
200:
description: >
OK
The list of subscriptions was queried successfully.
The response body shall contain the representations of all active
subscriptions of the functional block that invokes the method.
......@@ -739,7 +719,7 @@ paths:
# Individual subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#SOL003 location: 6.4.8
#SOL002 location: 6.4.8
parameters:
- name: subscriptionId
description: >
......@@ -772,8 +752,6 @@ paths:
responses:
200:
description: >
OK
The subscription was read successfully. The response body shall
contain a representation of the subscription resource.
headers:
......@@ -829,8 +807,6 @@ paths:
responses:
204:
description: >
No Content
The subscription resource was deleted successfully.
The response body shall be empty.
headers:
......
......@@ -66,11 +66,17 @@ responses:
response code. The "ProblemDetails" structure shall be provided,
and should include in the "detail" attribute more information about
the source of the problem.
---
If the request contains a malformed access token, the API producer
should respond with this response. The details of the error shall
be returned in the WWW-Authenticate HTTP header, as defined in
IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
provided.
---
If there is an application error related to the client's input that
cannot be easily mapped to any other HTTP response code ("catch all
error"), the API producer shall respond with this response code.The
......
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