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

Author: MelissaFrncJrg

Diff for: @vates/types/src/xo.mts

@@ -5,6 +5,7 @@ import type {
   DOMAIN_TYPE,
   HOST_ALLOWED_OPERATIONS,
   HOST_POWER_STATE,
+  NETWORK_OPERATIONS,
   STORAGE_OPERATIONS,
   VDI_OPERATIONS,
   VDI_TYPE,
@@ -211,8 +212,21 @@ export type XoHostPatch = BaseXapiXo & {
 }
 
 export type XoNetwork = BaseXapiXo & {
+  automatic: boolean
+  bridge: string
+  current_operations?: Record<string, NETWORK_OPERATIONS>
+  defaultIsLocked: boolean
   id: Branded<'network'>
+  insecureNbd: boolean
+  MTU: number
+  name_description: string
+  name_label: string
+  nbd: boolean
+  other_config: Record<string, string>
+  PIFs: XoPif['id'][]
+  tags: string[]
   type: 'network'
+  VIFs: XoVif['id'][]
 }
 
 export type XoPbd = BaseXapiXo & {

Diff for: @xen-orchestra/rest-api/src/open-api/networks/network.controller.mts

@@ -0,0 +1,47 @@
+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'
+
+@Route('networks')
+@Response(unauthorizedResp.status, unauthorizedResp.description)
+@Tags('networks')
+@provide(NetworkController)
+export class NetworkController extends XapiXoController<XoNetwork> {
+  constructor(@inject(RestApi) restApi: RestApi) {
+    super('network', restApi)
+  }
+
+  /**
+   * @example fields "name_label,id"
+   * @example filter "nbd?"
+   * @example limit 42
+   */
+  @Example(networkIds)
+  @Example(partialNetworks)
+  @Get('')
+  getNewtorks(
+    @Request() req: ExRequest,
+    @Query() fields?: string,
+    @Query() filter?: string,
+    @Query() limit?: number
+  ): string[] | WithHref<Partial<Unbrand<XoNetwork>>>[] {
+    return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req)
+  }
+
+  /**
+   * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+   */
+  @Example(network)
+  @Get('{id}')
+  @Response(notFoundResp.status, notFoundResp.description)
+  getNewtork(@Path() id: string): Unbrand<XoNetwork> {
+    return this.getObject(id as XoNetwork['id'])
+  }
+}

Diff for: @xen-orchestra/rest-api/src/open-api/oa-examples/network.oa-example.mts

@@ -0,0 +1,53 @@
+export const networkIds = [
+  '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+  '/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+]
+
+export const partialNetworks = [
+  {
+    name_label: 'Host internal management network',
+    id: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+    href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+  },
+  {
+    name_label: 'Lab v2 (VLAN 11)',
+    id: '6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+    href: '/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+  },
+]
+
+export const network = {
+  automatic: false,
+  bridge: 'xenapi',
+  current_operations: {},
+  defaultIsLocked: false,
+  MTU: 1500,
+  name_description:
+    'Network on which guests will be assigned a private link-local IP address which can be used to talk XenAPI',
+  name_label: 'Host internal management network',
+  other_config: {
+    is_guest_installer_network: 'true',
+    is_host_internal_management_network: 'true',
+    ip_begin: '169.254.0.1',
+    ip_end: '169.254.255.254',
+    netmask: '255.255.0.0',
+  },
+  tags: [],
+  PIFs: [],
+  VIFs: [
+    '2d039fc8-e522-75db-34c9-536b9553bd5a',
+    '38623621-d30e-0307-dcef-eb7ed6c69f0c',
+    'cc4b090f-5ff1-254b-558f-f7ac237e6fc5',
+    'a9f3d042-a2e1-102f-74fc-ff1df41c6eb3',
+  ],
+  nbd: false,
+  insecureNbd: false,
+  id: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+  type: 'network',
+  uuid: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+  $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+  $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+  _xapiRef: 'OpaqueRef:eb906e77-2221-5399-4a26-60f0ad069b61',
+  messages_href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f/messages',
+  alarms_href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f/alarms',
+}

Diff for: packages/xo-server/src/xo-mixins/rest-api.mjs

@@ -607,6 +607,7 @@ export default class RestApi {
     // add migrated collections to maintain their discoverability
     const swaggerEndpoints = {
       docs: {},
+      networks: {},
       vifs: {},
       vms: {
         actions: {