/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/category": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List categories * @description Get a paginated list of providers categories filter by **type** and other queries */ get: operations["provider_category:list"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/category/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a category * @description Read a provider category by ID. Use the **include** query parameter to retrieve related resources. */ get: operations["provider_category:read"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List providers * @description Get a paginated list of providers filtered by [NRN](/docs/NRN) and other queries */ get: operations["provider:list"]; put?: never; /** * Create a provider * @description Creates a new provider. Note that [dependencies](/docs/providers/overview#provider-dependencies) may need to be met. */ post: operations["provider:create"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a provider * @description Read a provider by ID. The attributes are resolved with [inheritance](/docs/providers/overview#provider-inheritance) by default */ get: operations["provider:read"]; /** * Replace a provider * @description Replace a provider by ID */ put: operations["provider:replace"]; post?: never; /** * Delete a provider * @description Delete a provider by ID */ delete: operations["provider:delete"]; options?: never; head?: never; /** * Update a provider * @description Updates a provider by ID */ patch: operations["provider:update"]; trace?: never; }; "/provider_specification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List provider specifications * @description Get a paginated list of providers specifications filtered by [NRN](/docs/NRN) and other queries */ get: operations["provider_specification:list"]; put?: never; /** * Create a provider specification * @description Create a new provider specification for your organization */ post: operations["provider_specification:create"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider_specification/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Read a provider specification * @description Read a provider specification by ID. The JSON schema attribute defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). */ get: operations["provider_specification:read"]; put?: never; post?: never; /** * Delete a provider specification * @description Delete an existing provider specification. Cannot delete if providers are using it. */ delete: operations["provider_specification:delete"]; options?: never; head?: never; /** * Update a provider specification * @description Update an existing provider specification */ patch: operations["provider_specification:update"]; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { /** * Id * Format: uuid * @description Unique identifier for the entity represented as a UUID */ "def-0": string; /** * IdList * @description List of unique identifiers for the entity represented as a comma-separated list of UUID */ "def-1": string; /** * Error * @description Format for representing errors during API interactions */ "def-2": { /** @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; }; /** * NRN * @description Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources */ "def-3": string; /** * Dimensions * @description Dimensions for the query, formatted as key:value pairs separated by commas (e.g., "key1:value1,key2:value2") */ "def-4": string; /** * ProviderSpecificationListQuery * @description Query parameters for a paginated list of provider specifications */ "def-5": { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; /** @description Unique slug for the provider specification */ slug?: string; /** @description Name of the provider specification */ name?: string; nrn: components["schemas"]["def-3"]; /** @description List of category IDs to filter by */ category?: | components["schemas"]["def-1"] | components["schemas"]["def-0"][]; }; /** * ProviderSpecificationParams * @description URL parameters for a provider specification */ "def-6": { id?: components["schemas"]["def-0"]; }; /** * ProviderSpecificationRead * @description Object representing a provider specification resource */ "def-7": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; /** * ProviderSpecificationCreate * @description Object to create a new provider specification * @example {} */ "def-8": { /** @description Name of the provider specification */ name: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions?: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Category slug to associate with this specification. Valid values: logging, metrics, cloud-providers, code-repository, assets-repository, container-orchestration, compute-management, vpc */ category?: string; }; /** * ProviderSpecificationUpdate * @description Object to update a provider specification * @example {} */ "def-9": { /** @description Name of the provider specification */ name?: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema?: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions?: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Category slug to associate with this specification. Valid values: logging, metrics, cloud-providers, code-repository, assets-repository, container-orchestration, compute-management, vpc */ category?: string; }; /** * ProviderSpecificationList * @description Paginated list of provider specifications */ "def-10": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-7"][]; }; /** * ProviderReadQuery * @description Query parameters for a provider */ "def-11": { /** * @description Specifies whether to merge attributes hierarchically * @default false */ no_merge: boolean; }; /** * ProviderListQuery * @description Query parameters for a paginated list of providers */ "def-12": { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; id?: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; dimensions?: components["schemas"]["def-4"]; /** * @description Provider Specification ID to filter by, it supports comma separated values * @example 7f3c910e-8138-4d65-9d09-b97d89f2c509,82eee42c-46c9-4bb7-a53d-c08b027817f3 */ specification_id?: string; /** * @description Provider Specification slug to filter by, it supports comma separated values * @example aws-configuration,gitlab-configuration */ specification_slug?: string; /** * @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 entities defined in the lower level of the NRN hierarchy * @default false */ show_ascendants: boolean; /** @description List of provider specification IDs to filter by */ specification?: components["schemas"]["def-0"][]; /** @description Attributes to include in the response */ include?: ("tags" | "groups")[]; }; /** https://nullplatform.com/schemas/providerHeritageQuery */ "def-13": { provider_id?: components["schemas"]["def-0"]; nrn?: components["schemas"]["def-3"]; specification_id?: components["schemas"]["def-0"]; dimensions?: components["schemas"]["def-4"]; } & (unknown | unknown); /** * ProviderParams * @description URL parameters for a provider */ "def-14": { id?: components["schemas"]["def-0"]; }; /** https://nullplatform.com/schemas/providerHeritage */ "def-15": { /** @description Provider-specific attributes */ attributes?: { [key: string]: unknown; }; heritage?: { provider_id?: components["schemas"]["def-0"]; /** @description Tags associated with the provider */ provider_tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; keys?: string[]; origin?: { nrn?: components["schemas"]["def-3"]; entity_id?: components["schemas"]["def-0"]; entity?: string; }; }[]; }; /** * ParentProviderRead * @description Object representing a provider resource * @example { * "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890", * "nrn": "organization=1:account=1:namespace=1", * "dimensions": { * "environment": "production" * }, * "specification_id": "02fd22f1-6bf9-41aa-9b58-29d50f725855", * "attributes": { * "cluster": { * "id": "my-np-gcp-prod", * "location": "s-west1", * "namespace": "my-namespace" * }, * "gateway": { * "public_name": "my-public-gateway", * "private_name": "my-private-gateway" * } * }, * "tags": [ * { * "id": "4e2306de-82e3-4b74-a419-e0e324beb500", * "key": "cluster.id", * "value": "my-np-gcp-prod" * } * ], * "created_at": "2024-10-15T08:30:00Z", * "updated_at": "2024-10-20T14:45:00Z" * } */ "def-16": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; /** @description List of inherited keys */ inherited_keys?: string[]; }; /** * ProviderRead * @description Object representing a provider resource * @example { * "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890", * "nrn": "organization=1:account=1:namespace=1", * "dimensions": { * "environment": "production" * }, * "specification_id": "02fd22f1-6bf9-41aa-9b58-29d50f725855", * "attributes": { * "cluster": { * "id": "my-np-gcp-prod", * "location": "s-west1", * "namespace": "my-namespace" * }, * "gateway": { * "public_name": "my-public-gateway", * "private_name": "my-private-gateway" * } * }, * "tags": [ * { * "id": "4e2306de-82e3-4b74-a419-e0e324beb500", * "key": "cluster.id", * "value": "my-np-gcp-prod" * } * ], * "created_at": "2024-10-15T08:30:00Z", * "updated_at": "2024-10-20T14:45:00Z" * } */ "def-17": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; /** * ProviderCreate * @description Object to create a new provider * @example { * "nrn": "organization=1:account=1:namespace=1", * "dimensions": { * "environment": "production" * }, * "specification_id": "02fd22f1-6bf9-41aa-9b58-29d50f725855", * "attributes": { * "cluster": { * "id": "my-np-gcp-prod", * "location": "s-west1", * "namespace": "my-namespace" * }, * "gateway": { * "public_name": "my-public-gateway", * "private_name": "my-private-gateway" * } * }, * "tags": [ * { * "key": "cluster.id", * "value": "my-np-gcp-prod" * } * ] * } */ "def-18": { nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; }[]; }; /** * ProviderUpdate * @description Object to update a provider * @example { * "attributes": { * "cluster": { * "id": "my-np-gcp-prod", * "location": "s-west1", * "namespace": "my-namespace" * }, * "gateway": { * "public_name": "my-public-gateway", * "private_name": "my-private-gateway" * } * }, * "tags": [ * { * "key": "cluster.id", * "value": "my-np-gcp-prod" * } * ] * } */ "def-19": { /** @description Provider-specific attributes defined in the specification schema */ attributes?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; }[]; }; /** * ProviderList * @description Paginated list of providers */ "def-20": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-17"][]; }; /** * CategoryReadQuery * @description Query parameters for a category */ "def-21": { /** @description Related resources to include in the response. */ include?: ("sub_categories" | "parent" | "category_type")[]; }; /** * CategoryListQuery * @description Query parameters for a paginated list of categories */ "def-22": { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; /** @description Related resources to include in the response. */ include?: ("sub_categories" | "parent" | "category_type")[]; /** @description Unique category type slug to filter by. i.e. "menu" */ type?: string; /** @description Unique category slug to filter by */ slug?: string; nrn?: components["schemas"]["def-3"]; dimensions?: components["schemas"]["def-4"]; }; /** * CategoryParams * @description URL parameters for a category */ "def-23": { id?: components["schemas"]["def-0"]; }; /** * CategoryRead * @description Object representing a category resource * @example { * "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890", * "name": "Compute & Containers", * "slug": "compute-containers", * "description": "Category for compute and container services", * "category_type_id": "123e4567-e89b-12d3-a456-426614174000", * "sub_categories": [ * { * "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890", * "name": "Cloud Providers", * "slug": "cloud-providers", * "description": "Category for cloud platform providers", * "category_type_id": "123e4567-e89b-12d3-a456-426614174000", * "sub_categories": [], * "created_at": "2024-10-15T08:30:00Z", * "updated_at": "2024-10-20T14:45:00Z" * }, * { * "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890", * "name": "Container Orchestration", * "slug": "container-orchestration", * "description": "Category for cloud platform providers", * "category_type_id": "123e4567-e89b-12d3-a456-426614174000", * "sub_categories": [], * "created_at": "2024-10-15T08:30:00Z", * "updated_at": "2024-10-20T14:45:00Z" * } * ], * "created_at": "2024-10-15T08:30:00Z", * "updated_at": "2024-10-20T14:45:00Z" * } */ "def-24": { id: components["schemas"]["def-0"]; /** @description Name of the category */ name: string; /** @description Unique slug for the category */ slug: string; /** @description Icon for the category */ icon?: string; /** @description Description of the category */ description?: string; parent_id?: components["schemas"]["def-0"]; category_type_id: components["schemas"]["def-0"]; /** * CategoryType * @description Category type of the category */ category_type?: { id: components["schemas"]["def-0"]; /** @description Name of the category type */ name: string; /** @description Unique slug for the category type */ slug: string; /** @description Description of the category type */ description?: string; }; parent?: components["schemas"]["def-24"]; /** @description Sub categories of the category */ sub_categories?: components["schemas"]["def-24"][]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; /** * CategoryType * @description Category type of the category */ "def-25": { id: components["schemas"]["def-0"]; /** @description Name of the category type */ name: string; /** @description Unique slug for the category type */ slug: string; /** @description Description of the category type */ description?: string; }; /** * CategoryList * @description Paginated list of categories */ "def-26": { paging: { /** @description Limits the number of results returned */ limit: number; /** @description Specifies the offset for paginated results */ offset: number; }; results: components["schemas"]["def-24"][]; }; /** HttpError */ "def-27": { statusCode?: number; code?: string; error?: string; message?: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { "provider_category:list": { parameters: { query?: { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; /** @description Related resources to include in the response. */ include?: ("sub_categories" | "parent" | "category_type")[]; /** @description Unique category type slug to filter by. i.e. "menu" */ type?: string; /** @description Unique category slug to filter by */ slug?: 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-3"]; /** @description Dimensions to filter by, comma separated (e.g. country:usa,environment:production). */ dimensions?: components["schemas"]["def-4"]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of categories */ "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-24"][]; }; }; }; /** @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; }; }; }; }; }; "provider_category:read": { parameters: { query?: { /** @description Related resources to include in the response. */ include?: ("sub_categories" | "parent" | "category_type")[]; }; header?: never; path: { /** @description Identifier of the category. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing a category resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the category */ name: string; /** @description Unique slug for the category */ slug: string; /** @description Icon for the category */ icon?: string; /** @description Description of the category */ description?: string; parent_id?: components["schemas"]["def-0"]; category_type_id: components["schemas"]["def-0"]; /** * CategoryType * @description Category type of the category */ category_type?: { id: components["schemas"]["def-0"]; /** @description Name of the category type */ name: string; /** @description Unique slug for the category type */ slug: string; /** @description Description of the category type */ description?: string; }; parent?: components["schemas"]["def-24"]; /** @description Sub categories of the category */ sub_categories?: components["schemas"]["def-24"][]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider:list": { parameters: { query: { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; /** @description Narrow the result to one or more provider identifiers, comma separated. */ id?: components["schemas"]["def-0"]; /** @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-3"]; /** @description Dimensions to filter by, comma separated (e.g. country:usa,environment:production). */ dimensions?: components["schemas"]["def-4"]; /** @description Provider Specification ID to filter by, it supports comma separated values */ specification_id?: string; /** @description Provider Specification slug to filter by, it supports comma separated values */ specification_slug?: string; /** @description Specifies whether to show entities defined in the lower level of the NRN hierarchy */ show_descendants?: boolean; /** @description Specifies whether to show entities defined in the lower level of the NRN hierarchy */ show_ascendants?: boolean; /** @description List of provider specification IDs to filter by */ specification?: components["schemas"]["def-0"][]; /** @description Attributes to include in the response */ include?: ("tags" | "groups")[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of providers */ "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-17"][]; }; }; }; /** @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; }; }; }; }; }; "provider:create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object to create a new provider */ requestBody: { content: { "application/json": { nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; }[]; }; }; }; responses: { /** @description Object representing a provider resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider:read": { parameters: { query?: { /** @description Specifies whether to merge attributes hierarchically */ no_merge?: boolean; }; header?: never; path: { /** @description Identifier of the provider. Get it from 'np provider list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing a provider resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider:replace": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider. Get it from 'np provider list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; /** @description Object to update a provider */ requestBody: { content: { "application/json": { /** @description Provider-specific attributes defined in the specification schema */ attributes?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; }[]; }; }; }; responses: { /** @description Object representing a provider resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider:delete": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider. Get it from 'np provider list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing a provider resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider:update": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider. Get it from 'np provider list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; /** @description Object to update a provider */ requestBody: { content: { "application/json": { /** @description Provider-specific attributes defined in the specification schema */ attributes?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; }[]; }; }; }; responses: { /** @description Object representing a provider resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; nrn: components["schemas"]["def-3"]; specification_id: components["schemas"]["def-0"]; /** @description Provider-specific attributes defined in the specification schema */ attributes: Record; /** @description NRN-specific dimensions. [Read more](/docs/dimensions) */ dimensions?: Record; /** @description Tags associated with the provider */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description Groups associated with the provider */ groups?: string[]; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider_specification:list": { parameters: { query: { /** @description Limits the number of results returned per page */ limit?: number; /** @description Specifies the offset for paginating through results */ offset?: number; /** @description Unique slug for the provider specification */ slug?: string; /** @description Name of the provider specification */ name?: 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-3"]; /** @description List of category IDs to filter by */ category?: | components["schemas"]["def-1"] | components["schemas"]["def-0"][]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }[]; }; }; /** @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; }; }; }; }; }; "provider_specification:create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Object to create a new provider specification */ requestBody: { content: { "application/json": { /** @description Name of the provider specification */ name: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions?: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Category slug to associate with this specification. Valid values: logging, metrics, cloud-providers, code-repository, assets-repository, container-orchestration, compute-management, vpc */ category?: string; }; }; }; responses: { /** @description Object representing a provider specification resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider_specification:read": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider specification. Get it from 'np provider specification list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing a provider specification resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider_specification:delete": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider specification. Get it from 'np provider specification list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Object representing a provider specification resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; "provider_specification:update": { parameters: { query?: never; header?: never; path: { /** @description Identifier of the provider specification. Get it from 'np provider specification list'. */ id: components["schemas"]["def-0"]; }; cookie?: never; }; /** @description Object to update a provider specification */ requestBody: { content: { "application/json": { /** @description Name of the provider specification */ name?: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema?: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions?: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Category slug to associate with this specification. Valid values: logging, metrics, cloud-providers, code-repository, assets-repository, container-orchestration, compute-management, vpc */ category?: string; }; }; }; responses: { /** @description Object representing a provider specification resource */ "2XX": { headers: { [name: string]: unknown; }; content: { "application/json": { id: components["schemas"]["def-0"]; /** @description Name of the provider specification */ name: string; /** @description Unique slug for the provider specification */ slug: string; /** @description Icon for the provider specification */ icon?: string; /** @description Description of the provider specification */ description?: string; /** @description List of NRNs this specification is visible to */ visible_to?: string[]; /** * @description [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) for the provider specification. * This schema defines settings for any [nullplatform integrations](/docs/providers/supported-integrations). * It can also include custom JSON Schema keywords such as: * * - **tag** (boolean): Marks a property as auto-taggable, automatically creating a tag with the property's value. * - **secret** (boolean): Marks a property as secret, ensuring the property’s value is never revealed. * - **groups** (array): Specifies configuration groups within the schema, automatically creating sections in the UI. */ schema: Record; /** @description Flag to allow dimensions for this specification */ allow_dimensions: boolean; /** @description Default dimensions for the provider specification */ default_dimensions?: Record; /** @description Tags associated with the providers */ tags?: { /** @description Tag key */ key: string; /** @description Tag value */ value: string; id: components["schemas"]["def-0"]; }[]; /** @description IDs of associated categories */ categories?: components["schemas"]["def-0"][]; /** @description IDs of associated dependencies */ dependencies?: components["schemas"]["def-0"][]; /** @description Organization ID that owns this specification. NULL means global (nullplatform-managed) */ organization_id?: number | null; /** * Format: date-time * @description Creation timestamp */ created_at: string; /** * Format: date-time * @description Last update timestamp */ updated_at: string; }; }; }; /** @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; }; }; }; }; }; }