@metal-stack/api 0.4.3 → 0.5.1

package/{js/metalstack → metalstack}/admin/v2/network_pb.ts

@@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_network: GenFile = /*@__PURE__*/
  */
 export type NetworkServiceGetRequest = Message<"metalstack.admin.v2.NetworkServiceGetRequest"> & {
   /**
-   * ID of the network to get
+   * ID of the network to get.
    *
    * @generated from field: string id = 1;
    */
@@ -46,7 +46,7 @@ export const NetworkServiceGetRequestSchema: GenMessage<NetworkServiceGetRequest
  */
 export type NetworkServiceGetResponse = Message<"metalstack.admin.v2.NetworkServiceGetResponse"> & {
   /**
-   * Network contains the requested network
+   * Network contains the requested network.
    *
    * @generated from field: metalstack.api.v2.Network network = 1;
    */
@@ -67,119 +67,119 @@ export const NetworkServiceGetResponseSchema: GenMessage<NetworkServiceGetRespon
  */
 export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkServiceCreateRequest"> & {
   /**
-   * Id of this network
+   * Id of this network.
    *
    * @generated from field: optional string id = 1;
    */
   id?: string | undefined;
 
   /**
-   * Name of this network
+   * Name of this network.
    *
    * @generated from field: optional string name = 2;
    */
   name?: string | undefined;
 
   /**
-   * Description of this network
+   * Description of this network.
    *
    * @generated from field: optional string description = 3;
    */
   description?: string | undefined;
 
   /**
-   * Partition where this network will be created
+   * Partition where this network will be created.
    *
    * @generated from field: optional string partition = 4;
    */
   partition?: string | undefined;
 
   /**
-   * Project where this network belongs to
+   * Project where this network belongs to.
    *
    * @generated from field: optional string project = 5;
    */
   project?: string | undefined;
 
   /**
-   * Type of the network to create
+   * Type of the network to create.
    *
    * @generated from field: metalstack.api.v2.NetworkType type = 6;
    */
   type: NetworkType;
 
   /**
-   * Labels on this network
+   * Labels on this network.
    *
    * @generated from field: optional metalstack.api.v2.Labels labels = 7;
    */
   labels?: Labels | undefined;
 
   /**
-   * Prefixes in this network
+   * Prefixes in this network.
    *
    * @generated from field: repeated string prefixes = 8;
    */
   prefixes: string[];
 
   /**
-   * Destination Prefixes in this network
+   * Destination Prefixes in this network.
    *
    * @generated from field: repeated string destination_prefixes = 9;
    */
   destinationPrefixes: string[];
 
   /**
-   * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request
+   * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request.
    *
    * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10;
    */
   defaultChildPrefixLength?: ChildPrefixLength | undefined;
 
   /**
-   * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length
+   * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.
    *
    * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11;
    */
   minChildPrefixLength?: ChildPrefixLength | undefined;
 
   /**
-   * NATType of this network
+   * NATType of this network.
    *
    * @generated from field: optional metalstack.api.v2.NATType nat_type = 12;
    */
   natType?: NATType | undefined;
 
   /**
-   * VRF of this network has this VNI
+   * VRF of this network has this VNI.
    *
    * @generated from field: optional uint32 vrf = 13;
    */
   vrf?: number | undefined;
 
   /**
-   * Parent Network points to the id of the parent network if any
+   * Parent Network points to the id of the parent network if any.
    *
    * @generated from field: optional string parent_network = 14;
    */
   parentNetwork?: string | undefined;
 
   /**
-   * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced
+   * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.
    *
    * @generated from field: repeated string additional_announcable_cidrs = 15;
    */
   additionalAnnouncableCidrs: string[];
 
   /**
-   * Length per addressfamily
+   * Length per addressfamily.
    *
    * @generated from field: optional metalstack.api.v2.ChildPrefixLength length = 16;
    */
   length?: ChildPrefixLength | undefined;
 
   /**
-   * AddressFamily to create, defaults to the same as the parent
+   * AddressFamily to create, defaults to the same as the parent.
    *
    * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 17;
    */
@@ -200,77 +200,77 @@ export const NetworkServiceCreateRequestSchema: GenMessage<NetworkServiceCreateR
  */
 export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkServiceUpdateRequest"> & {
   /**
-   * Id of this network
+   * Id of this network.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * UpdateMeta contains the timestamp and strategy to be used in this update request
+   * UpdateMeta contains the timestamp and strategy to be used in this update request.
    *
    * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2;
    */
   updateMeta?: UpdateMeta | undefined;
 
   /**
-   * Name of this network
+   * Name of this network.
    *
    * @generated from field: optional string name = 3;
    */
   name?: string | undefined;
 
   /**
-   * Description of this network
+   * Description of this network.
    *
    * @generated from field: optional string description = 4;
    */
   description?: string | undefined;
 
   /**
-   * Labels to update on this network
+   * Labels to update on this network.
    *
    * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 5;
    */
   labels?: UpdateLabels | undefined;
 
   /**
-   * Prefixes in this network
+   * Prefixes in this network.
    *
    * @generated from field: repeated string prefixes = 6;
    */
   prefixes: string[];
 
   /**
-   * Destination Prefixes in this network
+   * Destination Prefixes in this network.
    *
    * @generated from field: repeated string destination_prefixes = 7;
    */
   destinationPrefixes: string[];
 
   /**
-   * Default Child Prefix length defines the bit length of a child network created per addressfamily, if not specified during the allocate request
+   * Default Child Prefix length defines the bit length of a child network created per addressfamily, if not specified during the allocate request.
    *
    * @generated from field: optional metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 8;
    */
   defaultChildPrefixLength?: ChildPrefixLength | undefined;
 
   /**
-   * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length
+   * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.
    *
    * @generated from field: optional metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 9;
    */
   minChildPrefixLength?: ChildPrefixLength | undefined;
 
   /**
-   * NATType of this network
+   * NATType of this network.
    *
    * @generated from field: optional metalstack.api.v2.NATType nat_type = 10;
    */
   natType?: NATType | undefined;
 
   /**
-   * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced
+   * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.
    *
    * @generated from field: repeated string additional_announcable_cidrs = 11;
    */
@@ -298,7 +298,7 @@ export const NetworkServiceUpdateRequestSchema: GenMessage<NetworkServiceUpdateR
  */
 export type NetworkServiceDeleteRequest = Message<"metalstack.admin.v2.NetworkServiceDeleteRequest"> & {
   /**
-   * ID of the network to get
+   * ID of the network to get.
    *
    * @generated from field: string id = 1;
    */
@@ -319,7 +319,7 @@ export const NetworkServiceDeleteRequestSchema: GenMessage<NetworkServiceDeleteR
  */
 export type NetworkServiceListRequest = Message<"metalstack.admin.v2.NetworkServiceListRequest"> & {
   /**
-   * Query specifies which networks to return
+   * Query specifies which networks to return.
    *
    * @generated from field: metalstack.api.v2.NetworkQuery query = 1;
    */
@@ -340,7 +340,7 @@ export const NetworkServiceListRequestSchema: GenMessage<NetworkServiceListReque
  */
 export type NetworkServiceCreateResponse = Message<"metalstack.admin.v2.NetworkServiceCreateResponse"> & {
   /**
-   * Network contains the created network
+   * Network contains the created network.
    *
    * @generated from field: metalstack.api.v2.Network network = 1;
    */
@@ -361,7 +361,7 @@ export const NetworkServiceCreateResponseSchema: GenMessage<NetworkServiceCreate
  */
 export type NetworkServiceUpdateResponse = Message<"metalstack.admin.v2.NetworkServiceUpdateResponse"> & {
   /**
-   * Network contains the updated network
+   * Network contains the updated network.
    *
    * @generated from field: metalstack.api.v2.Network network = 1;
    */
@@ -382,7 +382,7 @@ export const NetworkServiceUpdateResponseSchema: GenMessage<NetworkServiceUpdate
  */
 export type NetworkServiceDeleteResponse = Message<"metalstack.admin.v2.NetworkServiceDeleteResponse"> & {
   /**
-   * Network contains the deleted network
+   * Network contains the deleted network.
    *
    * @generated from field: metalstack.api.v2.Network network = 1;
    */
@@ -403,7 +403,7 @@ export const NetworkServiceDeleteResponseSchema: GenMessage<NetworkServiceDelete
  */
 export type NetworkServiceListResponse = Message<"metalstack.admin.v2.NetworkServiceListResponse"> & {
   /**
-   * Networks contains the list of networks
+   * Networks contains the list of networks.
    *
    * @generated from field: repeated metalstack.api.v2.Network networks = 1;
    */

package/{js/metalstack → metalstack}/admin/v2/partition_pb.d.ts

@@ -7,13 +7,13 @@ import type { Message } from "@bufbuild/protobuf";
  */
 export declare const file_metalstack_admin_v2_partition: GenFile;
 /**
- * PartitionServiceCreateRequest is the request payload for a partition create request
+ * PartitionServiceCreateRequest is the request payload for a partition create request.
  *
  * @generated from message metalstack.admin.v2.PartitionServiceCreateRequest
  */
 export type PartitionServiceCreateRequest = Message<"metalstack.admin.v2.PartitionServiceCreateRequest"> & {
     /**
-     * Partition the partition
+     * Partition the partition.
      *
      * @generated from field: metalstack.api.v2.Partition partition = 1;
      */
@@ -31,50 +31,50 @@ export declare const PartitionServiceCreateRequestSchema: GenMessage<PartitionSe
  */
 export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.PartitionServiceUpdateRequest"> & {
     /**
-     * ID of this partition
+     * ID of this partition.
      *
      * @generated from field: string id = 1;
      */
     id: string;
     /**
-     * UpdateMeta contains the timestamp and strategy to be used in this update request
+     * UpdateMeta contains the timestamp and strategy to be used in this update request.
      *
      * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2;
      */
     updateMeta?: UpdateMeta | undefined;
     /**
-     * Description of this partition
+     * Description of this partition.
      *
      * @generated from field: optional string description = 3;
      */
     description?: string | undefined;
     /**
-     * PartitionBootConfiguration defines how metal-hammer boots
+     * PartitionBootConfiguration defines how metal-hammer boots.
      *
      * @generated from field: metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4;
      */
     bootConfiguration?: PartitionBootConfiguration | undefined;
     /**
-     * DNSServers for this partition
+     * DNSServers for this partition.
      *
      * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 5;
      */
     dnsServers: DNSServer[];
     /**
-     * NTPServers for this partition
+     * NTPServers for this partition.
      *
      * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 6;
      */
     ntpServers: NTPServer[];
     /**
-     * ManagementServiceAddresses defines where the management is reachable
-     * must be in the form <ip|host>:<port>
+     * ManagementServiceAddresses defines where the management is reachable.
+     * must be in the form <ip|host>:<port>.
      *
      * @generated from field: repeated string mgmt_service_addresses = 7;
      */
     mgmtServiceAddresses: string[];
     /**
-     * Labels to update on this network
+     * Labels to update on this network.
      *
      * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 8;
      */
@@ -86,13 +86,13 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti
  */
 export declare const PartitionServiceUpdateRequestSchema: GenMessage<PartitionServiceUpdateRequest>;
 /**
- * PartitionServiceDeleteRequest is the request payload for a partition delete request
+ * PartitionServiceDeleteRequest is the request payload for a partition delete request.
  *
  * @generated from message metalstack.admin.v2.PartitionServiceDeleteRequest
  */
 export type PartitionServiceDeleteRequest = Message<"metalstack.admin.v2.PartitionServiceDeleteRequest"> & {
     /**
-     * ID of the partition to delete
+     * ID of the partition to delete.
      *
      * @generated from field: string id = 1;
      */
@@ -104,13 +104,13 @@ export type PartitionServiceDeleteRequest = Message<"metalstack.admin.v2.Partiti
  */
 export declare const PartitionServiceDeleteRequestSchema: GenMessage<PartitionServiceDeleteRequest>;
 /**
- * PartitionServiceCreateResponse is the response payload for a partition create request
+ * PartitionServiceCreateResponse is the response payload for a partition create request.
  *
  * @generated from message metalstack.admin.v2.PartitionServiceCreateResponse
  */
 export type PartitionServiceCreateResponse = Message<"metalstack.admin.v2.PartitionServiceCreateResponse"> & {
     /**
-     * Partition the partition
+     * Partition the partition.
      *
      * @generated from field: metalstack.api.v2.Partition partition = 1;
      */
@@ -122,13 +122,13 @@ export type PartitionServiceCreateResponse = Message<"metalstack.admin.v2.Partit
  */
 export declare const PartitionServiceCreateResponseSchema: GenMessage<PartitionServiceCreateResponse>;
 /**
- * PartitionServiceUpdateResponse is the response payload for a partition update request
+ * PartitionServiceUpdateResponse is the response payload for a partition update request.
  *
  * @generated from message metalstack.admin.v2.PartitionServiceUpdateResponse
  */
 export type PartitionServiceUpdateResponse = Message<"metalstack.admin.v2.PartitionServiceUpdateResponse"> & {
     /**
-     * Partition the partition
+     * Partition the partition.
      *
      * @generated from field: metalstack.api.v2.Partition partition = 1;
      */
@@ -146,7 +146,7 @@ export declare const PartitionServiceUpdateResponseSchema: GenMessage<PartitionS
  */
 export type PartitionServiceDeleteResponse = Message<"metalstack.admin.v2.PartitionServiceDeleteResponse"> & {
     /**
-     * Partition contains the deleted partition
+     * Partition contains the deleted partition.
      *
      * @generated from field: metalstack.api.v2.Partition partition = 1;
      */
@@ -164,19 +164,19 @@ export declare const PartitionServiceDeleteResponseSchema: GenMessage<PartitionS
  */
 export type PartitionServiceCapacityRequest = Message<"metalstack.admin.v2.PartitionServiceCapacityRequest"> & {
     /**
-     * ID of the partition to get
+     * ID of the partition to get.
      *
      * @generated from field: optional string id = 1;
      */
     id?: string | undefined;
     /**
-     * Size of machines to show the capacity
+     * Size of machines to show the capacity.
      *
      * @generated from field: optional string size = 2;
      */
     size?: string | undefined;
     /**
-     * Project of machines to show the capacity
+     * Project of machines to show the capacity.
      *
      * @generated from field: optional string project = 3;
      */
@@ -188,13 +188,13 @@ export type PartitionServiceCapacityRequest = Message<"metalstack.admin.v2.Parti
  */
 export declare const PartitionServiceCapacityRequestSchema: GenMessage<PartitionServiceCapacityRequest>;
 /**
- * PartitionServiceCapacityResponse is the response payload for a partition capacity request
+ * PartitionServiceCapacityResponse is the response payload for a partition capacity request.
  *
  * @generated from message metalstack.admin.v2.PartitionServiceCapacityResponse
  */
 export type PartitionServiceCapacityResponse = Message<"metalstack.admin.v2.PartitionServiceCapacityResponse"> & {
     /**
-     * PartitionCapacity is a capacity report per partition
+     * PartitionCapacity is a capacity report per partition.
      *
      * @generated from field: repeated metalstack.admin.v2.PartitionCapacity partition_capacity = 1;
      */
@@ -206,7 +206,7 @@ export type PartitionServiceCapacityResponse = Message<"metalstack.admin.v2.Part
  */
 export declare const PartitionServiceCapacityResponseSchema: GenMessage<PartitionServiceCapacityResponse>;
 /**
- * PartitionCapacity is the capacity of one partition
+ * PartitionCapacity is the capacity of one partition.
  *
  * @generated from message metalstack.admin.v2.PartitionCapacity
  */
@@ -230,7 +230,7 @@ export type PartitionCapacity = Message<"metalstack.admin.v2.PartitionCapacity">
  */
 export declare const PartitionCapacitySchema: GenMessage<PartitionCapacity>;
 /**
- * ServerCapacity is the capacity of one server type, eg machine size
+ * ServerCapacity is the capacity of one server type, eg machine size.
  *
  * @generated from message metalstack.admin.v2.MachineSizeCapacity
  */
@@ -292,7 +292,7 @@ export type MachineSizeCapacity = Message<"metalstack.admin.v2.MachineSizeCapaci
      */
     free: bigint;
     /**
-     * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or
+     * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or.
      * not in the machine state "available", e.g. locked or reserved.
      *
      * @generated from field: int64 unavailable = 11;