/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List links * @description List links. A link connects an application to a service instance so the application can use it, so listing links answers which applications consume which services. Filter by --service-id for one service's consumers, or by --nrn to scope the search to part of the hierarchy. */ get: { parameters: { query?: { /** @description Narrow the result to one or more link identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Include the entity's status messages — warnings and errors with a severity level — alongside each result. */ include_messages?: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Status of the link. Should be one of the specified values in the enumeration */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Exclude links with this status, e.g. status:ne=archived hides archived links. Combines with status as AND */ "status:ne"?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Specifies whether to show entities defined in the lower level of the NRN hierarchy */ show_descendants?: boolean; /** @description Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown */ include_secret_attributes?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-32"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a link * @description Create a link */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object representing link instances */ requestBody: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @description Unique identifier for the specification associated with the entity */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Object representing dimensions restrictions with key-value pairs * @default {} */ dimensions?: components["schemas"]["def-8"]; /** * @description Attributes associated with the link, should be valid against the link specification attribute schema * @default {} */ attributes?: Record; /** * @description Key-value object representing link selectors * @default {} */ selectors?: components["schemas"]["def-6"]; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id: components["schemas"]["def-1"]; entity_nrn: components["schemas"]["def-2"]; }; }; }; responses: { /** @description Object representing link instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the link was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/link/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a link * @description Read a link */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link. Get it from 'np link list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing link instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the link was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a link * @description Delete a link */ delete: { parameters: { query?: { /** @description Specifies whether to force delete the link. If set to true, the link will be deleted without checking for delete action existence */ force?: true; }; header?: never; path: { /** @description Identifier of the link. Get it from 'np link list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing link instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the link was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a link * @description Updates a link */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link. Get it from 'np link list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing link instances */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "archived" | "failed" | "cancelled"; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; responses: { /** @description Object representing link instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the link was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/link/{linkId}/action": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List link actions * @description List the actions available on a link. Actions are the operations a link exposes beyond create and delete, declared by its specification. */ get: { parameters: { query?: { /** @description Narrow the result to one or more action identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Include the entity's status messages — warnings and errors with a severity level — alongside each result. */ include_messages?: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Status of the action. Should be one of the specified values in the ActionStatus enumeration */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; }; header?: never; path: { /** @description Identifier of the link this action belongs to. Get it from 'np link list'. */ linkId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-44"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a link action * @description Create a link action */ post: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link this action belongs to. Get it from 'np link list'. */ linkId: string; }; cookie?: never; }; /** @description Object representing instances */ requestBody: { content: { "application/json": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: | components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Parameters associated with the action * @default {} */ parameters?: Record; /** * @description Results produced by the action * @default {} */ results?: Record; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; } | unknown | unknown | unknown; }; }; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/link/{linkId}/action/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a link action * @description Read a link action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the link this action belongs to. Get it from 'np link list'. */ linkId: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a link action * @description Delete a link action */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the link this action belongs to. Get it from 'np link list'. */ linkId: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a link action * @description Update a link action */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the link this action belongs to. Get it from 'np link list'. */ linkId: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing instances */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; }; }; }; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/link_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List specifications * @description List specifications */ get: { parameters: { query?: { /** @description Narrow the result to one or more link specification identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-26"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a specification * @description Create a specification */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object representing link specifications */ requestBody: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @default {} */ dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @default any * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; /** @default {} */ attributes?: components["schemas"]["def-7"]; /** * @description Key-value object representing link specification selectors * @default {} */ selectors?: components["schemas"]["def-6"]; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique: boolean; /** @description Unique identifier for the associated service specification */ specification_id: components["schemas"]["def-1"]; }; }; }; responses: { /** @description Object representing link specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/link_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a specification * @description Read a specification */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link specification. Get it from 'np link specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing link specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a specification * @description Delete a specification */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link specification. Get it from 'np link specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing link specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a specification * @description Updates a specification */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the link specification. Get it from 'np link specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing link specifications */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; responses: { /** @description Object representing link specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/link_specification/{linkSpecificationId}/action_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List link specification actions * @description List link specification actions */ get: { parameters: { query?: { /** @description Narrow the result to one or more action specification identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Service id identifier for dynamic additional properties */ service_id?: components["schemas"]["def-1"] | null | string; /** @description Link id identifier for dynamic additional properties */ link_id?: components["schemas"]["def-1"] | null | string; /** @description Application id identifier for dynamic additional properties */ application_id?: null | number; }; header?: never; path: { /** @description Identifier of the linkSpecification this action specification belongs to. */ linkSpecificationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-38"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a link specification action * @description Create a link specification action */ post: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the linkSpecification this action specification belongs to. */ linkSpecificationId: string; }; cookie?: never; }; /** @description Object representing action specifications */ requestBody: { content: { "application/json": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** * @description Parameters associated with the action * @default {} */ parameters?: components["schemas"]["def-7"]; /** * @description Results expected from the action * @default {} */ results?: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable?: boolean; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; } | unknown | unknown | unknown; }; }; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/link_specification/{linkSpecificationId}/action_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a link specification action * @description Read a link specification action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a link specification action * @description Delete a link specification action */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a link specification action * @description Updates a link specification action */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing action specifications */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable?: boolean; }; }; }; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/service": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List services * @description List services. A service is a modelled dependency an application needs to run — a database, a cache, a load balancer, a queue. Filter by --nrn to scope the search, or by --specification-id for every instance of one kind. */ get: { parameters: { query?: { /** @description Narrow the result to one or more service identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Include the entity's status messages — warnings and errors with a severity level — alongside each result. */ include_messages?: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Status of the service. Should be one of the specified values in the enumeration */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Exclude services with this status, e.g. status:ne=archived hides archived services. Combines with status as AND */ "status:ne"?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Narrow the result to services under this entity, as organization=1:account=2:namespace=3:application=4. Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ entity_nrn?: components["schemas"]["def-2"]; /** @description Type of the service. Should be one of the specified values in the enumeration */ type?: "dependency" | "scope"; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"] | null | string; /** @description Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown */ include_secret_attributes?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-20"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a service * @description Create a service */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object representing service instances */ requestBody: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @description Unique identifier for the associated service specification */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Array representing visibility settings for the service. Specifies what/who can link this entity * @default [] */ linkable_to?: components["schemas"]["def-4"]; /** * @description Object representing dimensions restrictions with key-value pairs * @default {} */ dimensions?: components["schemas"]["def-8"]; /** * @description Attributes associated with the service, should be valid against the service specification attribute schema * @default {} */ attributes?: Record; /** * @description Key-value object representing service selectors * @default {} */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @default dependency * @enum {string} */ type?: "dependency" | "scope"; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "failed" | "cancelled"; entity_nrn: components["schemas"]["def-2"]; }; }; }; responses: { /** @description Object representing service instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the service was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a service * @description Read a service */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the service. Get it from 'np service list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing service instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the service was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a service * @description Delete a service */ delete: { parameters: { query?: { /** @description Specifies whether to force delete the service. If set to true, the service will be deleted without checking for delete action existence */ force?: true; }; header?: never; path: { /** @description Identifier of the service. Get it from 'np service list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing service instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the service was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a service * @description Updates a service */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the service. Get it from 'np service list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing service instances */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "archived" | "failed" | "cancelled"; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; }; }; }; responses: { /** @description Object representing service instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the service was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/service/{id}/compare": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Compare two services * @description Compare two services */ post: operations["service:compare"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service/{serviceId}/action": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List service actions * @description List the actions available on a service. Actions are operations the service exposes beyond create and delete — running a query, rotating a credential — declared by its specification and subject to policies and approvals. */ get: { parameters: { query?: { /** @description Narrow the result to one or more action identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Include the entity's status messages — warnings and errors with a severity level — alongside each result. */ include_messages?: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Status of the action. Should be one of the specified values in the ActionStatus enumeration */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; }; header?: never; path: { /** @description Identifier of the service this action belongs to. Get it from 'np service list'. */ serviceId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-44"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a service action * @description Create a service action */ post: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the service this action belongs to. Get it from 'np service list'. */ serviceId: string; }; cookie?: never; }; /** @description Object representing instances */ requestBody: { content: { "application/json": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: | components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Parameters associated with the action * @default {} */ parameters?: Record; /** * @description Results produced by the action * @default {} */ results?: Record; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; } | unknown | unknown | unknown; }; }; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service/{serviceId}/action/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a service action * @description Read a service action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the service this action belongs to. Get it from 'np service list'. */ serviceId: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a service action * @description Delete a service action */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the service this action belongs to. Get it from 'np service list'. */ serviceId: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a service action * @description Updates a service action */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; /** @description Identifier of the service this action belongs to. Get it from 'np service list'. */ serviceId: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing instances */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; }; }; }; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/action/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a service action * @description Read a service action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing instances */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List specifications * @description List specifications */ get: { parameters: { query?: { /** @description Narrow the result to one or more service specification identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Type of the service specification. Should be one of the specified values in the enumeration */ type?: "dependency" | "scope"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-14"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a specification * @description Create a specification */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object representing service specifications */ requestBody: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** * @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification * @default [] */ visible_to: components["schemas"]["def-4"]; /** @default {} */ attributes?: components["schemas"]["def-7"]; /** * @description Key-value object representing service specification selectors * @default {} */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @default dependency * @enum {string} */ type?: "dependency" | "scope"; /** @default {} */ dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @default any * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; responses: { /** @description Object representing service specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a specification * @description Read a specification */ get: { parameters: { query?: { /** @description Identifier of the service specification. Get it from 'np service specification list'. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Type of the service specification. Should be one of the specified values in the enumeration */ type?: "dependency" | "scope"; }; header?: never; path: { /** @description Identifier of the service specification. Get it from 'np service specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing service specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a specification * @description Delete a specification */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the service specification. Get it from 'np service specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing service specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a specification * @description Updates a specification */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the service specification. Get it from 'np service specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; /** @description Object representing service specifications */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; responses: { /** @description Object representing service specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/service_specification/{id}/link_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List associated link specifications * @description List associated link specifications */ get: { parameters: { query?: never; header?: never; path: { /** @description Narrow the result to one or more link specification identifiers, comma separated. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-26"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_specification/{serviceSpecificationId}/action_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List service specification actions * @description List service specification actions */ get: { parameters: { query?: { /** @description Narrow the result to one or more action specification identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Service id identifier for dynamic additional properties */ service_id?: components["schemas"]["def-1"] | null | string; /** @description Link id identifier for dynamic additional properties */ link_id?: components["schemas"]["def-1"] | null | string; /** @description Application id identifier for dynamic additional properties */ application_id?: null | number; }; header?: never; path: { /** @description Identifier of the serviceSpecification this action specification belongs to. */ serviceSpecificationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-38"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; /** * Create a service specification action * @description Create a service specification action */ post: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the serviceSpecification this action specification belongs to. */ serviceSpecificationId: string; }; cookie?: never; }; /** @description Object representing action specifications */ requestBody: { content: { "application/json": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** * @description Parameters associated with the action * @default {} */ parameters?: components["schemas"]["def-7"]; /** * @description Results expected from the action * @default {} */ results?: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable?: boolean; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; } | unknown | unknown | unknown; }; }; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_specification/{serviceSpecificationId}/action_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a service specification action * @description Read a service specification action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; /** @description Identifier of the serviceSpecification this action specification belongs to. */ serviceSpecificationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; /** * Delete a service specification action * @description Delete a service specification action */ delete: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; /** @description Identifier of the serviceSpecification this action specification belongs to. */ serviceSpecificationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; options?: never; head?: never; /** * Update a service specification action * @description Updates a service specification action */ patch: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; /** @description Identifier of the serviceSpecification this action specification belongs to. */ serviceSpecificationId: string; }; cookie?: never; }; /** @description Object representing action specifications */ requestBody?: { content: { "application/json": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable?: boolean; }; }; }; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; trace?: never; }; "/action_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a service specification action * @description Read a service specification action */ get: { parameters: { query?: never; header?: never; path: { /** @description Identifier of the action specification. Get it from 'np action specification list'. */ id: components["schemas"]["def-1"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing action specifications */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/action_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List service specification actions * @description List service specification actions */ get: { parameters: { query?: { /** @description Narrow the result to one or more action specification identifiers, comma separated. */ id?: components["schemas"]["def-1"] | string; /** @description Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id --query .nrn'. */ nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Service id identifier for dynamic additional properties */ service_id?: components["schemas"]["def-1"] | null | string; /** @description Link id identifier for dynamic additional properties */ link_id?: components["schemas"]["def-1"] | null | string; /** @description Application id identifier for dynamic additional properties */ application_id?: null | number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing pagination parameters for controlling the number and order of results */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-38"][]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { /** HttpError */ "def-0": { statusCode?: number; code?: string; error?: string; message?: string; }; /** * Id * Format: uuid * @description Unique identifier for the entity represented as a UUID */ "def-1": string; /** * NRN * @description Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources */ "def-2": string; /** * Error * @description Format for representing errors during API interactions */ "def-3": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; /** * Visibility * @description Array representing visibility settings for the entity. Specifies what/who can see this entity */ "def-4": components["schemas"]["def-2"][]; /** Message */ "def-5": { /** * @description Message severity level. Defaults to "info" * @default info * @enum {string} */ level: | "debug" | "info" | "information" | "warn" | "warning" | "error" | "fatal"; /** @description The actual message content */ message: string; }[]; /** * Selector * @description Key-value object representing instance selectors */ "def-6": { /** @default false */ imported: boolean; /** @default any */ provider: string; /** @default any */ category: string; /** @default any */ sub_category: string; } & { [key: string]: string | number | boolean | null; }; /** * Attribute * @description Object representing an attribute with a schema and associated values */ "def-7": { /** * @description Specification of the attribute schema. Must be a valid JSON Schema * @default {} */ schema: Record; /** * @description Values associated with the attribute. Must validate against provided schema * @default {} */ values: Record; }; /** * Dimension * @description Object representing dimensions with key-value pairs */ "def-8": { [key: string]: string; }; /** Specification Dimension */ "def-9": { [key: string]: { required: boolean; values?: string[]; }; }; /** * https://nullplatform.com/schemas/serviceSpecificationQuery * @description Object representing page query options */ "def-10": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; /** https://nullplatform.com/schemas/serviceSpecificationParams */ "def-11": { id?: components["schemas"]["def-1"]; }; /** * ServiceSpecification * @description Object representing service specifications * @example { * "name": "my-service-specification", * "visible_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-12": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** * @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification * @default [] */ visible_to: components["schemas"]["def-4"]; /** @default {} */ attributes: components["schemas"]["def-7"]; /** * @description Key-value object representing service specification selectors * @default {} */ selectors: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @default dependency * @enum {string} */ type: "dependency" | "scope"; /** @default {} */ dimensions: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @default any * @enum {string} */ assignable_to: "any" | "dimension" | "scope"; }; /** * ServiceSpecification * @description Object representing service specifications * @example { * "name": "my-service-specification", * "visible_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-13": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; /** * ServiceSpecification * @description Object representing service specifications * @example { * "name": "my-service-specification", * "visible_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-14": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the service specification. Specifies what/who can create a service based on this specification */ visible_to?: components["schemas"]["def-4"]; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing service specification selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service specification. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; /** * ServiceSpecificationList * @description Object representing pagination parameters for controlling the number and order of results */ "def-15": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-14"][]; }; /** * https://nullplatform.com/schemas/serviceQuery * @description Object representing page query options */ "def-16": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @default false */ include_messages: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** * @description Exclude services with this status, e.g. status:ne=archived hides archived services. Combines with status as AND * @enum {string} */ "status:ne"?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; entity_nrn?: components["schemas"]["def-2"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"] | null | string; /** * @description Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown * @default false */ include_secret_attributes: boolean; }; /** https://nullplatform.com/schemas/serviceParams */ "def-17": { id?: components["schemas"]["def-1"]; }; /** * Service * @description Object representing service instances * @example { * "name": "my-service", * "entity_nrn": "organization=1:account=1:namespace=1", * "specification_id": "67fac146-54cc-466d-8c52-a8234445a95f", * "linkable_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "attributes": { * "my_string_property": "my_string_value", * "my_number_property": 0 * } * } */ "def-18": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @description Unique identifier for the associated service specification */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Array representing visibility settings for the service. Specifies what/who can link this entity * @default [] */ linkable_to: components["schemas"]["def-4"]; /** * @description Object representing dimensions restrictions with key-value pairs * @default {} */ dimensions: components["schemas"]["def-8"]; /** * @description Attributes associated with the service, should be valid against the service specification attribute schema * @default {} */ attributes: Record; /** * @description Key-value object representing service selectors * @default {} */ selectors: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @default dependency * @enum {string} */ type: "dependency" | "scope"; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "failed" | "cancelled"; entity_nrn: components["schemas"]["def-2"]; }; /** * Service * @description Object representing service instances * @example { * "name": "my-service", * "entity_nrn": "organization=1:account=1:namespace=1", * "specification_id": "67fac146-54cc-466d-8c52-a8234445a95f", * "linkable_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "attributes": { * "my_string_property": "my_string_value", * "my_number_property": 0 * } * } */ "def-19": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "archived" | "failed" | "cancelled"; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; }; /** * Service * @description Object representing service instances * @example { * "name": "my-service", * "entity_nrn": "organization=1:account=1:namespace=1", * "specification_id": "67fac146-54cc-466d-8c52-a8234445a95f", * "linkable_to": [ * "organization=1:account=1", * "organization=1:account=2" * ], * "attributes": { * "my_string_property": "my_string_value", * "my_number_property": 0 * } * } */ "def-20": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the service was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the service. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Array representing visibility settings for the service. Specifies what/who can link this entity */ linkable_to?: components["schemas"]["def-4"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the service, should be valid against the service specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing service selectors */ selectors?: components["schemas"]["def-6"]; /** * @description Type of the service. Should be one of the specified values in the enumeration * @enum {string} */ type?: "dependency" | "scope"; }; /** * ServiceList * @description Object representing pagination parameters for controlling the number and order of results */ "def-21": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-20"][]; }; /** * https://nullplatform.com/schemas/linkSpecificationQuery * @description Object representing page query options */ "def-22": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; }; /** https://nullplatform.com/schemas/linkSpecificationParams */ "def-23": { id?: components["schemas"]["def-1"]; }; /** * LinkSpecification * @description Object representing link specifications * @example { * "name": "my-link-specification", * "specification_id": "eb0b880a-b7e4-42b8-98f9-40c262c59a23", * "unique": true, * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-24": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @default {} */ dimensions: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @default any * @enum {string} */ assignable_to: "any" | "dimension" | "scope"; /** @default {} */ attributes: components["schemas"]["def-7"]; /** * @description Key-value object representing link specification selectors * @default {} */ selectors: components["schemas"]["def-6"]; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique: boolean; /** @description Unique identifier for the associated service specification */ specification_id: components["schemas"]["def-1"]; }; /** * LinkSpecification * @description Object representing link specifications * @example { * "name": "my-link-specification", * "specification_id": "eb0b880a-b7e4-42b8-98f9-40c262c59a23", * "unique": true, * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-25": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; }; /** * LinkSpecification * @description Object representing link specifications * @example { * "name": "my-link-specification", * "specification_id": "eb0b880a-b7e4-42b8-98f9-40c262c59a23", * "unique": true, * "dimensions": { * "environment": { * "required": true, * "values": [ * "production", * "staging" * ] * } * }, * "assignable_to": "any", * "attributes": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * } * } */ "def-26": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description Array representing visibility settings for the link specification. Specifies what/who can create a link based on this specification */ visible_to?: components["schemas"]["def-4"]; /** @description Indicates whether the service can be linked only once by an instance of this link specification */ unique?: boolean; /** @description Unique identifier for the associated service specification */ specification_id?: components["schemas"]["def-1"]; dimensions?: components["schemas"]["def-9"]; /** * @description Specifies if the service can be assigned to any entity, only dimensions, or only scopes * @enum {string} */ assignable_to?: "any" | "dimension" | "scope"; attributes?: components["schemas"]["def-7"]; /** @description Key-value object representing link specification selectors */ selectors?: components["schemas"]["def-6"]; }; /** * LinkSpecificationList * @description Object representing pagination parameters for controlling the number and order of results */ "def-27": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-26"][]; }; /** * https://nullplatform.com/schemas/linkQuery * @description Object representing page query options */ "def-28": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @default false */ include_messages: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** * @description Exclude links with this status, e.g. status:ne=archived hides archived links. Combines with status as AND * @enum {string} */ "status:ne"?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** * @description Specifies whether to show entities defined in the lower level of the NRN hierarchy * @default false */ show_descendants: boolean; /** * @description Specifies whether to show secret attributes values. If set to true, secret attributes values will be shown * @default false */ include_secret_attributes: boolean; }; /** https://nullplatform.com/schemas/linkParams */ "def-29": { id?: components["schemas"]["def-1"]; }; /** * Link * @description Object representing link instances * @example { * "name": "my-link", * "service_id": "9548393c-f1d1-4bbc-97a6-c3968862f2a4", * "specification_id": "5a872c9a-9a16-4a6d-a000-d0e7404a15aa", * "entity_nrn": "organization=1:account=1:namespace=1:application=1", * "dimensions": { * "environment": "production" * }, * "attributes": { * "my_link_attribute": "my_value" * } * } */ "def-30": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** @description Unique identifier for the specification associated with the entity */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Object representing dimensions restrictions with key-value pairs * @default {} */ dimensions: components["schemas"]["def-8"]; /** * @description Attributes associated with the link, should be valid against the link specification attribute schema * @default {} */ attributes: Record; /** * @description Key-value object representing link selectors * @default {} */ selectors: components["schemas"]["def-6"]; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id: components["schemas"]["def-1"]; entity_nrn: components["schemas"]["def-2"]; }; /** * Link * @description Object representing link instances * @example { * "name": "my-link", * "service_id": "9548393c-f1d1-4bbc-97a6-c3968862f2a4", * "specification_id": "5a872c9a-9a16-4a6d-a000-d0e7404a15aa", * "entity_nrn": "organization=1:account=1:namespace=1:application=1", * "dimensions": { * "environment": "production" * }, * "attributes": { * "my_link_attribute": "my_value" * } * } */ "def-31": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "active" | "archived" | "failed" | "cancelled"; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; /** * Link * @description Object representing link instances * @example { * "name": "my-link", * "service_id": "9548393c-f1d1-4bbc-97a6-c3968862f2a4", * "specification_id": "5a872c9a-9a16-4a6d-a000-d0e7404a15aa", * "entity_nrn": "organization=1:account=1:namespace=1:application=1", * "dimensions": { * "environment": "production" * }, * "attributes": { * "my_link_attribute": "my_value" * } * } */ "def-32": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** @description When the link was last archived; null while it is not archived */ archived_at?: string | null; /** * @description Status of the link. Should be one of the specified values in the enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "creating" | "updating" | "archiving" | "active" | "archived" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Object representing dimensions restrictions with key-value pairs */ dimensions?: components["schemas"]["def-8"]; /** @description Attributes associated with the link, should be valid against the link specification attribute schema */ attributes?: Record; entity_nrn?: components["schemas"]["def-2"]; /** @description Key-value object representing link selectors */ selectors?: components["schemas"]["def-6"]; }; /** * LinkList * @description Object representing pagination parameters for controlling the number and order of results */ "def-33": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-32"][]; }; /** * https://nullplatform.com/schemas/actionSpecificationQuery * @description Object representing page query options */ "def-34": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** @description Unique identifier for the associated service specification */ service_specification_id?: components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: components["schemas"]["def-1"] | null | string; /** @description Service id identifier for dynamic additional properties */ service_id?: components["schemas"]["def-1"] | null | string; /** @description Link id identifier for dynamic additional properties */ link_id?: components["schemas"]["def-1"] | null | string; /** @description Application id identifier for dynamic additional properties */ application_id?: null | number; }; /** https://nullplatform.com/schemas/actionSpecificationParams */ "def-35": { id?: components["schemas"]["def-1"]; }; /** * ActionSpecification * @description Object representing action specifications * @example { * "name": "my-link-specification", * "type": "custom", * "parameters": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "results": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "service_specification_id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1", * "link_specification_id": "f3e8be90-0952-4506-bd54-c4e75a5a4393", * "retryable": true * } */ "def-36": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name: string; /** * @description Parameters associated with the action * @default {} */ parameters: components["schemas"]["def-7"]; /** * @description Results expected from the action * @default {} */ results: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Unique identifier for the associated service specification */ service_specification_id?: | components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: | components["schemas"]["def-1"] | null | string; } | unknown | unknown | unknown; /** * ActionSpecification * @description Object representing action specifications * @example { * "name": "my-link-specification", * "type": "custom", * "parameters": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "results": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "service_specification_id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1", * "link_specification_id": "f3e8be90-0952-4506-bd54-c4e75a5a4393", * "retryable": true * } */ "def-37": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; /** * ActionSpecification * @description Object representing action specifications * @example { * "name": "my-link-specification", * "type": "custom", * "parameters": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "results": { * "schema": { * "type": "object", * "properties": { * "my_string_property": { * "type": "string" * }, * "my_number_property": { * "type": "number", * "default": 0 * } * }, * "required": [ * "my_string_property" * ] * }, * "values": {} * }, * "service_specification_id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1", * "link_specification_id": "f3e8be90-0952-4506-bd54-c4e75a5a4393", * "retryable": true * } */ "def-38": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the specification. Automatically generated from "name" */ slug?: string; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Type of the action. Should be one of the specified values in the ActionType enumeration * @enum {string} */ type?: | "create" | "update" | "delete" | "archive" | "unarchive" | "custom" | "diagnose"; /** @description Parameters associated with the action */ parameters?: components["schemas"]["def-7"]; /** @description Results expected from the action */ results?: components["schemas"]["def-7"]; /** @description Unique identifier for the associated service specification */ service_specification_id?: components["schemas"]["def-1"] | null | string; /** @description Unique identifier for the associated link specification */ link_specification_id?: components["schemas"]["def-1"] | null | string; /** * @description Whether the action can be retried if the instance is on a failed state * @default false */ retryable: boolean; }; /** * ActionSpecificationList * @description Object representing pagination parameters for controlling the number and order of results */ "def-39": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-38"][]; }; /** * https://nullplatform.com/schemas/actionQuery * @description Object representing page query options */ "def-40": { id?: components["schemas"]["def-1"] | string; nrn?: components["schemas"]["def-2"]; /** @default false */ include_messages: boolean; /** @description Limits the number of results returned per page */ limit?: string; /** @description Specifies the offset for paginating through results */ offset?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; }; /** https://nullplatform.com/schemas/actionParams */ "def-41": { id?: components["schemas"]["def-1"]; }; /** * Action * @description Object representing instances */ "def-42": | { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Parameters associated with the action * @default {} */ parameters: Record; /** * @description Results produced by the action * @default {} */ results: Record; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; } | unknown | unknown | unknown; /** * Action * @description Object representing instances */ "def-43": { /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; }; /** * Action * @description Object representing instances */ "def-44": { id?: components["schemas"]["def-1"]; /** @description Name of the entity. Must be a non-empty string and not equal to null */ name?: string; /** @description Slug of the entity. Automatically generated from "name" */ slug?: string; /** @description Unique identifier for the specification associated with the entity */ specification_id?: components["schemas"]["def-1"]; /** @description Desired unique identifier for the associated specification */ desired_specification_id?: components["schemas"]["def-1"] | null; /** @description Object representing instance messages with severity levels */ messages?: components["schemas"]["def-5"]; /** Format: date */ created_at?: string; /** Format: date */ updated_at?: string; /** * @description Status of the action. Should be one of the specified values in the ActionStatus enumeration * @enum {string} */ status?: | "pending_create" | "pending" | "in_progress" | "success" | "failed" | "cancelled"; /** @description Parameters associated with the action */ parameters?: Record; /** @description Results produced by the action */ results?: Record; /** @description Unique identifier for the associated service */ service_id?: components["schemas"]["def-1"]; /** @description Unique identifier for the associated link */ link_id?: components["schemas"]["def-1"]; }; /** * ActionList * @description Object representing pagination parameters for controlling the number and order of results */ "def-45": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-44"][]; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { "service:compare": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the compare. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Identifier for the source service id */ source_service_id: components["schemas"]["def-1"]; }; }; }; responses: { /** @description Default Response */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { diff?: { /** @enum {string} */ operation: "replace" | "remove" | "add"; path: string; source_value?: unknown; target_value?: unknown; }[]; source?: components["schemas"]["def-21"]; target?: components["schemas"]["def-21"]; }; }; }; /** @description Format for representing errors during API interactions */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; /** @description Format for representing errors during API interactions */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description HTTP status code indicating the error */ statusCode: number; /** @description Unique error code for reference and categorization */ code?: string; /** @description Short, human-readable error type or category */ error: string; /** @description Detailed error message providing additional context */ message: string; }; }; }; }; }; }