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.

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

docs: better openapi spec #4397

Merged
merged 14 commits into from
Dec 9, 2024
Merged

docs: better openapi spec #4397

merged 14 commits into from
Dec 9, 2024

Conversation

dabeeeenster
Copy link
Contributor

@dabeeeenster dabeeeenster commented Jul 26, 2024 •
edited
Loading

@dabeeeenster dabeeeenster requested a review from a team as a code owner July 26, 2024 08:29
@dabeeeenster dabeeeenster requested review from a team, khvn26 and agregoryfs and removed request for a team July 26, 2024 08:29
@vercel Vercel
Copy link

vercel bot commented Jul 26, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 11:53am
flagsmith-frontend-preview ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 11:53am
flagsmith-frontend-staging ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 11:53am

@github-actions github-actions bot added the docs Documentation updates label Jul 26, 2024
@dabeeeenster dabeeeenster marked this pull request as draft July 26, 2024 08:30
kyle-ssg
kyle-ssg reviewed Jul 31, 2024
View reviewed changes
docs/static/openapi/edge-api.yaml Outdated
@@ -0,0 +1,225 @@
openapi: 3.0.3
Copy link
Member

@kyle-ssg kyle-ssg Jul 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Do we need a note saying this is for interaction with our SDK endpoints / link to admin API swagger for other functions? I think as a first time user clicking API from docs it looks like these are the only apis we offer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added an overview page that makes things clearer here

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Aug 2, 2024
@dabeeeenster dabeeeenster marked this pull request as ready for review August 2, 2024 13:04
@dabeeeenster dabeeeenster requested a review from kyle-ssg August 2, 2024 13:04
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Aug 2, 2024
khvn26
khvn26 requested changes Aug 29, 2024
View reviewed changes
Copy link
Member

@khvn26 khvn26 left a comment

Choose a reason for hiding this comment

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

Sorry for the long wait — dropped a couple comments.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 3, 2024 •
edited
Loading

Uffizzi Preview deployment-58767 was deleted.

@codecov Codecov
Copy link

codecov bot commented Dec 3, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.38%. Comparing base (05ab7cf) to head (7f9e364).
Report is 12 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #4397   +/-   ##
=======================================
  Coverage   97.38%   97.38%           
=======================================
  Files        1189     1189           
  Lines       41420    41453   +33     
=======================================
+ Hits        40338    40371   +33     
  Misses       1082     1082

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 6, 2024
matthewelwell
matthewelwell reviewed Dec 6, 2024
View reviewed changes
.github/workflows/docs-pull-request.yml Show resolved Hide resolved
docs/static/openapi/edge-api.yaml Outdated Show resolved Hide resolved
docs/static/openapi/edge-api.yaml Outdated Show resolved Hide resolved
@matthewelwell matthewelwell requested review from khvn26 and removed request for agregoryfs December 6, 2024 10:46
@matthewelwell matthewelwell requested a review from khvn26 December 9, 2024 10:12
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 9, 2024
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 9, 2024
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 9, 2024
@matthewelwell matthewelwell merged commit 60db529 into main Dec 9, 2024
36 checks passed
@matthewelwell matthewelwell deleted the docs/better-openapi-spec branch December 9, 2024 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewelwell matthewelwell matthewelwell left review comments

@kyle-ssg kyle-ssg Awaiting requested review from kyle-ssg

@khvn26 khvn26 Awaiting requested review from khvn26

Assignees

@matthewelwell matthewelwell

Labels
docs Documentation updates
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dabeeeenster @khvn26 @kyle-ssg @matthewelwell