You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ API path | Description
10
10
[/config/getallforapp](https://github.com/danesparza/centralconfig/tree/master/api#configgetallforapp) | Get all configuration items for a single application (plus the default * application)
11
11
[/applications/getall](https://github.com/danesparza/centralconfig/tree/master/api#applicationsgetall) | Get all applications
12
12
13
-
####Requests
13
+
####Requests
14
14
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).
15
15
16
16
For example:
@@ -23,7 +23,7 @@ For example:
23
23
}
24
24
```
25
25
26
-
####Responses
26
+
####Responses
27
27
All operations will return an object that contain the fields status, message, and data.
28
28
29
29
For Example:
@@ -49,15 +49,15 @@ This operation retrieves a single configuration item. If it doesn't exist for t
49
49
50
50
This is an HTTP `POST` request
51
51
52
-
######Example request:
52
+
######Example request:
53
53
```json
54
54
{
55
55
"application" : "AccountingReports",
56
56
"name" : "ShowFooterDates"
57
57
}
58
58
```
59
59
60
-
######Example response:
60
+
######Example response:
61
61
```json
62
62
{
63
63
"status": 200,
@@ -79,7 +79,7 @@ This operation sets the value of a single configuration item
79
79
80
80
This is an HTTP `POST` request
81
81
82
-
######Example request:
82
+
######Example request:
83
83
```json
84
84
{
85
85
"application" : "AccountingReports",
@@ -88,7 +88,7 @@ This is an HTTP `POST` request
88
88
}
89
89
```
90
90
91
-
######Example response:
91
+
######Example response:
92
92
```json
93
93
{
94
94
"status": 200,
@@ -108,15 +108,15 @@ This is an HTTP `POST` request
108
108
109
109
This operation removes a single configuration item
110
110
111
-
######Example request:
111
+
######Example request:
112
112
```json
113
113
{
114
114
"application" : "AccountingReports",
115
115
"name" : "ShowHeaderValues"
116
116
}
117
117
```
118
118
119
-
######Example response:
119
+
######Example response:
120
120
```json
121
121
{
122
122
"status": 200,
@@ -138,7 +138,7 @@ This operation retrieves all configuration items.
138
138
139
139
This is a `GET` request.
140
140
141
-
######Example response:
141
+
######Example response:
142
142
```json
143
143
{
144
144
"status": 200,
@@ -186,14 +186,14 @@ This operation retrieves all configuration items for a specified application
186
186
187
187
This is an HTTP `POST` operation
188
188
189
-
######Example request:
189
+
######Example request:
190
190
```json
191
191
{
192
192
"application" : "AccountingReports"
193
193
}
194
194
```
195
195
196
-
######Example response:
196
+
######Example response:
197
197
```json
198
198
{
199
199
"status": 200,
@@ -225,7 +225,7 @@ This operation retrieves all applications
0 commit comments