Loading src/SOL023/CertificateManagement/CertificateManagement.yaml +34 −32 Original line number Diff line number Diff line Loading @@ -160,7 +160,6 @@ paths: "503": $ref: ../responses/SOL023_resp.yaml#/responses/503 ####################################################################### ###################### Subscription Endpoints ######################## ####################################################################### Loading Loading @@ -296,9 +295,9 @@ components: filter_subject_instances: name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013 [4]. The CMF shall support receiving this parameter as part of the URI query string. The VNFM may supply this parameter. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The CMF shall support receiving this parameter as part of the URI query string. The VNFM may supply this parameter. All attribute names that appear in the SubjectInstance and in data types referenced from it shall be supported by the CMF in the filter expression. in: query Loading @@ -310,10 +309,10 @@ components: 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 CMF shall support this parameter. The following attributes shall be excluded from the SubjectInstance structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The CMF shall support this parameter. The following attributes shall be excluded from the SubjectInstance structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - subjectId required: false Loading @@ -335,8 +334,9 @@ components: schema: type: string ############################# For Subscriptions Resources ############################# ####################################################################### ################# Parameters for Subscriptions Resources ############## ####################################################################### filter_subscriptions: name: filter Loading Loading @@ -374,14 +374,13 @@ components: description: > 201 CREATED Shall be returned when a new "Individual Subject instance" resource and the associated Subject instance identifier has been created successfully. Shall be returned when a new "Individual Subject instance" resource and the associated Subject instance identifier has been created successfully. The response body shall contain a representation of the created Subject instance, as defined in clause 5.6.3.4. The response body shall contain a representation of the created Subject instance, as defined in clause 5.6.2.2. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created Subject instance. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created Subject instance. headers: Location: description: | Loading Loading @@ -464,16 +463,16 @@ components: Shall be returned when information about zero or more subject instances has been queried successfully. The response body shall contain in an array the representations of zero or more subject instances, as defined in clause 5.6.3.4. defined in clause 5.6.b.2.2. 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. 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 CMF 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. If the CMF 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: Location: description: | Loading Loading @@ -521,7 +520,8 @@ components: 200 OK Shall be returned when information about an individual Subject instance has been read successfully. The response body shall contain a representation of the Subject instance, as defined in clause 5.6.2.2. The response body shall contain a representation of the Subject instance, as defined in clause 5.6.4.2.2. headers: WWW-Authenticate: description: | Loading Loading @@ -551,8 +551,9 @@ components: description: | 204 NO CONTENT Shall be returned when the "Individual Subject instance" resource and the associated Subject identifier were deleted successfully. Shall be returned when the "Individual Subject instance" resource and the associated Subject identifier were deleted successfully. The response body shall be empty. headers: WWW-Authenticate: Loading @@ -574,9 +575,12 @@ components: description: | 409 CONFLICT Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state. Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that not all certificates under the “Individual Subject instance” are either expired or have been revoked. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Loading Loading @@ -606,7 +610,6 @@ components: schema: $ref: "../definitions/SOL023_def.yaml#/definitions/ProblemDetails" ####################################################################### ################# Subscription Endpoints Response Bodies ############## ####################################################################### Loading Loading @@ -865,14 +868,13 @@ components: requestBodies: RegistrationRequest: description: > Subject resource creation request. Subject resource creation request. Defined in clause 5.6.4.2.3. content: application/json: schema: $ref: "./definitions/SOL023CertificateManagement_def.yaml#/definitions/RegistrationRequest" required: true ####################################################################### ################# Subscription Endpoints Request Bodies ############### ####################################################################### Loading Loading
src/SOL023/CertificateManagement/CertificateManagement.yaml +34 −32 Original line number Diff line number Diff line Loading @@ -160,7 +160,6 @@ paths: "503": $ref: ../responses/SOL023_resp.yaml#/responses/503 ####################################################################### ###################### Subscription Endpoints ######################## ####################################################################### Loading Loading @@ -296,9 +295,9 @@ components: filter_subject_instances: name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013 [4]. The CMF shall support receiving this parameter as part of the URI query string. The VNFM may supply this parameter. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The CMF shall support receiving this parameter as part of the URI query string. The VNFM may supply this parameter. All attribute names that appear in the SubjectInstance and in data types referenced from it shall be supported by the CMF in the filter expression. in: query Loading @@ -310,10 +309,10 @@ components: 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 CMF shall support this parameter. The following attributes shall be excluded from the SubjectInstance structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The CMF shall support this parameter. The following attributes shall be excluded from the SubjectInstance structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - subjectId required: false Loading @@ -335,8 +334,9 @@ components: schema: type: string ############################# For Subscriptions Resources ############################# ####################################################################### ################# Parameters for Subscriptions Resources ############## ####################################################################### filter_subscriptions: name: filter Loading Loading @@ -374,14 +374,13 @@ components: description: > 201 CREATED Shall be returned when a new "Individual Subject instance" resource and the associated Subject instance identifier has been created successfully. Shall be returned when a new "Individual Subject instance" resource and the associated Subject instance identifier has been created successfully. The response body shall contain a representation of the created Subject instance, as defined in clause 5.6.3.4. The response body shall contain a representation of the created Subject instance, as defined in clause 5.6.2.2. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created Subject instance. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created Subject instance. headers: Location: description: | Loading Loading @@ -464,16 +463,16 @@ components: Shall be returned when information about zero or more subject instances has been queried successfully. The response body shall contain in an array the representations of zero or more subject instances, as defined in clause 5.6.3.4. defined in clause 5.6.b.2.2. 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. 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 CMF 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. If the CMF 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: Location: description: | Loading Loading @@ -521,7 +520,8 @@ components: 200 OK Shall be returned when information about an individual Subject instance has been read successfully. The response body shall contain a representation of the Subject instance, as defined in clause 5.6.2.2. The response body shall contain a representation of the Subject instance, as defined in clause 5.6.4.2.2. headers: WWW-Authenticate: description: | Loading Loading @@ -551,8 +551,9 @@ components: description: | 204 NO CONTENT Shall be returned when the "Individual Subject instance" resource and the associated Subject identifier were deleted successfully. Shall be returned when the "Individual Subject instance" resource and the associated Subject identifier were deleted successfully. The response body shall be empty. headers: WWW-Authenticate: Loading @@ -574,9 +575,12 @@ components: description: | 409 CONFLICT Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state. Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that not all certificates under the “Individual Subject instance” are either expired or have been revoked. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Loading Loading @@ -606,7 +610,6 @@ components: schema: $ref: "../definitions/SOL023_def.yaml#/definitions/ProblemDetails" ####################################################################### ################# Subscription Endpoints Response Bodies ############## ####################################################################### Loading Loading @@ -865,14 +868,13 @@ components: requestBodies: RegistrationRequest: description: > Subject resource creation request. Subject resource creation request. Defined in clause 5.6.4.2.3. content: application/json: schema: $ref: "./definitions/SOL023CertificateManagement_def.yaml#/definitions/RegistrationRequest" required: true ####################################################################### ################# Subscription Endpoints Request Bodies ############### ####################################################################### Loading
