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

docs(Swagger): Firefox Accounts OAuth Server API documentation #13096

Merged
merged 1 commit into from
Jun 2, 2022

Conversation

xlisachan
Copy link
Contributor

@xlisachan xlisachan commented May 28, 2022

To view documentation on Ecosystem Platform locally

  • Pull down this branch
  • Within docusaurus.config.js of the Ecosystem Platform repo, update the value of spec (ln 39) to http://localhost:9000/swagger.json
  • yarn start Ecosystem Platform
  • Navigate to http://localhost:3000/ecosystem-platform/api

Because

  • we want to autogenerate our OAuth Server API documentation

This pull request

  • moves OAuth Server API endpoints out of Miscellaneous and Oauth sections within Auth Server API Swagger documentation
  • adds the rest of the sections (URL Structure, Request format, Response format, etc) of the Auth Server API documentation into the Swagger docs
  • updates fxa-auth-server/docs/api.md to just link to API doc in Ecosystem Platform
  • adds OAuth Server API Swagger documentation
  • adds and updates descriptions
  • updates fxa-auth-server/docs/oauth/api.md to just link to API doc in Ecosystem Platform
  • adds PR notes from Ben

Reference

Issue that this pull request solves

Closes: #12962

Checklist

Put an x in the boxes that apply

  • My commit is GPG signed.

Screenshots (Optional)

Screen Shot 2022-05-31 at 11 35 14 AM

Other information (Optional)

Any other information that is important to this pull request.

@xlisachan xlisachan force-pushed the swagger_oauth branch 2 times, most recently from c028b5a to 639f097 Compare May 28, 2022 00:46
@xlisachan xlisachan force-pushed the swagger_oauth branch 2 times, most recently from 5e7fde2 to 0a974c0 Compare May 28, 2022 18:55
@xlisachan xlisachan changed the title docs(Swagger): Firefox Accounts OAuth Server API documenation - WIP docs(Swagger): Firefox Accounts OAuth Server API documentation - WIP May 28, 2022
@xlisachan xlisachan force-pushed the swagger_oauth branch 4 times, most recently from 010c1a5 to 9552a76 Compare May 31, 2022 16:45
@xlisachan xlisachan changed the title docs(Swagger): Firefox Accounts OAuth Server API documentation - WIP docs(Swagger): Firefox Accounts OAuth Server API documentation May 31, 2022
@xlisachan xlisachan marked this pull request as ready for review May 31, 2022 17:36
@xlisachan xlisachan requested a review from a team as a code owner May 31, 2022 17:36
@xlisachan xlisachan merged commit dcbca01 into main Jun 2, 2022
@xlisachan xlisachan deleted the swagger_oauth branch August 2, 2022 14:28
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.

Generate Swagger docs for the OAuth Server API
3 participants