Docs updates

This commit is contained in:
Thomas Georgios Giannos 2024-05-22 12:35:24 +03:00
parent b2771df05f
commit 1943cd1d67
2 changed files with 27 additions and 1 deletions

View File

@ -133,5 +133,6 @@ These are the semantics suggestions.
- `zenodo.related_identifiers.isRequiredBy`
- `zenodo.related_identifiers.isObsoletedBy`
- `zenodo.related_identifiers.obsoletes`
- `zenodo.publication_date`
</TabItem>
</Tabs>

View File

@ -3,4 +3,29 @@ sidebar_position: 1
description: A brief guide on the API documentation tool this platform uses
---
# Swagger
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
# Swagger
The swagger UI is available at the `/swagger-ui/index.html` url. It contains documentation for the following API endpoints.
<Tabs>
<TabItem value="public" label="Public API">
- **/api/public/dmps/\*\***
- **/api/public/descriptions/\*\***
</TabItem>
<TabItem value="internal" label="Internal API">
- **/api/dmp/\*\***
- **/api/description/\*\***
<Admonition type="info">
<p>These endpoints require authentication.</p>
</Admonition>
</TabItem>
</Tabs>