Skip to content

feat(@xen-orchestra/rest-api): expose get networks and get network #8497

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

MelissaFrncJrg
Copy link
Contributor

Description

Short explanation of this PR (feel free to re-use commit message)

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.

@MelissaFrncJrg MelissaFrncJrg marked this pull request as ready for review April 9, 2025 11:31
@MelissaFrncJrg MelissaFrncJrg requested a review from b-Nollet April 9, 2025 11:31
@b-Nollet b-Nollet requested a review from MathieuRA April 10, 2025 07:58
Comment on lines +22 to +24
* @example fields "name_label,id"
* @example filter "nbd?"
* @example limit 42
Copy link
Member

Choose a reason for hiding this comment

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

See this #8490 (comment)

Comment on lines +1 to +10
import { Example, Get, Path, Query, Response, Request, Route, Security, Tags } from 'tsoa'
import { inject } from 'inversify'
import { provide } from 'inversify-binding-decorators'
import { Request as ExRequest } from 'express'
import type { XoNetwork } from '@vates/types'
import { RestApi } from '../../rest-api/rest-api.mjs'
import { notFoundResp, unauthorizedResp, Unbrand } from '../common/response.common.mjs'
import { WithHref } from '../../helpers/helper.type.mjs'
import { XapiXoController } from '../../abstract-classes/xapi-xo-controller.mjs'
import { network, networkIds, partialNetworks } from '../oa-examples/network.oa-example.mjs'
Copy link
Member

Choose a reason for hiding this comment

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

Try to keep import sorted

Comment on lines +51 to +52
messages_href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f/messages',
alarms_href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f/alarms',
Copy link
Member

Choose a reason for hiding this comment

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

?

id: Branded<'network'>
insecureNbd: boolean
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
insecureNbd: boolean
insecureNbd?: boolean

MTU: number
name_description: string
name_label: string
nbd: boolean
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
nbd: boolean
nbd?: boolean

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.

3 participants