SOL003_114/SOL003_115: PM Jobs POST and GET description fields updated (c47c0e29) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+47 −26

Original line number	Diff line number	Diff line
		@@ -25,8 +25,8 @@ info:
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

		externalDocs:
		description: ETSI GS NFV-SOL 003 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
		description: ETSI GS NFV-SOL 003 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf

		basePath: "/vnfpm/v1"

		@@ -52,10 +52,12 @@ paths:
		#SOL003 location: 6.4.2
		post:
		description: >
		Create PM Job


		Create PM Job.
		The POST method creates a PM job.
		This method shall follow the provisions specified in the tables 6.4.2.3.1-1 and 6.4.2.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 PM job" resource as defined
		in clause 6.4.3 shall have been created.
		parameters:
		- name: CreatePmJobRequest
		description: The VNF creation parameters
		@@ -95,10 +97,11 @@ paths:
		description: >
		201 CREATED

		The PM job was created successfully. The response body shall
		contain a representation of the created PM job resource.
		The HTTP response shall include a "Location" HTTP header that
		points to the created PM job resource.
		Shall be returned when the PM job has been created successfully.
		The response body shall contain a representation of the created "Individual PM job" resource,
		as defined in clause 6.5.2.7.
		The HTTP response shall include a "Location" HTTP header that points to the created
		"Individual PM job" resource.
		headers:
		Location:
		description: The resource URI of the created PM Job
		@@ -126,19 +129,27 @@ paths:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

		get:
		description: >
		Query PM Job


		Query PM Job.
		The client can use this method to retrieve information about PM jobs.
		This method shall follow the provisions specified in the tables 6.4.2.3.2-1 and 6.4.2.3.2-2
		for URI query parameters, request and response data structures, and response codes.
		The client can use this method to retrieve information about PM jobs.
		parameters:
		- name: Accept
		@@ -157,7 +168,7 @@ paths:
		type: string
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 4.3.2.
		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 PmJob and in data
		@@ -169,31 +180,31 @@ paths:
		- name: all_fields
		description: >
		Include all complex attributes in the response.
		See clause 4.3.3 for details. The VNFM shall support this parameter.
		See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
		in: query
		required: false
		type: string
		- name: fields
		description: >
		Complex attributes to be included into the response.
		See clause 4.3.3 for details. The VNFM should support this parameter.
		See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
		in: query
		required: false
		type: string
		- name: exclude_fields
		description: >
		Complex attributes to be excluded from the response.
		See clause 4.3.3 for details. The VNFM should support this parameter.
		See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
		in: query
		required: false
		type: string
		- name: exclude_default
		description: >
		Indicates to exclude the following complex attributes from the response.
		See clause 4.3.3 for details. The VNFM shall support this parameter.
		See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
		The following attributes shall be excluded from the PmJob structure
		in the response body if this parameter is provided, or none of the parameters
		"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
		"all_fields", "fields", "exclude_fields", "exclude_default" are provided:
		- Reports
		in: query
		required: false
		@@ -201,7 +212,7 @@ paths:
		- 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 4.7.2.1
		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
		@@ -217,13 +228,16 @@ paths:
		description: >
		200 OK

		Information about zero or more PM jobs was queried successfully.
		The response body shall contain in an array representations of
		zero or more PM jobs, as defined in clause 6.5.2.7.
		If the VNFM 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.
		Shall be returned when information about zero or more PM jobs has been queried successfully.
		The response body shall contain in an array the representations of zero or more PM jobs,
		as defined in clause 6.5.2.7.
		If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
		(if supported) or "exclude_default" URI parameters was supplied in the request, the data in the
		response body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2
		of ETSI GS NFV-SOL 013, respectively.
		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: >
		@@ -262,14 +276,21 @@ paths:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

		###############################################################################
		# Individual PM job #
		###############################################################################