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(@xen-orchestra/rest-api): initial setup for swagger #8316

Merged
merged 6 commits into from
Feb 12, 2025

Conversation

MathieuRA
Copy link
Member

@MathieuRA MathieuRA commented Feb 6, 2025

Screenshot

Capture d’écran de 2025-02-06 17-27-51

Description

The VmController was created because it requires at least one resource to register the swagger interface.

Swagger interface available at /rest/v0
All previous routes are untouched and remain available!

Initial POC #8249

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

@MathieuRA MathieuRA self-assigned this Feb 6, 2025
@MathieuRA MathieuRA requested a review from b-Nollet February 6, 2025 16:44
@b-Nollet b-Nollet requested a review from fbeauchamp February 6, 2025 17:00
@MathieuRA MathieuRA requested a review from b-Nollet February 12, 2025 08:49
@b-Nollet b-Nollet requested a review from fbeauchamp February 12, 2025 09:45
@MathieuRA MathieuRA merged commit 877ca82 into master Feb 12, 2025
1 check passed
@MathieuRA MathieuRA deleted the setup-openapi branch February 12, 2025 13:09
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.

4 participants