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

fix(swagger): Revise API docs for redocusaurus support #12932

Merged
merged 1 commit into from May 23, 2022
Merged

Conversation

xlisachan
Copy link
Contributor

@xlisachan xlisachan commented May 18, 2022

Because:

  • values set for description and notes in hapi-swagger are converted to values for summary and description, respectively, in the autogenerated swagger.json file. This causes endpoints to be mislabeled with redocusaurus

This commit:

  • revises the values of description and notes for all endpoints in the API docs
  • removes mention of HAWK as it is no longer utilized
  • adds tags array to swagger-options.ts to allow redocusaurus to sort tags alphabetically
  • removes .label() as redocusaurus does not utilize it

Checklist

Put an x in the boxes that apply

  • My commit is GPG signed.
  • If applicable, I have modified or added tests which pass locally.
  • I have added necessary documentation (if appropriate).
  • I have verified that my changes render correctly in RTL (if appropriate).

Screenshots (Optional)

BEFORE
Screen Shot 2022-05-18 at 2 34 03 PM

AFTER
Screen Shot 2022-05-18 at 2 31 26 PM

Copy link
Member

@clouserw clouserw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates

@xlisachan xlisachan force-pushed the revise_swagger branch 2 times, most recently from ef73356 to c1c4e92 Compare May 19, 2022 16:47
@xlisachan
Copy link
Contributor Author

xlisachan commented May 19, 2022

@LZoog - .label()s were previously added to identify/differentiate the models (e.g., payload, query, response, schema, etc) within the Swagger API documentation, but it does not look like redocusaurus utilizes this feature (I could be missing it). I went ahead and removed them in commit 76aec10 though. If they should be kept in, I can just drop the commit. :)

Because:

* values set for description and notes in hapi-swagger are converted to values for summary and description, respectively, in the autogenerated swagger.json file. This causes endpoints to be mislabeled with redocusaurus

This commit:

* revises the values of description and notes for all endpoints
@xlisachan xlisachan merged commit 2defe28 into main May 23, 2022
@xlisachan xlisachan deleted the revise_swagger branch May 23, 2022 15:53
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

Successfully merging this pull request may close these issues.

None yet

2 participants