Skip to main content

Create a specification

Create a specification

Request Body REQUIRED

Object representing service specifications

name string REQUIRED

Possible values: 1 ≤ length

Name of the entity. Must be a non-empty string and not equal to null

visible_to NRN[] REQUIRED

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

Array representing visibility settings for the entity. Specifies what/who can see this entity

attributes object

Object representing an attribute with a schema and associated values

schema object REQUIRED

Specification of the attribute schema. Must be a valid JSON Schema

values object REQUIRED

Values associated with the attribute. Must validate against provided schema

selectors object

Key-value object representing instance selectors

imported boolean
provider string

Possible values: 1 ≤ length

category string

Possible values: 1 ≤ length

sub_category string

Possible values: 1 ≤ length

type string

Possible values: [dependency, scope]

Type of the service specification. Should be one of the specified values in the enumeration

Responses
2XX

Object representing service specifications

Schema OPTIONAL
id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

name string OPTIONAL

Possible values: 1 ≤ length

Name of the entity. Must be a non-empty string and not equal to null

slug string OPTIONAL

Possible values: 1 ≤ length

Slug of the specification. Automatically generated from "name"

created_at date OPTIONAL
updated_at date OPTIONAL
visible_to NRN[] OPTIONAL

Possible values: Value must match regular expression ^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$

Array representing visibility settings for the entity. Specifies what/who can see this entity

attributes object OPTIONAL

Object representing an attribute with a schema and associated values

schema object

Specification of the attribute schema. Must be a valid JSON Schema

values object

Values associated with the attribute. Must validate against provided schema

selectors object OPTIONAL

Key-value object representing instance selectors

imported boolean OPTIONAL
provider string OPTIONAL

Possible values: 1 ≤ length

category string OPTIONAL

Possible values: 1 ≤ length

sub_category string OPTIONAL

Possible values: 1 ≤ length

type string OPTIONAL

Possible values: [dependency, scope]

Type of the service specification. Should be one of the specified values in the enumeration

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context