diff options
Diffstat (limited to 'a1-policy-management/open-api-fragments/v2-fragments/configuration-api.yaml')
| -rw-r--r-- | a1-policy-management/open-api-fragments/v2-fragments/configuration-api.yaml | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/a1-policy-management/open-api-fragments/v2-fragments/configuration-api.yaml b/a1-policy-management/open-api-fragments/v2-fragments/configuration-api.yaml new file mode 100644 index 00000000..6ac239fe --- /dev/null +++ b/a1-policy-management/open-api-fragments/v2-fragments/configuration-api.yaml @@ -0,0 +1,42 @@ +configuration: + get: + description: Returns the entire contents of the Application Configuration. + tags: + - Configuration + operationId: getConfiguration + summary: Get the Application Configuration (getConfiguration) + responses: + "200": + content: + application/json: + schema: + type: string + description: OK - Configuration + "404": + $ref: 'responses.yaml#/responses/NotFound' + description: Not Found - Configuration is not found or is not readable + put: + description: > + Replace the current Application Configuration with a new configuration. + The new configuration, if accepted, will take effect after a short delay. + The new configuration must comply with the Application Configuration schema, + which can be found from the the Application Documentation (Developer Guide) + tags: + - Configuration + operationId: putConfiguration + summary: Set/Replace the Application Configuration (putConfiguration) + requestBody: + content: + application/json: + schema: + type: object + required: true + responses: + "200": + content: + '*/*': + schema: + $ref: 'schemas.yaml#/schemas/void' + description: OK - Configuration updated + "400": + $ref: 'responses.yaml#/responses/BadRequest'
\ No newline at end of file |