Skip to content

Add Swagger API Docs #146

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Jan 16, 2023
Merged

Add Swagger API Docs #146

merged 7 commits into from
Jan 16, 2023

Conversation

@dhurley
Copy link
Collaborator

@dhurley dhurley commented Dec 12, 2022 •
edited
Loading

Proposed changes

Swagger docs are now generated from the code.

Screenshot 2022-12-12 at 15 09 08

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md)

@netlify
Copy link

netlify bot commented Dec 12, 2022 •
edited
Loading

✅ Deploy Preview for agent-public-docs canceled.

Name Link
🔨 Latest commit dd93bb2
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/63c554b2dc73110009d73c0e

@dhurley dhurley self-assigned this Dec 12, 2022
@github-actions github-actions bot added dependencies documentation Improvements or additions to documentation labels Dec 12, 2022
@oliveromahony
Copy link
Contributor

oliveromahony commented Dec 16, 2022

@dhurley @mtbChef does this need a README update to show how to generate the swagger correctly?

@mtbChef
Copy link

mtbChef commented Dec 16, 2022 •
edited
Loading

@dhurley @mtbChef does this need a README update to show how to generate the swagger correctly?

Definitely. @dhurley what are the steps for starting the webserver or viewing swagger.json file? Once I have that I can add to README or you can add it and I'll take an editing pass. Either way is fine.

@dhurley dhurley merged commit 551d2a7 into main Jan 16, 2023
@dhurley dhurley deleted the add-api-docs branch January 16, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@craigell craigell craigell approved these changes

@aphralG aphralG aphralG approved these changes

@oliveromahony oliveromahony Awaiting requested review from oliveromahony

@mtbChef mtbChef Awaiting requested review from mtbChef

+1 more reviewer

@Dean-Coakley Dean-Coakley Dean-Coakley approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@dhurley dhurley

Labels

dependencies documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@dhurley @oliveromahony @mtbChef @Dean-Coakley @craigell @aphralG