Get the currently defined configuration model.

GET /configs/model

Request

Query Parameters

flat boolean

If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.

Responses

The list of all kinds.

application/json

Schema
Example (from schema)

Schema

Array [

oneOf

min_length string

The minimal length of this string

max_length string

The maximal length of this string

pattern string

The regexp pattern, that this string has to adhere to

enum string[]

The allowed values of this string enumerated here

runtime_kind string

Possible values: [string, int32, int64, float, double, boolean, date, datetime]

The runtime kind of this kind

circular(StringKind)

fqn string

The fully qualified name of the kind

minimum object

The minimal value of this number

oneOf

MOD1
MOD2

MOD1

The minimal value of this number

maximum object

The maximum value of this number

oneOf

MOD1
MOD2

MOD1

The maximum value of this number

enum integer[]

The allowed values of this number enumerated here

runtime_kind string

Possible values: [string, int32, int64, float, double, boolean, date, datetime]

The runtime kind of this kind

min_length string

The minimal length of this string

max_length string

The maximal length of this string

pattern string

The regexp pattern, that this string has to adhere to

enum string[]

The allowed values of this string enumerated here

fqn string

The fully qualified name of the kind

runtime_kind string

Possible values: [string, int32, int64, float, double, boolean, date, datetime]

The runtime kind of this kind

min_length string

The minimal length of this string

max_length string

The maximal length of this string

pattern string

The regexp pattern, that this string has to adhere to

enum string[]

The allowed values of this string enumerated here

fqn string

The fully qualified name of the kind

runtime_kind string

Possible values: [string, int32, int64, float, double, boolean, date, datetime]

The runtime kind of this kind

min_length string

The minimal length of this string

max_length string

The maximal length of this string

pattern string

The regexp pattern, that this string has to adhere to

enum string[]

The allowed values of this string enumerated here

fqn string

The fully qualified name of the kind

runtime_kind string

Possible values: [string, int32, int64, float, double, boolean, date, datetime]

The runtime kind of this kind

min_length string

The minimal length of this string

max_length string

The maximal length of this string

pattern string

The regexp pattern, that this string has to adhere to

enum string[]

The allowed values of this string enumerated here

fqn string

The fully qualified name of the kind

bases string[]

In case of inheritance, this defines the base kinds.

properties object[]

Defines all properties of this complex kind

Array [

name string

The name of this property

kind string

The fully qualified kind of this property

required boolean

Default value: false

Defines if this property is required or not

description string

Some human readable description of this property

]

allow_unknown_props boolean

Default value: false

In case properties are accepted, that are not listed in the model

successor_kinds object

Dictionary of successor kinds.

property name* string[]

Array [

string

]

fqn string

The fully qualified name of the kind

]

[
  {
    "fqn": "test.dice",
    "runtime_kind": "int32",
    "description": "A dice has 6 sides.",
    "minimum": 1,
    "maximum": 6
  },
  {
    "fqn": "test.social_security_number",
    "runtime_kind": "string",
    "description": "A dice has 6 sides.",
    "pattern": "^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"
  },
  {
    "fqn": "test.base",
    "properties": [
      {
        "name": "kind",
        "kind": "string",
        "required": true,
        "description": "The kind of this compound type."
      },
      {
        "name": "name",
        "kind": "string",
        "description": "The name of the resource.",
        "required": true
      },
      {
        "name": "tags",
        "kind": "dictionary[string, string]",
        "description": "Tags that describe the resource.",
        "required": false
      }
    ]
  },
  {
    "fqn": "test.person",
    "bases": [
      "test.base"
    ],
    "properties": [
      {
        "name": "fortune",
        "kind": "test.dice",
        "description": "The current dice value.",
        "required": true
      },
      {
        "name": "ssn",
        "kind": "test.social_security_number",
        "description": "The social security number of this person.",
        "required": true
      }
    ]
  }
]

Get the currently defined configuration model.

/configs/model

Request​

Query Parameters

Responses​

Contact Us

Request

Responses