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

Create official api docs #489

Closed
3 tasks done
leepeuker opened this issue Sep 2, 2023 · 1 comment · Fixed by #494
Closed
3 tasks done

Create official api docs #489

leepeuker opened this issue Sep 2, 2023 · 1 comment · Fixed by #494
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@leepeuker
Copy link
Owner

leepeuker commented Sep 2, 2023

The documentation of the latest version is currently published here: docs.movary.org

I think the openapi documentation of the latest version should be published similarly at api.movary.org (read only mode, there is no server to try out against).

Totdo:

  • setup webhost for openapi UI
  • publish latest version on new releases
  • add new api page info to docs
@leepeuker leepeuker added the documentation Improvements or additions to documentation label Sep 2, 2023
@leepeuker leepeuker self-assigned this Sep 2, 2023
@leepeuker
Copy link
Owner Author

Current setup:

  • api.movary.org is hosted via nginx
  • nginx is serving only two files
    • the swagger-ui html page
    • the openapi.json

The swagger UI is set to readonly because there is no application server to try the request out against.

@leepeuker leepeuker linked a pull request Sep 7, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant