Skip to content

chore(docs): added documentation for endpoints, it should be availabl… - #36

Open
DominikWojtanowski wants to merge 1 commit into
mainfrom
Endpoint-docs-35
Open

chore(docs): added documentation for endpoints, it should be availabl…#36
DominikWojtanowski wants to merge 1 commit into
mainfrom
Endpoint-docs-35

Conversation

@DominikWojtanowski

Copy link
Copy Markdown
Collaborator

This PR closes #35

Summary of changes:

  • added documentation on every endpoint, the documentation describes:
  1. Purpose of each endpoint
  2. Description if needed
  3. Whether you need to send data in specific way
  4. Parameters if needed
  5. Returning results / exceptions

The docs don't cover code, only endpoints, if I need to document code as well let me know.
You can access documentation at: https://intona-production.up.railway.app/docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Endpoint docs

2 participants