Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
F
flame-clmc
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
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
flame
flame-clmc
Commits
d88b5ae1
Commit
d88b5ae1
authored
6 years ago
by
Nikolay Stanchev
Browse files
Options
Downloads
Patches
Plain Diff
Updated CLMC service API documentation
parent
8cd2ef06
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/clmc-service.md
+12
-12
12 additions, 12 deletions
docs/clmc-service.md
with
12 additions
and
12 deletions
docs/clmc-service.md
+
12
−
12
View file @
d88b5ae1
...
...
@@ -46,7 +46,7 @@ All source code, tests and configuration files of the service can be found in th
Returns a JSON-formatted response with the configuration data of the aggregator - *aggregator_report_period*, *aggregator_database_name*,
*aggregator_database_url*.
* Response Example:
* Response
Body
Example:
```json
{
...
...
@@ -65,7 +65,7 @@ All source code, tests and configuration files of the service can be found in th
Expects a JSON-formatted request body with the new configuration of the aggregator. The body should contain only
three key fields - *aggregator_report_period* (positive integer, seconds), *aggregator_database_name* and *aggregator_database_url* (a valid URL).
* Request Example:
* Request
Body
Example:
```json
{
...
...
@@ -80,7 +80,7 @@ All source code, tests and configuration files of the service can be found in th
The body of the request is first validated before updating the configuration. If validation is successful, returns
a JSON-formatted response with the new configuration data. Otherwise, an **HTTP Bad Request** response is returned.
* Response Example:
* Response
Body
Example:
```json
{
...
...
@@ -94,9 +94,9 @@ All source code, tests and configuration files of the service can be found in th
If the configuration is updated, while the aggregator is running, it is not automatically restarted. An explicit API call
must be made with a *restart* request to apply the updated configuration. In the case of such PUT request as the one described
above, the response will contain more information indicating that the configuration of the aggregator is malformed
above, the response will contain more information indicating that the configuration of the aggregator is
in a
malformed
state.
* Response Example:
* Response
Body
Example:
```json
{
...
...
@@ -114,18 +114,18 @@ All source code, tests and configuration files of the service can be found in th
* Response:
Returns a JSON-formatted response with the status data of the aggregator - *aggregator_running*. If the aggregator
is running in a malformed state, the response will also indicate this with two additional fields - *malformed* and *comment*
Returns a JSON-formatted response with the status data of the aggregator - *aggregator_running*
field
. If the aggregator
is running in a malformed state, the response will also indicate this with two additional fields - *malformed* and *comment*
.
* Response Example:
* Response
Body
Example:
```json
{
"aggregator_running":
fals
e
"aggregator_running":
tru
e
}
```
* Response Example - for malformed configuration:
* Response
Body
Example - for malformed configuration:
```json
{
...
...
@@ -144,7 +144,7 @@ All source code, tests and configuration files of the service can be found in th
Expects a JSON-formatted request body with the new status of the aggregator. The body should contain only one key
field - *action* (the action to undertake, which can be **start**, **restart** or **stop**)
* Request Example:
* Request
Body
Example:
```json
{
...
...
@@ -158,7 +158,7 @@ All source code, tests and configuration files of the service can be found in th
then the validation will fail. If validation is successful, returns a JSON-formatted response with the new status of
the aggregator. Otherwise, an **HTTP Bad Request** response is returned.
* Response Example:
* Response
Body
Example:
```json
{
...
...
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