Skip to content
Snippets Groups Projects
Commit 24bcf4b0 authored by guillecxb's avatar guillecxb
Browse files

add deletes to helper and register's swagger

parent d077cda7
No related branches found
No related tags found
1 merge request!38Resolve "Documentation how to manage dynamic configuration"
......@@ -453,6 +453,55 @@ paths:
description: Parameter added successfully.
"400":
description: Missing 'param_path' or 'new_value' in request body.
/helper/removeConfigParam:
delete:
tags:
- Configuration
summary: Delete a specific parameter inside 'settings'
description: Removes a specific configuration parameter inside a 'settings' category.
operationId: RemoveConfigParam
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
param_path:
type: string
example: "settings.security_method_priority.oauth"
responses:
"200":
description: Parameter removed successfully.
"400":
description: Missing 'param_path' in request body.
"404":
description: No configuration found or parameter not removed.
/helper/removeConfigCategory:
delete:
tags:
- Configuration
summary: Delete an entire category inside 'settings'
description: Removes an entire category inside 'settings'.
operationId: RemoveConfigCategory
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
category_name:
type: string
example: "new_policy_settings"
responses:
"200":
description: Category removed successfully.
"400":
description: Missing 'category_name' in request body.
"404":
description: No configuration found or category not removed.
components:
schemas:
InvokersResponse:
......
......@@ -314,7 +314,74 @@ paths:
example: "Parameter 'certificates_expiry.new_config_ttl' added successfully"
"400":
description: Invalid request body
/configuration/removeConfigParam:
delete:
summary: Remove a configuration parameter
description: Deletes a specific parameter in the register configuration.
tags:
- Configuration
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
param_path:
type: string
example: "settings.certificates_expiry.some_config"
responses:
"200":
description: Parameter removed successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Parameter 'settings.certificates_expiry.some_config' removed successfully"
"400":
description: Missing 'param_path' in request body
"404":
description: Parameter not found
/configuration/removeConfigCategory:
delete:
summary: Remove a configuration category
description: Deletes an entire category in the register configuration.
tags:
- Configuration
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
category_name:
type: string
example: "deprecated_category"
responses:
"200":
description: Category removed successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Category 'deprecated_category' removed successfully"
"400":
description: Missing 'category_name' in request body
"404":
description: Category not found
components:
securitySchemes:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment