Skip to content

Commit f7377ff

Browse files
committed
[docs] Fix mkdocs pointer to Apricot HTTP API and improve docs
1 parent 2f93408 commit f7377ff

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

apricot/docs/apricot_http_service.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,14 @@ To retrieve a component configuration payload, use the following urls in a web b
3030
* `http://<apricot-server>/components/<component>/<runtype>/<rolename>/<entry>?process=false` - without template processing, returns the entry verbatim
3131

3232
The full API documentation is available at `http://<apricot-server>/docs/` wherever your Apricot instance is running. This documentation interface also allows to perform API calls directly from the browser.
33+
Besides configuration retrieval, the API also includes calls for browsing the configuration tree and resolving payload paths to actual entries according to the `ANY/any` mechanism.
3334

3435
### Examples
3536

3637
* With `curl`: `curl http://localhost:32188/inventory/flps`
37-
* With `wget`: `wget http://localhost:32188/inventory/detectors/TST/flps/json -O ~/downloads/test`
38+
* With `wget`: `wget http://localhost:32188/inventory/detectors/TST/flps/json -O ~/downloads/test`
39+
40+
Getting a template-processed configuration payload for a component (entry `tpc-full-qcmn` for component `qc`, with `list_of_detectors` and `run_type` passed as template variables):
41+
42+
* In a browser: `http://localhost:32188/components/qc/ANY/any/tpc-full-qcmn?process=true&list_of_detectors=tpc,its&run_type=PHYSICS`
43+
* With `curl`: `curl http://127.0.0.1:32188/components/qc/ANY/any/tpc-full-qcmn\?process\=true\&list_of_detectors\=tpc,its\&run_type\=PHYSICS`

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav:
88
- Configuration:
99
- Workflow Configuration: handbook/configuration.md
1010
- Apricot Usage: './apricot/docs/apricot.md'
11-
- Apricot HTTP API: './apricot/docs/apricot_api.md'
11+
- Apricot HTTP API: './apricot/docs/apricot_http_service.md'
1212
- gRPC APIs:
1313
- AliECS gRPC API: apidocs_aliecs.md
1414
- Apricot gRPC API: apidocs_apricot.md

0 commit comments

Comments
 (0)