Newer
Older
moscatelli
committed
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
The subscription was 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,
request and response data structures, and response codes
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
rameshnaraya
committed
The subscription resource was deleted successfully.
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"