Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
OCF
documentation
Commits
24bcf4b0
Commit
24bcf4b0
authored
2 months ago
by
guillecxb
Browse files
Options
Downloads
Patches
Plain Diff
add deletes to helper and register's swagger
parent
d077cda7
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!38
Resolve "Documentation how to manage dynamic configuration"
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/swagger/helper_swagger.yaml
+49
-0
49 additions, 0 deletions
doc/swagger/helper_swagger.yaml
doc/swagger/register_swagger.yaml
+67
-0
67 additions, 0 deletions
doc/swagger/register_swagger.yaml
with
116 additions
and
0 deletions
doc/swagger/helper_swagger.yaml
+
49
−
0
View file @
24bcf4b0
...
...
@@ -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
:
...
...
This diff is collapsed.
Click to expand it.
doc/swagger/register_swagger.yaml
+
67
−
0
View file @
24bcf4b0
...
...
@@ -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
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment