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

WIP: REST-API with auto-generated swagger documentation #8249

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from

Conversation

MathieuRA
Copy link
Member

@MathieuRA MathieuRA commented Jan 14, 2025

Screenshot

Capture d’écran de 2025-01-14 21-48-58

Description

  • Typescript
  • openAPI + swagger
  • CI + eslint + ts type check
  • XAPI object reactivity
  • dashboard reactivity
  • dependency injection
  • not found error (vms/fobar)
  • Simple action (like start a VM)
  • More complexe action (import/export)
  • users authentication
  • class inheritance (for classic routes /, /id)
  • Register routes from plugins
  • REST API refacto
  • how to name routes?
    • Eg. Export VDI content? Is an action? (POST /vdis//actions/export_content) or like for now: GET /vdis/.

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 Jan 14, 2025
@irtaza9
Copy link

irtaza9 commented Jan 15, 2025

This will be very helpful regarding the rest-api usage and will low the load on forum regarding rest-apis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants