Newer
Older
moscatelli
committed
Shall be returned when the list of subscriptions has
been queried successfully.
The response body shall contain the representations of
all active subscriptions of the functional block that
invokes the method, as defined in clause 7.5.2.3.
If the "filter" URI parameter was supplied in the request,
the data in the response body shall have been transformed
according to the rules specified in clause 5.2.2 of
ETSI GS NFV-SOL 013.
If the NFVO supports alternative 2 (paging) according to
clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall
follow the provisions in clause 5.4.2.3 of
ETSI GS NFV SOL 013.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
type: array
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.8
parameters:
- name: subscriptionId
description: >
Identifier of the subscription.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the
payload body of that response.
rameshnaraya
committed
in: path
type: string
required: true
moscatelli
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
rameshnaraya
committed
description: >
The client can use this method for reading an individual subscription about Performance management notifications
subscribed by the client.
This method shall follow the provisions specified in the Tables 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
moscatelli
committed
Shall be returned when the subscription has been read successfully.
The response body shall contain a representation of
the subscription resource, as defined in clause 7.5.2.3.
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
rameshnaraya
committed
headers:
Content-Type:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
delete:
moscatelli
committed
summary: Terminate a subscription.
rameshnaraya
committed
description: >
This method terminates an individual subscription.
This method shall follow the provisions specified in the
Tables 7.4.8.3.5-1 and 7.4.8.3.5-2 for URI query parameters,
Samir Medjiah
committed
request and response data structures, and response codes.
As the result of successfully executing this method, the
"Individual subscription" resource shall not exist any longer.
This means that no notifications for that subscription shall
be sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be
received by the formerly-subscribed API consumer for a
certain time period after the deletion.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
rameshnaraya
committed
in: header
required: true
type: string
responses:
204:
moscatelli
committed
description: >
moscatelli
committed
204 NO CONTENT
moscatelli
committed
Samir Medjiah
committed
Shall be returned when the subscription resource has been
deleted successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"