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.

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

endpoint @description.markdown #10

Open
kmilodenisglez opened this issue Nov 25, 2022 · 0 comments
Open

endpoint @description.markdown #10

kmilodenisglez opened this issue Nov 25, 2022 · 0 comments
Assignees
Labels
invalid This doesn't seem right

Comments

@kmilodenisglez
Copy link
Member

You need to add the endpoint descriptions, they must be added to the docs/md_endpoints/ folder, that one for each endpoint.

For the swagger to detect them, it must be included in the endpoint description as a decorator (@). For example: the @description.markdown AuthIntent line of the /auth authentication endpoint is loading the description from docs/md_endpoints/AuthIntent.md.

The endpoints (Transaction, Query and Auth) already have their descriptions.

@kmilodenisglez kmilodenisglez added the invalid This doesn't seem right label Nov 25, 2022
@kmilodenisglez kmilodenisglez pinned this issue Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right
Projects
None yet
Development

No branches or pull requests

2 participants