Link out to developer's guide for endpoint description in Backend Swagger page

Open
#15 0 comments 0 reactions 1 assignee View on GitHub

@LAShemilt is already working on this.

Since Feb 10, 2026.

Assessment

This issue has not been assessed yet.

Description

We want a link to provide systematic description on each of the endpoints. This would sit better in the developers docs. Link out to the backend documentation from this page

Dominant language
No language data
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciCatProject/user-documentation

All issues in SciCatProject/user-documentation

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.