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

Improve Central API docs #1646

Open
4 tasks
lognaturel opened this issue Sep 11, 2023 · 0 comments
Open
4 tasks

Improve Central API docs #1646

lognaturel opened this issue Sep 11, 2023 · 0 comments

Comments

@lognaturel
Copy link
Member

  • The output when extended metadata can be requested is really confusing. It looks like the example is always the extended one. And then the schema shows two arrays with no indication of what they mean. I think ideally they would be shown as two separate example/schema pairs, like in Apiary previously. I think the issue might be in the conversion to OpenAPI. I also notice that the following example/schema pair sometimes has json/extended as the content type (e.g. a 403)
  • It would be nice to style text surrounded by backticks in parameter tables (code)
  • Build some light tooling to manage multiple versions and allow users to navigate between them.
  • Run tests in CI
@lognaturel lognaturel assigned lognaturel and unassigned lognaturel Sep 11, 2023
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

No branches or pull requests

1 participant