updated usage of common parameters data types (1fc8f313) · Commits · NFV - Network Functions Virtualisation / SOL009

src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml

+26 −230

Original line number	Diff line number	Diff line
		@@ -30,51 +30,11 @@ paths:
		in the tables 7.5.3.3.2-1 and 7.5.3.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
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013. The NFV-MANO functional entity shall support
		receiving this parameter as part of the URI query string. The API
		consumer may supply this parameter. The following attribute names
		shall be supported by the NFV-MANO functional entity in the
		attribute-based filtering expression: id, managedObjectId,
		eventType, perceivedSeverity, probableCause.
		in: query
		required: false
		schema:
		type: string
		- name: nextpage_opaque_marker
		description: >
		Marker to obtain the next page of a paged resource. Shall be
		supported by the NFV-MANO functional entity if the entity supports
		alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS
		NFV-SOL 013 for this resource.
		in: query
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
		responses:
		"200":
		description: >
		@@ -157,35 +117,9 @@ paths:
		7.5.4.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
		schema:
		type: string
		- name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"200":
		description: >
		@@ -233,38 +167,10 @@ paths:
		7.5.4.3.4-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
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: >
		The Content-Type header shall be set to
		"application/merge-patch+json" according to IETF RFC 7396.
		in: header
		required: true
		schema:
		type: string
		enum:
		- application/merge-patch+json
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
		requestBody:
		content:
		application/json:
		@@ -350,35 +256,10 @@ paths:
		referencing the existing "Individual subscription" resource with the
		same filter and callbackUri).
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response. Reference: IETF
		RFC 7231
		in: header
		required: true
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
		requestBody:
		content:
		application/json:
		@@ -457,58 +338,11 @@ paths:
		shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.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
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013. The NFV-MANO functional entity shall support
		receiving this parameter as part of the URI query string. The API
		consumer may supply this parameter. All attribute names that appear
		in the FmSubscription and in data types referenced from it shall be
		supported by the NFV-MANO functional entity in the filter
		expression.
		in: query
		required: false
		schema:
		type: string
		- name: nextpage_opaque_marker
		description: >
		Marker to obtain the next page of a paged response. Shall be
		supported by the NFV-MANO functional entity if the entity supports
		alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS
		NFV-SOL 013 for this resource.
		in: query
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
		responses:
		"200":
		description: >
		@@ -600,35 +434,9 @@ paths:
		specified in the tables 7.5.6.3.2-1 and 7.5.6.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
		schema:
		type: string
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"200":
		description: >
		@@ -698,20 +506,8 @@ paths:
		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
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"204":
		description: >

src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml

+19 −112

Original line number	Diff line number	Diff line
		@@ -34,28 +34,9 @@ paths:
		7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
		response data structures, and response codes.
		parameters:
		- name: Authorization
		description: >
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: >
		The Content-Type header shall be set to
		"application/merge-patch+json" according to IETF RFC 7396.
		in: header
		required: true
		schema:
		type: string
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		requestBody:
		content:
		application/json:
		@@ -109,20 +90,8 @@ paths:
		7.5.7.3.2-2 for URI query parameters, request and response data
		structures, and response codes.
		parameters:
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"204":
		description: >
		@@ -171,28 +140,9 @@ paths:
		7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
		response data structures, and response codes.
		parameters:
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: >
		The Content-Type header shall be set to
		"application/merge-patch+json" according to IETF RFC 7396.
		in: header
		required: true
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		requestBody:
		content:
		application/json:
		@@ -246,20 +196,8 @@ paths:
		7.5.7.3.2-2 for URI query parameters, request and response data
		structures, and response codes.
		parameters:
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"204":
		description: >
		@@ -308,28 +246,9 @@ paths:
		7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and
		response data structures, and response codes.
		parameters:
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Content-Type
		description: >
		The Content-Type header shall be set to
		"application/merge-patch+json" according to IETF RFC 7396.
		in: header
		required: true
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		requestBody:
		content:
		application/json:
		@@ -384,20 +303,8 @@ paths:
		7.5.7.3.2-2 for URI query parameters, request and response data
		structures, and response codes.
		parameters:
		- name: Authorization
		description: \|
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string
		- name: Version
		description: \|
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		schema:
		type: string
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"204":
		description: >
		@@ -406,7 +313,7 @@ paths:
		Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty.
		headers:
		WWW-Authenticate:
		description: >
		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.
		@@ -415,7 +322,7 @@ paths:
		minimum: 0
		maximum: 1
		Version:
		description: \|
		description: >-
		Version of the API used in the response.
		schema:
		type: string

src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml

+39 −121

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml

+5 −32

Original line number	Diff line number	Diff line
		@@ -39,9 +39,8 @@ paths:
		This method shall follow the provisions specified in the tables 8.5.9.3.1-1 and 8.5.9.3.1-2 for URI query
		parameters, request and response data structures, and response codes.
		parameters:
		- $ref: "#/components/parameters/Version"
		- $ref: "#/components/parameters/Accept"
		- $ref: "#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		requestBody:
		$ref: "#/components/requestBodies/LogReportAvailableNotification"
		responses:
		@@ -75,9 +74,9 @@ paths:
		This method shall follow the provisions specified in the tables 8.5.9.3.2-1 and 8.5.9.3.2-2 for URI
		query parameters, request and response data structures, and response codes.
		parameters:
		- $ref: "#/components/parameters/Version"
		- $ref: "#/components/parameters/Accept"
		- $ref: "#/components/parameters/Authorization"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
		- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
		responses:
		"204":
		$ref: '#/components/responses/LogReportNotification.Get'
		@@ -103,32 +102,6 @@ paths:
		$ref: '../components/SOL009_resp.yaml#/components/responses/504'

		components:
		parameters:
		Version:
		name: Version
		description: >-
		Version of the API requested to use when responding to this request
		in: header
		required: true
		schema:
		type: string
		Accept:
		name: Accept
		description: >-
		Content-Types that are acceptable for the response. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string
		Authorization:
		name: Authorization
		description: >-
		The authorization token for the request. Reference: IETF RFC 7235
		in: header
		required: false
		schema:
		type: string

		requestBodies:
		LogReportAvailableNotification:
		description: >-

src/SOL009/components/SOL009_params.yaml

+34 −0

Original line number	Diff line number	Diff line
		@@ -27,6 +27,30 @@ components:
		schema:
		type: string

		ContentType:
		- name: Content-Type
		description: \|
		The MIME type of the body of the request. Reference: IETF RFC 7231
		in: header
		required: true
		schema:
		type: string

		filter:
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013. The NFV-MANO functional entity shall support
		receiving this parameter as part of the URI query string. The API
		consumer may supply this parameter. All attribute names that appear
		in the FmSubscription and in data types referenced from it shall be
		supported by the NFV-MANO functional entity in the filter
		expression.
		in: query
		required: false
		schema:
		type: string

		all_fields:
		name: all_fields
		description: >
		@@ -60,6 +84,16 @@ components:
		schema:
		type: string

		exclude_default:
		name: exclude_default
		in: query
		description: >-
		Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
		for details. The NFV-MANO functional entity shall support this parameter.
		required: false
		schema:
		type: string

		nextpage_opaque_marker:
		name: nextpage_opaque_marker
		description: >