diff options
Diffstat (limited to 'main/src/main/resources/openapi/openapi.yaml')
| -rw-r--r-- | main/src/main/resources/openapi/openapi.yaml | 732 |
1 files changed, 2 insertions, 730 deletions
diff --git a/main/src/main/resources/openapi/openapi.yaml b/main/src/main/resources/openapi/openapi.yaml index 281d2cc3..9a88c801 100644 --- a/main/src/main/resources/openapi/openapi.yaml +++ b/main/src/main/resources/openapi/openapi.yaml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= # Copyright (C) 2022-2023 Nordix Foundation +# Modifications Copyright (C) 2023 Bell Canada. All rights reserved. # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -52,7 +53,6 @@ tags: - name: PolicyAuditControllerV1 - name: PolicyComponentsHealthCheckControllerV1 - name: PolicyStatusControllerV1 - - name: StatisticsRestControllerV1 paths: /healthcheck: get: @@ -63,7 +63,7 @@ paths: operationId: healthcheck responses: 200: - description: OK, serialised instance of + description: OK, serialized instance of [HealthCheckReport](https://github.com/onap/policy-common/blob/master/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/report/HealthCheckReport.java) headers: X-LatestVersion: @@ -2990,729 +2990,7 @@ paths: - basicAuth: [] x-interface info: api-version: 1.0.0 - last-mod-release: Dublin - /pdps/statistics: - get: - tags: - - StatisticsRestControllerV1 - summary: Fetch statistics for all PDP Groups and subgroups in the system - description: >- - Returns for all PDP Groups and subgroups statistics of the Policy - Administration component - operationId: pdpStatistics - parameters: - - name: X-ONAP-RequestID - in: header - description: RequestID for http transaction - required: false - schema: - type: string - format: uuid - - name: recordCount - in: query - description: Record Count - required: false - style: form - schema: - type: integer - format: int32 - default: 10 - - name: startTime - in: query - description: Start time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - - name: endTime - in: query - description: End time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - responses: - 200: - description: OK, a map for each PDP group keyed by PDP group name that contains another - map keyed by PDP subgroup name that contains the statistics for each PDP in the PDP - subgroup as a list of instances of - [PdpStatistics](https://github.com/onap/policy-models/blob/master/models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpStatistics.java) - content: - application/json: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - application/yaml: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - 401: - description: Authentication Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 403: - description: Authorization Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 404: - description: Not Found - 500: - description: Internal Server Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - security: - - basicAuth: [] - x-interface info: - api-version: 1.0.0 last-mod-release: Dublin - /pdps/statistics/{group}: - get: - tags: - - StatisticsRestControllerV1 - summary: Fetch current statistics for given PDP Group - description: >- - Returns statistics for given PDP Group of the Policy Administration - component - operationId: pdpGroupStatistics - parameters: - - name: X-ONAP-RequestID - in: header - description: RequestID for http transaction - required: false - schema: - type: string - format: uuid - - name: group - in: path - description: PDP Group Name - required: true - style: simple - schema: - type: string - - name: recordCount - in: query - description: Record Count - required: false - style: form - schema: - type: integer - format: int32 - default: 10 - - name: startTime - in: query - description: Start time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - - name: endTime - in: query - description: End time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - responses: - 200: - description: OK, a map for each PDP group keyed by PDP group name that contains another - map keyed by PDP subgroup name that contains the statistics for each PDP in the PDP - subgroup as a list of instances of - [PdpStatistics](https://github.com/onap/policy-models/blob/master/models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpStatistics.java) - content: - application/json: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - application/yaml: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - 401: - description: Authentication Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 403: - description: Authorization Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 404: - description: Not Found - 500: - description: Internal Server Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - security: - - basicAuth: [] - x-interface info: - api-version: 1.0.0 - last-mod-release: Dublin - /pdps/statistics/{group}/{type}: - get: - tags: - - StatisticsRestControllerV1 - summary: Fetch statistics for the specified subgroup - description: >- - Returns statistics for the specified subgroup of the Policy - Administration component - operationId: pdpSubGroupStatistics - parameters: - - name: X-ONAP-RequestID - in: header - description: RequestID for http transaction - required: false - schema: - type: string - format: uuid - - name: group - in: path - description: PDP Group Name - required: true - style: simple - schema: - type: string - - name: type - in: path - description: PDP SubGroup type - required: true - style: simple - schema: - type: string - - name: recordCount - in: query - description: Record Count - required: false - style: form - schema: - type: integer - format: int32 - default: 10 - - name: startTime - in: query - description: Start time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - - name: endTime - in: query - description: End time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - responses: - 200: - description: OK, a map for each PDP group keyed by PDP group name that contains another - map keyed by PDP subgroup name that contains the statistics for each PDP in the PDP - subgroup as a list of instances of - [PdpStatistics](https://github.com/onap/policy-models/blob/master/models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpStatistics.java) - content: - application/json: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - application/yaml: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - 401: - description: Authentication Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 403: - description: Authorization Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 404: - description: Not Found - 500: - description: Internal Server Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - security: - - basicAuth: [] - x-interface info: - api-version: 1.0.0 - last-mod-release: Dublin - /pdps/statistics/{group}/{type}/{pdp}: - get: - tags: - - StatisticsRestControllerV1 - summary: Fetch statistics for the specified pdp - description: >- - Returns statistics for the specified pdp of the Policy Administration - component - operationId: pdpInstanceStatistics - parameters: - - name: X-ONAP-RequestID - in: header - description: RequestID for http transaction - required: false - schema: - type: string - format: uuid - - name: group - in: path - description: PDP Group Name - required: true - style: simple - schema: - type: string - - name: type - in: path - description: PDP SubGroup type - required: true - style: simple - schema: - type: string - - name: pdp - in: path - description: PDP Instance name - required: true - style: simple - schema: - type: string - - name: recordCount - in: query - description: Record Count - required: false - style: form - schema: - type: integer - format: int32 - default: 10 - - name: startTime - in: query - description: Start time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - - name: endTime - in: query - description: End time in epoch timestamp - required: false - style: form - schema: - type: integer - format: int64 - responses: - 200: - description: OK, a map for each PDP group keyed by PDP group name that contains another - map keyed by PDP subgroup name that contains the statistics for each PDP in the PDP - subgroup as a list of instances of - [PdpStatistics](https://github.com/onap/policy-models/blob/master/models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpStatistics.java) - content: - application/json: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - application/yaml: - schema: - type: string - additionalProperties: - type: string - additionalProperties: - type: array - items: - $ref: '#/components/schemas/PdpStatistics' - 401: - description: Authentication Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 403: - description: Authorization Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - 404: - description: Not Found - 500: - description: Internal Server Error - headers: - X-LatestVersion: - description: Used only to communicate an API's latest version - required: true - schema: - type: string - X-PatchVersion: - description: >- - Used only to communicate a PATCH version in a response for - troubleshooting purposes only, and will not be provided by the - client on request - required: true - schema: - type: string - X-MinorVersion: - description: >- - Used to request or communicate a MINOR version back from the - client to the server, and from the server back to the client - required: true - schema: - type: string - X-ONAP-RequestID: - description: Used to track REST transactions for logging purpose - required: true - schema: - type: string - format: uuid - security: - - basicAuth: [] - x-interface info: - api-version: 1.0.0 - last-mod-release: Dublin - /statistics: - get: - tags: - - StatisticsRestControllerV1 - summary: Fetch current statistics - description: Returns current statistics of the Policy Administration component - operationId: statistics - parameters: - - name: X-ONAP-RequestID - in: header - description: RequestID for http transaction - required: false - schema: - type: string - format: uuid - responses: - 200: - description: OK, the statistics report in an instance of - [StatisticsReport](https://github.com/onap/policy-api/blob/master/main/src/main/java/org/onap/policy/api/main/rest/provider/statistics/StatisticsReport.java) - content: - application/json: - schema: - $ref: '#/components/schemas/StatisticsReport' - application/yaml: - schema: - $ref: '#/components/schemas/StatisticsReport' - 401: - description: Authentication Error - 403: - description: Authorization Error - 404: - description: Not Found - 500: - description: Internal Server Error - security: - - basicAuth: [] components: securitySchemes: basicAuth: @@ -3755,9 +3033,3 @@ components: PolicyStatus: title: PolicyStatus type: object - PdpStatistics: - title: PdpStatistics - type: object - StatisticsReport: - title: StatisticsReport - type: object |