Skip to content

Commit

Permalink
Reference Swagger API docs (#33)
Browse files Browse the repository at this point in the history
* Mention API docs in documentation

* Reference developer docs
  • Loading branch information
sven1103 authored Feb 3, 2025
1 parent 9481241 commit a0d7340
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/developers/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Data Manager API

Access to resources in Data Manager via a RESTful API.

!!! info "API endpoints"
Currently, only one endpoint exists, which allows for a download of raw data. It is planned to extend the API in
the future to interact with various resources in Data Manager.


## Swagger API docs

Detailed API documentation is available via Swagger UI and [hosted on the web service](https://download.qbic.uni-tuebingen.de/swagger-ui/index.html).


3 changes: 3 additions & 0 deletions docs/rawdata/raw_data_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ The raw data summary view shows detailed information about the raw data already
Additionally, it enables you to generate the [URLs](#raw-data-url-generation) necessary
to start the command line based [raw data download](#download-raw-data).

!!! info "Are you a developer?"
Read about Swagger API docs in the [developer](../developers/api.md) section.

## Process

1. Create a [personal access token](#personal-access-token) (PAT)
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ nav:
- Registration: user/user_registration.md
- Password Reset: user/password_reset.md
- Editing: user/user_edit.md
- Developers:
- API: developers/api.md
extra_css:
- stylesheets/extra.css
extra:
Expand Down

0 comments on commit a0d7340

Please sign in to comment.