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

feat(docs): add generated openapi docs #7975

Merged
merged 17 commits into from
Oct 10, 2023
Merged

feat(docs): add generated openapi docs #7975

merged 17 commits into from
Oct 10, 2023

Conversation

lahabana
Copy link
Contributor

@lahabana lahabana commented Oct 6, 2023

Checklist prior to review

  • Link to relevant issue as well as docs and UI issues --
  • This will not break child repos: it doesn't hardcode values (.e.g "kumahq" as a image registry) and it will work on Windows, system specific functions like syscall.Mkfifo have equivalent implementation on the other OS --
  • Tests (Unit test, E2E tests, manual test on universal and k8s) --
  • Do you need to update UPGRADE.md? --
  • Does it need to be backported according to the backporting policy? (this GH action will add "backport" label based on these file globs, if you want to prevent it from adding the "backport" label use no-backport-autolabel label) --
  • Do you need to explicitly set a > Changelog: entry here or add a ci/ label to run fewer/more tests?

@lahabana lahabana requested a review from a team as a code owner October 6, 2023 10:35
@lahabana lahabana requested review from Automaat and bartsmykla and removed request for a team October 6, 2023 10:35
@lahabana lahabana changed the title Better open api feat(docs): add generated openapi docs Oct 6, 2023
@lahabana lahabana mentioned this pull request Oct 6, 2023
Merged
@lahabana
Copy link
Contributor Author

lahabana commented Oct 6, 2023

!!!! This needs an actual release of the image once: kumahq/ci-tools#31 is merged
I've also provided the connection point to enable entreprise to use it too

@lahabana lahabana added the ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) label Oct 6, 2023
@lahabana lahabana force-pushed the betterOpenAPI branch 3 times, most recently from b59e2bf to e74187a Compare October 9, 2023 13:47
@lahabana lahabana added ci/skip-e2e-test PR: Don't run e2e tests and removed ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) labels Oct 9, 2023
@lahabana lahabana removed the ci/skip-e2e-test PR: Don't run e2e tests label Oct 9, 2023
bartsmykla
bartsmykla approved these changes Oct 10, 2023
View reviewed changes
Copy link
Contributor

@bartsmykla bartsmykla left a comment

Choose a reason for hiding this comment

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

One nit but LGTM overall.

mk/docs.mk Outdated Show resolved Hide resolved
lahabana added 12 commits October 10, 2023 12:13
@lahabana
ci(openapi): improve some of the openapi generated
22bdd9c 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
feat(docs): generate openapi spec
bb9fd56 
Use all openapis in the repo to generate a complete
1 file version in `docs/generated/openapi.yaml`

Part of kumahq#318

Signed-off-by: Charly Molter <[email protected]>
@lahabana
add tree to debug
f7ade92 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
all
9ffcf07 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
experiment
44ff21a 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
more experiments
eee156d 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
more troubelshooting
166e890 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
troubleshooting
04c4f3b 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
more test
8fb132f 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
another XP
576238c 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
PR review
40f4e7f 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
try to start remote docker later
8dd4a6c 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
try vm-xlarge
5b772c9 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
don't switch test to vm
43e6378 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
fix
6e8b13e 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
use actual released image
9ecd139 
Signed-off-by: Charly Molter <[email protected]>
@lahabana
PR review
c32cf22 
Signed-off-by: Charly Molter <[email protected]>
@lahabana lahabana enabled auto-merge (squash) October 10, 2023 10:32
@lahabana lahabana merged commit 65a5e0c into kumahq:master Oct 10, 2023
lahabana added a commit that referenced this pull request Oct 11, 2023
@lahabana
Revert "feat(docs): add generated openapi docs (#7975)"
337ec0d 
This reverts commit 65a5e0c.
@lahabana lahabana mentioned this pull request Oct 11, 2023
Closed
lahabana added a commit that referenced this pull request Oct 11, 2023
@lahabana
Revert "feat(docs): add generated openapi docs (#7975)"
215f440 
This reverts commit 65a5e0c.

Signed-off-by: Charly Molter <[email protected]>
@BrewTestBot BrewTestBot mentioned this pull request Nov 15, 2023
Merged
@lahabana lahabana deleted the betterOpenAPI branch March 29, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bartsmykla bartsmykla bartsmykla approved these changes

@Automaat Automaat Automaat approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lahabana @Automaat @bartsmykla