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

feat: project documentation #173

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

cakeinsauce
Copy link
Collaborator

@cakeinsauce cakeinsauce commented Jan 6, 2023

Closes #150

  • Add swagger ui for github pages
  • Add cli commands for every service using Badgerdoc CLI package. Add to dockerfile
  • Add github actions to generate docs on updates
  • Remove redundant tags for some of endpoints
  • Create badgerdoc cli package
  • Add github actions for badgerdoc cli

Known issue: annotation service has pydantic models with set fields their examples. Because sets do not preserve order, when we compare identical openapi specs with differently ordered sets transformed to lists, GH actions create a new commit as it was changed.
E.g.

   "example": [
       "b44156f8-e634-48a6-b5f3-c8b1462a2d67",
       "f0474853-f733-41c0-b897-90b788b822e3"
   ]
...
   "example": [
       "f0474853-f733-41c0-b897-90b788b822e3",
       "b44156f8-e634-48a6-b5f3-c8b1462a2d67"
    ]

@cakeinsauce cakeinsauce added the documentation Improvements or additions to documentation label Jan 6, 2023
@cakeinsauce cakeinsauce self-assigned this Jan 6, 2023
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch 2 times, most recently from fd78e48 to 7722edd Compare January 30, 2023 13:02
@cakeinsauce cakeinsauce changed the title [WIP] feat: project documentation feat: project documentation Feb 7, 2023
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch 2 times, most recently from 9e3d27d to 0819b9b Compare February 7, 2023 18:06
Added swagger ui for github pages; added github actions with periodic task to update openapi specs
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from e65b2cc to c91b1d1 Compare March 26, 2023 18:20
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from 6fbf6f6 to 02d98b6 Compare March 30, 2023 17:39
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch 3 times, most recently from beaf9cf to ecff0e7 Compare March 30, 2023 18:30
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from ecff0e7 to 55ca671 Compare March 30, 2023 18:33
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from 0f155f2 to 4e84915 Compare March 30, 2023 19:13
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from 4e84915 to abf770d Compare March 30, 2023 19:15
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from 9cab634 to ac72f19 Compare March 30, 2023 21:25
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch 2 times, most recently from 4183655 to cbbb2c0 Compare March 30, 2023 21:36
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from cbbb2c0 to 23bd13b Compare March 30, 2023 21:42
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from d3f71d2 to e31ce61 Compare March 31, 2023 00:53
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from e31ce61 to 4cc0835 Compare March 31, 2023 00:57
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from c2267e5 to da3852c Compare March 31, 2023 13:00
@cakeinsauce cakeinsauce force-pushed the feat/project-documentation#150 branch from da3852c to 4f6c018 Compare March 31, 2023 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation for public endpoints
1 participant