Get the currently defined model.

GET /graph/:graph_id/model

Request

Path Parameters

graph_id stringrequired

The identifier of the graph

Example: fix

Query Parameters

flat boolean

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

format string

Possible values: [schema, simple]

The format of the returned json

kind string

Only return information about the defined kinds. Comma separated list.

filter string

Only return information about kinds that include given string. Comma separated list.

aggregate_roots_only boolean

Only return aggregate roots.

with_bases boolean

Include base classes and render the base section

with_property_kinds boolean

Render types of property values. Only together with kind or filter

with_properties boolean

Default value: true

Render the properties of complex kinds

with_relatives boolean

Default value: true

Include information about relationships to other kinds.

with_metadata any

Include metadata information.

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

integer

maximum

object

The maximum value of this number

oneOf

MOD1
MOD2

integer

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

]

[
  {
    "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 model.

/graph/:graph_id/model

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses