Skip to content
GitLab
Commit 55384c3f authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

fixed responses ref names

parent 11100b07
Pipeline #7634 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ 55384c3f
......@@ -52,7 +52,7 @@ paths:
$ref: '#/components/requestBodies/CreatePmJobRequest'
responses:
201:
$ref: '#/components/responses/PMJobs.Post.201'
$ref: '#/components/responses/PmJobs.Post.201'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -86,7 +86,7 @@ paths:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
$ref: '#/components/responses/PMJobs.Get.200'
$ref: '#/components/responses/PmJobs.Get.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -124,7 +124,7 @@ paths:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
responses:
200:
$ref: '#/components/responses/IndividualPMJob.Get.200'
$ref: '#/components/responses/IndividualPmJob.Get.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -151,7 +151,7 @@ paths:
This method allows to modify an "Individual PM job" resource. See clause 6.4.3.3.4.
responses:
200:
$ref: '#/components/responses/IndividualPMJob.Patch.200'
$ref: '#/components/responses/IndividualPmJob.Patch.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -180,7 +180,7 @@ paths:
This method terminates an individual PM job. See clause 6.4.3.3.5.
responses:
204:
$ref: '#/components/responses/IndividualPMJob.Delete.200'
$ref: '#/components/responses/IndividualPmJob.Delete.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
......@@ -405,403 +405,6 @@ paths:
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
# ##############################################################################
# # Subscriptions #
# ##############################################################################
# '/subscriptions':
# #SOL003 location: 6.4.7
# post:
# description: |
# Subscribe.
# The POST method creates a new subscription.
# This method shall follow the provisions specified in the tables 6.4.7.3.1-1 and 6.4.7.3.1-2
# for URI query parameters, request and response data structures, and response codes.
# As the result of successfully executing this method, a new "Individual subscription" resource
# as defined in clause 6.4.8 shall have been created. This method shall not trigger any notification.
# Creation of two "Individual subscription" resources with the same callbackURI and the same filter
# can result in performance degradation and will provide duplicates of notifications to the NFVO,
# and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
# a new "Individual subscription" resource if another "Individual subscription" resource with the same
# filter and callbackUri already exists (in which case it shall return the "201 Created" response code),
# or may decide to not create a duplicate "Individual subscription" resource (in which case it shall
# return a "303 See Other" response code referencing the existing "Individual subscription" resource
# with the same filter and callbackUri).
# parameters:
# - name: PmSubscriptionRequest
# description: |
# Details of the subscription to be created.
# in: body
# required: true
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
# - name: Accept
# description: |
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Authorization
# description: |
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# 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: Version
# description: |
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
# 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 6.5.2.3.
# The HTTP response shall include a "Location" HTTP header that contains the
# resource URI of the created "Individual subscription" resource.
# headers:
# Location:
# description: The resource URI of the created VNF instance
# type: string
# format: url
# Content-Type:
# description: |
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
# 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.
# type: string
# maximum: 1
# minimum: 0
# Version:
# description: |
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 303:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
#
# get:
# description: |
# Query Subscription Information.
# TThe client can use this method to query the list of active subscriptions
# to Performance management notifications subscribed by the client.
# This method shall follow the provisions specified in the tables 6.4.7.3.2-1 and 6.4.7.3.2-2
# for URI query parameters, request and response data structures, and response codes.
# parameters:
# - name: Accept
# description: |
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Authorization
# description: |
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# type: string
# - name: filter
# description: |
# Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
# The VNFM shall support receiving this parameter as part of the
# URI query string. The NFVO may supply this parameter.
# All attribute names that appear in the PmSubscription and in
# data types referenced from it shall be supported by the VNFM
# in the filter expression.
# in: query
# required: false
# type: string
# - name: nextpage_opaque_marker
# description: |
# Marker to obtain the next page of a paged response. Shall be
# supported by the VNFM if the VNFM supports alternative 2 (paging)
# according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
# in: query
# 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
# responses:
# 200:
# description: |
# 200 OK
#
# 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
# PM subscriptions as defined in clause 6.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 VNFM 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.
# headers:
# Content-Type:
# description: |
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
# 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.
# type: string
# maximum: 1
# 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
# schema:
# type: array
# items:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
#
# ###############################################################################
# # Individual subscription #
# ###############################################################################
# '/subscriptions/{subscriptionId}':
# #SOL003 location: 6.4.8
# parameters:
# - name: subscriptionId
# description: |
# This identifier can be retrieved from the resource referenced by the
# "Location" HTTP header in the response to a POST request creating a
# new "Individual subscription" resource. It can also be retrieved from the "id"
# attribute in the payload body of that response.
# in: path
# type: string
# required: true
# get:
# description: |
# Query Subscription Information.
# 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 6.4.8.3.2-1 and 6.4.8.3.2-2
# for URI query parameters, request and response data structures, and response codes.
# parameters:
# - name: Accept
# description: |
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - 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
# responses:
# 200:
# description: |
# 200 OK
#
# Shall be returned when the subscription has been read successfully.
# The response body shall contain a representation of the "Individual subscription" resource,
# as defined in clause 6.5.2.3.
# headers:
# Content-Type:
# description: |
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
# 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.
# type: string
# maximum: 1
# minimum: 0
# Version:
# description: |
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
#
# delete:
# description: |
# Terminate Subscription.
# This method terminates an individual subscription.
# This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2
# for URI query parameters, 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.
# 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
# responses:
# 204:
# description: |
# 204 NO CONTENT
#
# Shall be returned when the "Individual subscription" resource has been deleted successfully.
# The response body shall be empty.
# headers:
# WWW-Authenticate:
# 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.
# type: string
# maximum: 1
# minimum: 0
# Version:
# description: |
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
components:
parameters:
PmJobId:
......@@ -863,7 +466,7 @@ components:
required: true
responses:
PMJobs.Post.201:
PmJobs.Post.201:
description: |
201 CREATED
......@@ -899,7 +502,7 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
PMJobs.Get.200:
PmJobs.Get.200:
description: |
200 OK
......@@ -949,7 +552,7 @@ components:
items:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
IndividualPMJob.Get.200:
IndividualPmJob.Get.200:
description: |
200 OK
......@@ -983,7 +586,7 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
IndividualPMJob.Patch.200:
IndividualPmJob.Patch.200:
description: |
200 OK
......@@ -1016,7 +619,7 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications"
IndividualPMJob.Delete.200:
IndividualPmJob.Delete.200:
description: |
204 NO CONTENT
......
src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml
View file @ 55384c3f
......@@ -196,7 +196,6 @@ components:
type: string
requestBodies:
VrQuotaAvailSubscriptionRequest:
description: |
Details of the subscription to be created.
......
src/endpoints/SOL002SOL003_endpoints.yaml
View file @ 55384c3f
......@@ -10,7 +10,7 @@ endpoints:
for request and response data structures, and response codes. URI query parameters are not supported.
responses:
"200":
$ref: '#/components/responses/ApiVersions.Get'
$ref: '#/components/responses/ApiVersions.Get.200'
"400":
$ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/400
"401":
......@@ -68,7 +68,7 @@ endpoints:
components:
responses:
ApiVersions.Get:
ApiVersions.Get.200:
description: >
API version information was read successfully.
The response body shall contain API version
......
Supports Markdown
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