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

Use OpenAPI Specification language for better Documentation #913

Open
MarquiseRosier opened this issue Jul 13, 2023 · 1 comment
Open

Use OpenAPI Specification language for better Documentation #913

MarquiseRosier opened this issue Jul 13, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@MarquiseRosier
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
currently the documentation for the RUM API is a bit difficult to use; and work with.

Describe the solution you'd like
OpenAPI Specification language to generate documentation for the RUM API. Much easier to engage with; and for our end users!

Raised by David Barrat of the DAAS Team.

@MarquiseRosier MarquiseRosier added the enhancement New feature or request label Jul 13, 2023
@MarquiseRosier MarquiseRosier changed the title Better Documentation Use OpenAPI Specification language for better Documentation Jul 13, 2023
@MarquiseRosier MarquiseRosier self-assigned this Jul 13, 2023
@dbrrt
Copy link
Collaborator

dbrrt commented Jul 14, 2023

@MarquiseRosier Thanks for reporting it.
I'd not say RUM API is difficult to work with, but it's difficult to know what data points are available without OpenAPI specifications, without having to look at the code itself, which is not ideal from a consumer prospective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants