openapi: 3.0.2 info: title: SOL009 - NFV-MANO Log Management interface description: | SOL009 - NFV-MANO Log Management interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues contact: name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 009 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.06.01_60/gs_NFV-SOL009v030601p.pdf servers: - url: http://127.0.0.1/nfvmanologm/v1 - url: https://127.0.0.1/nfvmanologm/v1 paths: "/api_versions": $ref: '../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions' "/log_jobs": description: >- This resource represents logging jobs. The API consumer can use this resource to create and query logging jobs. post: description: >- The POST method creates a logging job. See clause 8.5.3.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" requestBody: $ref: "#/components/requestBodies/CreateLoggingJobRequest" responses: "201": $ref: '#/components/responses/LoggingJobs.Post.201' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": $ref: ../components/SOL009_resp.yaml#/components/responses/403 "404": $ref: ../components/SOL009_resp.yaml#/components/responses/404 "405": $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 "422": $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 get: description: >- The API consumer can use this method to retrieve information about logging jobs. See clause 8.5.3.3.2. parameters: - $ref: "#/components/parameters/filter.LoggingJobs" - $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields" - $ref: "../components/SOL009_params.yaml#/components/parameters/fields" - $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields" - $ref: "#/components/parameters/exclude_default.LoggingJobs" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" - $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": $ref: '#/components/responses/LoggingJobs.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": $ref: ../components/SOL009_resp.yaml#/components/responses/403 "404": $ref: ../components/SOL009_resp.yaml#/components/responses/404 "405": $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 "422": $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 "/log_jobs/{logJobId}": description: >- This resource represents an individual logging job. The API consumer can use this resource to delete and read the underlying logging job. parameters: - $ref: "#/components/parameters/logJobId" get: description: >- The API consumer can use this method for reading an individual logging job. See clause 8.5.4.3.2. parameters: - $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": $ref: '#/components/responses/IndividualLoggingJob.Get.200' "400": $ref: ../components/SOL009_resp.yaml#/components/responses/400 "401": $ref: ../components/SOL009_resp.yaml#/components/responses/401 "403": $ref: ../components/SOL009_resp.yaml#/components/responses/403 "404": $ref: ../components/SOL009_resp.yaml#/components/responses/404 "405": $ref: ../components/SOL009_resp.yaml#/components/responses/405 "406": $ref: ../components/SOL009_resp.yaml#/components/responses/406 "422": $ref: ../components/SOL009_resp.yaml#/components/responses/422 "500": $ref: ../components/SOL009_resp.yaml#/components/responses/500 "503": $ref: ../components/SOL009_resp.yaml#/components/responses/503 "504": $ref: ../components/SOL009_resp.yaml#/components/responses/504 delete: description: >- This method terminates an individual logging job. See clause 8.5.4.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": $ref: '#/components/responses/IndividualLoggingJob.Delete.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' "/log_jobs/{logJobId}/log_reports/{logReportId}": description: >- This resource represents an individual log report. The API consumer can use this resource to read information about a log report. The log report provides metadata information about a log and location information of the log file from where it can be obtained. NOTE: The present document does not specify the mechanism how to retrieve the log files. parameters: - $ref: "#/components/parameters/logJobId" - $ref: "#/components/parameters/logReportId" get: description: >- The API consumer can use this method for reading an individual log report. See clause 8.5.5.3.2. parameters: - $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": $ref: '#/components/responses/LogReport.Get.200' "202": $ref: '#/components/responses/LogReport.Get.202' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' "/log_jobs/{logJobId}/compile_log": description: >- This resource represents the "Compile log" operation. The API consumer can use this resource to request compiling the logged data, collected via a logging job, into a file and creating the associated log report. As the result of successfully processing this request, a new "Individual log report" resource shall be created. Two modes of operation, synchronous or asynchronous, can take place depending on whether the NFV-MANO functional entity can compile the log data and create the log report immediately. In the synchronous case, which is indicated by responding with "201 Created", the resource shall be created before the "201 Created" response is returned. In the asynchronous case, which is indicated by responding with "202 Accepted", the resource may be created after the response is returned. parameters: - $ref: "#/components/parameters/logJobId" post: description: >- The POST method requests to compile the logged data into a file and create an associated log report. See clause 8.5.6.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" requestBody: $ref: "#/components/requestBodies/CompileLogRequest" responses: "201": $ref: '#/components/responses/LogReportCompiled.Post.201' "202": $ref: '#/components/responses/LogReportCompiled.Post.202' "303": $ref: '#/components/responses/LogReportCompiled.Post.303' "422": $ref: '#/components/responses/LogReportCompiled.Post.422' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' "/subscriptions": description: >- This resource represents subscriptions. The client can use this resource to subscribe to notifications related to NFV-MANO performance management and to query its subscriptions. post: description: >- The POST method creates a new subscription. See clause 8.5.7.3.1. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" requestBody: $ref: '#/components/requestBodies/LogmSubscriptionRequest' responses: "201": $ref: '#/components/responses/Subscriptions.Post.201' "303": $ref: '#/components/responses/Subscriptions.Post.303' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' callbacks: LogReportAvailableNotification: $ref: '#/components/callbacks/LogReportAvailableNotification' get: description: >- The API consumer can use this method to query the list of active subscriptions to log management notifications subscribed by the API consumer. See clause 8.5.7.3.2. parameters: - $ref: "#/components/parameters/filter.LogmSubscriptions" - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker" - $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": $ref: '#/components/responses/Subscriptions.Get.200' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' "/subscriptions/{subscriptionId}": description: >- This resource represents an individual subscription for notifications about log management related events. The API consumer can use this resource to read and to terminate a subscription to notifications related o NFV-MANO log management. parameters: - $ref: "#/components/parameters/subscriptionId" get: description: >- The API consumer can use this method for reading an individual subscription about log management notifications subscribed by the API consumer. See clause 8.5.8.3.2. parameters: - $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": $ref: '#/components/responses/Subscription.Get.200' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' delete: description: >- This method terminates an individual subscription. See clause 8.5.8.3.5. parameters: - $ref: "../components/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" responses: "204": $ref: '#/components/responses/Subscription.Delete.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' components: parameters: filter.LoggingJobs: 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 exclude_default.LoggingJobs: name: exclude_default 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. The following attributes shall be excluded from the LoggingJob structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided: • logReports in: query required: false schema: type: string filter.LogmSubscriptions: 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 LogmSubscription 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 logJobId: name: logJobId in: path description: >- Identifier of the logging job. required: true schema: $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' logReportId: name: logReportId in: path description: >- Identifier of the report. required: true schema: $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' subscriptionId: name: subscriptionId in: path description: >- Identifier of the subscription required: true schema: $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier' requestBodies: LogmSubscriptionRequest: description: >- Details of the subscription to be created content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscriptionRequest" required: true CreateLoggingJobRequest: description: >- This type represents a request to create a logging job. It shall comply with the provisions defined in table 8.6.2.5-1. content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CreateLoggingJobRequest" required: true CompileLogRequest: description: >- Log compilation request. content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/CompileLogRequest" required: true LogReportAvailableNotification: description: >- Notification about the availability of a log report. content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReportAvailableNotification" required: true responses: Subscription.Delete.204: description: > 204 NO CONTENT Shall be returned when the "Individual subscription" resource has been deleted successfully. The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Subscription.Get.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 8.6.2.3. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" Subscriptions.Get.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 log management subscriptions as defined in clause 8.6.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 NFV-MANO functional entity 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 response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: type: array items: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" Subscriptions.Post.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 8.6.2.3. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created "Individual subscription" resource. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Location: description: > URI of the "Individual log report" resource just created schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogmSubscription" Subscriptions.Post.303: description: > 303 SEE OTHER Shall be returned when a subscription with the same callbackURI and the same filter already exists and the policy of the NFV-MANO functional entity is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing "Individual subscription" resource. The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Location: description: > URI of the "Individual log report" resource just created schema: type: string LogReportCompiled.Post.201: description: > 201 CREATED Shall be returned for a successful compilation of the log data and creation of the associated log report (synchronous mode). The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7. The HTTP response shall include a "Location" HTTP header that indicate the URI of the "Individual log report" resource just created headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Location: description: > URI of the "Individual log report" resource just created schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport" subscriptions.post.422: description: > 422 UNPROCESSABLE ENTITY Shall be returned upon the following error: The content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the API producer has tested the Notification endpoint as described in clause 8.5.9.3.2 and the test has failed. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error. 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails" LogReportCompiled.Post.202: description: > 202 ACCEPTED Shall be returned when the request has been accepted for processing, and it is expected to take some time to compile the log file and create the associated log report (asynchronous mode). The response body shall be empty. The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual log report" resource that will be created once the log file compilation is completed. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Location: description: > The URI of the "Individual log report" resource that will be created once the log file compilation is completed. schema: type: string LogReportCompiled.Post.303: description: > 303 SEE OTHER Shall be returned when a log data compilation and report creation is already ongoing, or a log report has just been created, for the specified logging job at the time of processing the request. The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the log report resource just created, or to be created by the ongoing compilation and report creation. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string Location: description: > The URI of the log report resource just created, or to be created by the ongoing compilation and report creation schema: type: string LogReportCompiled.Post.422: description: > 422 UNPROCESSABLE ENTITY The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence of the response body. Specifically, in case of this task resource, the response code 422 shall also be returned if the "objectInstanceId" value provided in the payload body of the request does not correspond to an object instance for which log data is being collected by the logging job represented by this resource. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: '../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails' LogReport.Get.200: description: > 200 OK Shall be returned when information of an individual log report has been read successfully. The response body shall contain a representation of the "Individual log report" resource, as defined in clause 8.6.2.7. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LogReport" LogReport.Get.202: description: > 202 ACCEPTED Shall be returned if the creation of the log report is ongoing and no log report is available yet (applicable in asynchronous mode of the "Compile log task" resource). The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string IndividualLoggingJob.Get.200: description: > 200 OK Shall be returned when information about an individual logging job has been read successfully. The response body shall contain a representation of the "Individual logging job" resource, as defined in clause 8.6.2.6. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" IndividualLoggingJob.Delete.204: description: > 204 NO CONTENT Shall be returned when the logging job 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. schema: type: string Version: description: >- Version of the API used in the response. schema: type: string LoggingJobs.Post.201: description: > 201 CREATED The response body contains the Application Context as it was created by the MEC system headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" LoggingJobs.Get.200: description: > 200 OK Shall be returned when information about zero or more logging jobs has been queried successfully. The response body shall contain in an array the representations of zero or more logging jobs, as defined in clause 8.6.2.6. 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 NFV-MANO functional entity 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 response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string content: application/json: schema: type: array items: $ref: "./components/NFVManoLogManagement_def.yaml#/components/schemas/LoggingJob" LogReportAvailableNotification.Post.204: description: > 204 NO CONTENT Shall be returned when the notification has been delivered successfully. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string LogReportAvailableNotification.Get.204: description: > 204 NO CONTENT Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. schema: type: string 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. schema: type: string Version: description: > Version of the API used in the response. schema: type: string callbacks: LogReportAvailableNotification: '{$request.body#/callbackUri}': description: >- This resource represents a notification endpoint for NFV-MANO log management. The API producer can use this resource to send notifications related to log management events to a subscribed API consumer, which has provided the URI of this resource during the subscription process. post: description: >- The POST method delivers a notification regarding a log management event from the API producer to the API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. 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/SOL009_params.yaml#/components/parameters/Version" - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization" requestBody: $ref: "#/components/requestBodies/LogReportAvailableNotification" responses: "204": $ref: '#/components/responses/LogReportAvailableNotification.Post.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504' get: description: >- The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during subscription. 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/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/LogReportAvailableNotification.Get.204' "400": $ref: '../components/SOL009_resp.yaml#/components/responses/400' "401": $ref: '../components/SOL009_resp.yaml#/components/responses/401' "403": $ref: '../components/SOL009_resp.yaml#/components/responses/403' "404": $ref: '../components/SOL009_resp.yaml#/components/responses/404' "405": $ref: '../components/SOL009_resp.yaml#/components/responses/405' "406": $ref: '../components/SOL009_resp.yaml#/components/responses/406' "422": $ref: '../components/SOL009_resp.yaml#/components/responses/422' "500": $ref: '../components/SOL009_resp.yaml#/components/responses/500' "503": $ref: '../components/SOL009_resp.yaml#/components/responses/503' "504": $ref: '../components/SOL009_resp.yaml#/components/responses/504'