Skip to content

Commit 2a9b8aa

Browse files
authored
Update README
Improved formatting
1 parent cd39652 commit 2a9b8aa

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

api/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API path | Description
1010
[/config/getallforapp](https://github.com/danesparza/centralconfig/tree/master/api#configgetallforapp) | Get all configuration items for a single application (plus the default * application)
1111
[/applications/getall](https://github.com/danesparza/centralconfig/tree/master/api#applicationsgetall) | Get all applications
1212

13-
####Requests
13+
#### Requests
1414
Most API operations expect a configitem object in the POST body that will be used to either filter (in a get operation), update or create (in a set operation), or remove an item (in a remove operation).
1515

1616
For example:
@@ -23,7 +23,7 @@ For example:
2323
}
2424
```
2525

26-
####Responses
26+
#### Responses
2727
All operations will return an object that contain the fields status, message, and data.
2828

2929
For Example:
@@ -49,15 +49,15 @@ This operation retrieves a single configuration item. If it doesn't exist for t
4949

5050
This is an HTTP `POST` request
5151

52-
######Example request:
52+
###### Example request:
5353
```json
5454
{
5555
"application" : "AccountingReports",
5656
"name" : "ShowFooterDates"
5757
}
5858
```
5959

60-
######Example response:
60+
###### Example response:
6161
```json
6262
{
6363
"status": 200,
@@ -79,7 +79,7 @@ This operation sets the value of a single configuration item
7979

8080
This is an HTTP `POST` request
8181

82-
######Example request:
82+
###### Example request:
8383
```json
8484
{
8585
"application" : "AccountingReports",
@@ -88,7 +88,7 @@ This is an HTTP `POST` request
8888
}
8989
```
9090

91-
######Example response:
91+
###### Example response:
9292
```json
9393
{
9494
"status": 200,
@@ -108,15 +108,15 @@ This is an HTTP `POST` request
108108

109109
This operation removes a single configuration item
110110

111-
######Example request:
111+
###### Example request:
112112
```json
113113
{
114114
"application" : "AccountingReports",
115115
"name" : "ShowHeaderValues"
116116
}
117117
```
118118

119-
######Example response:
119+
###### Example response:
120120
```json
121121
{
122122
"status": 200,
@@ -138,7 +138,7 @@ This operation retrieves all configuration items.
138138

139139
This is a `GET` request.
140140

141-
######Example response:
141+
###### Example response:
142142
```json
143143
{
144144
"status": 200,
@@ -186,14 +186,14 @@ This operation retrieves all configuration items for a specified application
186186

187187
This is an HTTP `POST` operation
188188

189-
######Example request:
189+
###### Example request:
190190
```json
191191
{
192192
"application" : "AccountingReports"
193193
}
194194
```
195195

196-
######Example response:
196+
###### Example response:
197197
```json
198198
{
199199
"status": 200,
@@ -225,7 +225,7 @@ This operation retrieves all applications
225225

226226
This is an HTTP `GET` operation.
227227

228-
######Example response:
228+
###### Example response:
229229
```json
230230
{
231231
"status": 200,

0 commit comments

Comments
 (0)