Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for the annotation download file format #6546

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Fix docs for the annotation download file format #6546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/rest_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,13 +344,17 @@ Download an annotation as NML/ZIP

#### Returns
- As chunked file stream:
- In case of a volume annotation:
- A ZIP file containing both an NML file and a data.zip file with the volume data
- In case of a single explorative or task annotation with no volume annotation:
- In case of a single skeleton-only annotation:
- A single NML file
- In case of a single annotation with volume layers
- A ZIP file containing both an NML file and data zip files with the volume data for each volume layer. The data zip file names are referenced in the `<volume>` tags in the NML file.
- In case of compound downloads (CompoundTask/CompoundProject/CompoundTaskType):
- A ZIP file containing individual NML files for all associated annotations


#### Note
- The volume data zip file name used to always be `data.zip`, when wk supported only a single volume layer per annotation. Please use the file names referenced in the `<volume>` tags in the NML file instead.
Comment on lines +355 to +356
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could also use an admonition from mkdocs here, see
https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage

(They are already configured in the docs, so just adding the syntax would be enough.)

Feel free to leave as-is as well.


---
### `POST /annotations/upload`

Expand Down