Skip to content

Commit 94f9b1b

Browse files
committed
Add search exposed config endpoint
1 parent 128f6bf commit 94f9b1b

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

configuration.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
## Main Endpoint
44
**/api/config/properties**
55

6-
As we don't have yet an use case to iterate over all the configuration properties the main endpoint is not implemented and a 405 error code is returned according to our [general error response codes](README.md#Error codes).
6+
As we don't have yet an use case to iterate over all the configuration properties the main endpoint is not implemented and a 405 error code is returned according to our [general error response codes](README.md#Error-Codes).
77

88
## Single property
99
**/api/config/properties/<:property>**
1010

1111
This endpoint provides functionality to retrieve certain (configurable) configuration properties.
1212
The DSpace server will have a whitelist of properties that can be retrieved by this endpoint.
1313

14+
For example:
1415

1516
```json
1617
{
@@ -21,5 +22,40 @@ The DSpace server will have a whitelist of properties that can be retrieved by t
2122
}
2223
```
2324

24-
* 200 OK - if the operation succeed
25-
* 404 Not found - if the property doesn't exist or isn't configured to be retrieved
25+
* 200 OK - if the operation succeeded
26+
* 404 Not found - if the property doesn't exist or isn't configured to be exposed
27+
28+
## Search methods
29+
### top
30+
**/api/config/properties/search/exposed**
31+
32+
The supported parameters are:
33+
* page, size [see pagination](README.md#Pagination)
34+
35+
This endpoint returns all exposed configuration variables.
36+
37+
For example:
38+
39+
```json
40+
[{
41+
"name": "google.analytics.key",
42+
"values": [
43+
"UA-XXXXXX-X"
44+
]
45+
},
46+
{
47+
"name": "websvc.opensearch.autolink",
48+
"values": [
49+
true
50+
]
51+
},
52+
{
53+
"name": "orcid.authorize-url",
54+
"values": [
55+
"https://sandbox.orcid.org/oauth/authorize"
56+
]
57+
}]
58+
```
59+
60+
* 200 OK - if the operation succeeded
61+
* 404 Not found - if no property is configured to be exposed

0 commit comments

Comments
 (0)