Skip to content

Commit c696432

Browse files
committed
Docs update
1 parent 100a411 commit c696432

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ WantedBy=multi-user.target
120120
7. Execute `sudo systemctl enable labwatcher`
121121
8. Execute `sudo systemctl start labwatcher`
122122

123-
### 4. Troubleshooting
123+
## 4. Troubleshooting
124124

125125
1. If we are mount automatically and got error like:
126126
```
@@ -129,7 +129,18 @@ Jan 08 18:14:32 LabControl mount.sh[495]: Refer to the mount.cifs(8) manual page
129129
```
130130
there are many solutions but for me helpful was adding `sleep 20s` in `.sh` script prior to `mount`
131131

132-
## Contributors
132+
## 5. Web API
133+
134+
There are following endpoints to receive/manage state from browser or other clients:
135+
136+
* `GET /api/Spectrum` - list all spectra from database;
137+
![Get indexed spectra](/docs/img/api/get_all.jpg)
138+
* `GET /api/Spectrum/{id}` - return one spectrum by its id;
139+
* `GET /api/Spectrum/{id}/samples` - return spectrum data including list of all intermediate measurements;
140+
* `GET /api/Spectrum/{id}/samples/{sampleName}/spectrum` - return spectrum with file name = `{sampleName}`
141+
![Get spectrum](/docs/img/api/get_spectrum_itself.jpg)
142+
143+
## 6. Contributors
133144

134145
<a href="https://github.com/Wissance/LabWatcher/graphs/contributors">
135146
<img src="https://contrib.rocks/image?repo=Wissance/LabWatcher" />

docs/img/api/get_all.jpg

366 KB
Loading
154 KB
Loading

0 commit comments

Comments
 (0)