Skip to main content

Create a entity metadata specification

Creates a entity metadata specification

Request Body REQUIRED

Object representing a nullplatform entity metadata specification

name string REQUIRED

Possible values: 1 ≤ length

Metadata specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities

nrn NRN REQUIRED

Possible values: Value must match regular expression ^organization=(\d+|\*)+(?::account=(\d+|\*))?(?::namespace=(\d+|\*))?(?::application=(\d+|\*))?(?::(build|scope|release)=(\d+|\*))?$

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

entity string REQUIRED

Possible values: [organization, account, namespace, application, build, asset, scope, release, deployment]

Parent entity that holds metadata information

metadata string REQUIRED

Possible values: 1 ≤ length

Entity metadata key, for example: coverage, frameworks, vulnerabilities

description string

Possible values: 1 ≤ length

Metadata specification description

schema object REQUIRED

Metadata specification schema. Must be a valid JSON Schema

Responses
2XX

Object representing a nullplatform entity metadata specification

Schema OPTIONAL
id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

name string OPTIONAL

Possible values: 1 ≤ length

Metadata specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities

nrn NRN OPTIONAL

Possible values: Value must match regular expression ^organization=(\d+|\*)+(?::account=(\d+|\*))?(?::namespace=(\d+|\*))?(?::application=(\d+|\*))?(?::(build|scope|release)=(\d+|\*))?$

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

entity string OPTIONAL

Possible values: [organization, account, namespace, application, build, asset, scope, release, deployment]

Parent entity that holds metadata information

metadata string OPTIONAL

Possible values: 1 ≤ length

Entity metadata key, for example: coverage, frameworks, vulnerabilities

description string OPTIONAL

Possible values: 1 ≤ length

Metadata specification description

schema object OPTIONAL

Metadata specification schema. Must be a valid JSON Schema

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