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

Route documentation unit test #189

Open
edtanous opened this issue Feb 18, 2021 · 1 comment
Open

Route documentation unit test #189

edtanous opened this issue Feb 18, 2021 · 1 comment

Comments

@edtanous
Copy link
Contributor

Once #181 is resolved, it should be relatively straightforward to write a unit test that greps for BMCWEB_ROUTE instances, and verifies that we have a corresponding instance in the documentation. This should be a relatively easy script to write and put in the unit tests, so new routes without documentation are notified at compile time that they've forgotten their docs updates.

@edtanous
Copy link
Contributor Author

Tried to execute on this recently, and it's very non-trivial.

Series working up to this is here:
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/60832

and involved changes to the Redfish standard, as it didnt' model all URI routes in a consistent way.

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