Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
and the "Content-Type" HTTP header shall be set to "text/plain".
If the "include_signatures" URI query parameter was present in the
related request and the manifest file does not have all the
security-related information embedded (i.e. there is a separate certificate file),
the "Content-Type" HTTP header shall be set to "application/zip" and
the payload body shall contain a ZIP archive which includes:
- a copy of the manifest file of the PNFD archive;
- a copy of the related individual certificate file.
headers:
Content-Type:
type: string
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.
enum:
- text/plain
- application/zip
WWW-Authenticate:
type: string
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
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
summary: Subscribe to NSD and PNFD change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and
response data structures, and response codes, as specified in
the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2.
Creation of two subscription resources with the same callback URI
and the same filter can result in performance degradation and will
provide duplicates of notifications to the OSS, and might make
sense only in very rare use cases. Consequently, the NFVO may
either allow creating a subscription resource if another subscription
resource with the same filter and callback URI already exists (in which
case it shall return the "201 Created" response code), or may decide to
not create a duplicate subscription resource (in which case it shall
return a "303 See Other" response code referencing the existing
subscription resource with the same filter and callbackUricallback URI).
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: NsdmSubscriptionRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 5.5.2.7.
responses:
201:
description: >
201 CREATED
Shall be returned when the subscription has been created successfully.
A representation of the created "Individual subscription" resource shall
be returned in the response body, as defined in clause 5.5.2.8.
The HTTP response shall include a "Location:" HTTP header that points
to the created "Individual subscription" resource.
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
headers:
Content-Type:
type: string
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.
WWW-Authenticate:
type: string
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
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
303:
# description: >
# 303 SEE OTHER
#
# Shall be returned when a subscription with the
# same callbackURI and the same filter already
# exits and the policy of the NFVO is to not create
# redundant subscriptions.
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/303"
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/422"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
summary: Query multiple subscriptions.
moscatelli
committed
description: >
TThe GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g.
for resynchronization after error situations.
This method shall support the URI query parameters, request and
response data structures, and response codes, as specified in
the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2.
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
AAttribute filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string.
the OSS/BSS may supply this parameter.
All attribute names that appear in the NsdmSubscription and in data types referenced
from it shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: nextpage_opaque_marker
in: query
required: false
type: string
description: >
Marker to obtain the next page of a paged response. Shall be supported by
the NFVO if the NFVO supports alternative 2 (paging) according to clause
5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
in: header
required: true
type: string
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active
subscriptions of the functional block that invokes the method, i.e. zero or more
representations of NSD management subscriptions as defined in clause 5.5.2.8.
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
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
rameshnaraya
committed
maximum: 1
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
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:
description: >
The list of subscriptions was queried successfully.
The response body shall contain in an array the representations of all active subscriptions
of the functional block that invokes the method, i.e., zero or more representations of NSD management
subscriptions as defined in clause 5.5.2.8.
If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
moscatelli
committed
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual Subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9
parameters:
moscatelli
committed
- name: subscriptionId
description: >
Identifier of this 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.
moscatelli
committed
in: path
moscatelli
committed
type: string
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request. Details are specified
in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
summary: Read an individual subscription resource.
description: >
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
moscatelli
committed
The GET method retrieves information about a subscription by reading
an individual subscription resource.
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
parameters:
moscatelli
committed
- name: Accept
in: header
required: true
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
Shall be returned when information about an individual subscription has been read successfully.
The response body shall contain a representation of the subscription resource.
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
headers:
Content-Type:
moscatelli
committed
type: string
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.
WWW-Authenticate:
moscatelli
committed
type: string
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
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
summary: Terminate Subscription
description: >
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
moscatelli
committed
The DELETE method terminates an individual subscription.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.9.3.3-2.
moscatelli
committed
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request.
Details are specified in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
Shall be returned when the "Individual subscription" resource
has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"