repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
fivetran/dbt_yaml_schemas | 1230a7ea888f37dd3dee471467902b77eb0245f6 | 2021-06-03T17:33:20 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 1230a7ea888f37dd3dee471467902b77eb0245f6 | 2021-06-03T17:33:20 | schemas/profiles.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/profiles.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"bigQueryProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-via-gcloud",
"allOf": [
{
"$ref": "#definitions/retriesField"
},
{
"$ref": "#definitions/locationField"
}
],
"properties": {
"impersonate_service_account": {
"type": "string"
},
"maximum_bytes_billed": {
"type": "integer"
},
"method": {
"const": "oauth"
}
},
"required": [
"retries"
]
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-token-based",
"allOf": [
{
"$ref": "#definitions/retriesField"
},
{
"$ref": "#definitions/locationField"
}
],
"oneOf": [
{
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"refresh_token": {
"description": "Using the refresh token and client information, dbt will mint new access tokens as necessary.",
"type": "string"
},
"token_uri": {
"type": "string"
}
},
"required": [
"refresh_token",
"client_id",
"client_secret",
"token_uri"
]
},
{
"properties": {
"token": {
"description": "dbt will use the one-time access token, no questions asked. This approach makes sense if you have an external deployment process that can mint new access tokens and update the profile file accordingly.",
"type": "string"
}
},
"required": [
"token"
]
}
],
"properties": {
"method": {
"const": "oauth-secrets"
}
},
"required": [
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-file",
"allOf": [
{
"$ref": "#definitions/retriesField"
}
],
"properties": {
"keyfile": {
"description": "/path/to/bigquery/keyfile.json",
"type": "string"
},
"method": {
"const": "service-account"
}
},
"required": [
"keyfile",
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-json",
"properties": {
"keyfile_json": {
"properties": {
"auth_provider_x509_cert_url": {
"type": "string"
},
"auth_uri": {
"type": "string"
},
"client_email": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_x509_cert_url": {
"type": "string"
},
"private_key": {
"type": "string"
},
"private_key_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"token_uri": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"project_id",
"private_key_id",
"private_key",
"client_email",
"client_id",
"auth_uri",
"token_uri",
"auth_provider_x509_cert_url",
"client_x509_cert_url"
],
"type": "object"
},
"method": {
"const": "service-account-json"
}
},
"required": [
"keyfile_json"
],
"type": "object"
}
],
"properties": {
"dataset": {
"description": "The name of your dbt dataset",
"type": "string"
},
"priority": {
"description": "The priority for the BigQuery jobs that dbt executes can be configured with the priority configuration in your BigQuery profile. This field can be set to one of batch or interactive. For more information on query priority, consult the BigQuery documentation.",
"enum": [
"batch",
"interactive"
],
"type": "string"
},
"project": {
"description": "GCP project id",
"type": "string"
},
"timeout_seconds": {
"default": 300,
"description": "BigQuery supports query timeouts. By default, the timeout is set to 300 seconds. If a dbt model takes longer than this timeout to complete, then BigQuery may cancel the query.",
"type": "integer"
},
"type": {
"const": "bigquery",
"description": "BigQuery Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile"
}
},
"required": [
"type",
"method",
"project",
"dataset",
"timeout_seconds",
"priority"
],
"type": "object"
},
"common": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"properties": {
"dbname": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The default schema that dbt will build objects in.",
"type": "string"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"host",
"user",
"port",
"dbname",
"schema"
],
"type": "object"
},
"database": {
"description": "The database that dbt should create models in.",
"type": "string"
},
"keepalivesIdleField": {
"properties": {
"keepalives_idle": {
"default": 0,
"type": "integer"
}
},
"required": [
"keepalives_idle"
],
"type": "object"
},
"locationField": {
"properties": {
"location": {
"anyOf": [
{
"const": "US"
},
{
"const": "EU"
},
{
"type": "string"
}
],
"description": "The location of BigQuery datasets can be configured using the location configuration in a BigQuery profile. location may be iether a multi-regional location (e.g. EU, US), or a regional location (e.g. us-west2) as per the the BigQuery documentation describes."
}
},
"type": "object"
},
"passwordField": {
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
},
"postgresProfile": {
"allOf": [
{
"$ref": "#definitions/common"
},
{
"$ref": "#definitions/passwordField"
},
{
"$ref": "#definitions/keepalivesIdleField"
}
],
"properties": {
"role": {
"description": "Controls the Postgres role that dbt assumes when opening new connections to the database.",
"type": "string"
},
"search_path": {
"description": "Controls the Postgres \"search path\" that dbt configures when opening new connections to the database. By default, the Postgres search path is \"$user, public\", meaning that unqualified table names will be searched for in the public schema, or a schema with the same name as the logged-in user. Note: Setting the search_path to a custom value is not necessary or recommended for typical usage of dbt.",
"type": "string"
},
"sslmode": {
"description": "Controls how dbt connectes to Postgres databases using SSL. See the Postgres docs on sslmode for usage information. When unset, dbt will connect to databases using the Postgres default, prefer, as the sslmode.",
"type": "string"
},
"type": {
"const": "postgres",
"description": "Postgres Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/postgres-profile"
}
},
"type": "object"
},
"prestoProfile": {
"allOf": [
{
"$ref": "#definitions/passwordField"
},
{
"$ref": "#definitions/threadsField"
}
],
"properties": {
"database": {
"$ref": "#definitions/database"
},
"host": {
"type": "string"
},
"method": {
"enum": [
"none",
"ldap",
"kerberos"
]
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "presto",
"description": "Presto Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/presto-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"user",
"password",
"database",
"host",
"port",
"schema"
],
"type": "object"
},
"redshiftProfile": {
"allOf": [
{
"$ref": "#definitions/common"
},
{
"$ref": "#definitions/keepalivesIdleField"
}
],
"else": {
"allOf": [
{
"$ref": "#definitions/passwordField"
}
],
"properties": {
"postal_code": {
"pattern": "[A-Z][0-9][A-Z] [0-9][A-Z][0-9]"
}
}
},
"if": {
"properties": {
"method": {
"const": "iam"
}
},
"required": [
"method"
]
},
"properties": {
"search_path": {
"default": "public",
"type": "string"
},
"sslmode": {
"description": "Sets the sslmode used to connect to the database (in case this parameter is set, will look for ca in ~/.postgresql/root.crt)",
"type": "string"
},
"type": {
"const": "redshift",
"description": "Redshift Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/redshift-profile"
}
},
"then": {
"properties": {
"autocreate": {
"type": "boolean"
},
"cluster_id": {
"type": "string"
},
"db_groups": {
"type": "array"
},
"iam_duration_seconds": {
"type": "integer"
},
"iam_profile": {
"description": "When value is set, dbt will use the specified profile from your ~/.aws/config file instead of using the profile name default.",
"type": "string"
}
},
"required": [
"cluster_id"
]
},
"type": "object"
},
"retriesField": {
"properties": {
"retries": {
"description": "The number of times dbt should retry queries that result in unhandled server errors.",
"type": "integer"
}
},
"type": "object"
},
"snowflakeProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$ref": "#definitions/passwordField"
},
{
"properties": {
"private_key_passphrase": {
"description": "passphrase for the private key, if key is encrypted",
"type": "string"
},
"private_key_path": {
"description": "path/to/private.key",
"type": "string"
}
},
"required": [
"private_key_path",
"private_key_passphrase"
]
},
{
"properties": {
"authenticator": {
"description": "Can be one of 'externalbrowser' or a valid Okta URL.",
"type": "string"
}
},
"required": [
"authenticator"
]
}
],
"properties": {
"account": {
"description": "The account to connect to as per Snowflake's documentation.",
"type": "string"
},
"client_session_keep_alive": {
"default": false,
"description": "If provided, issue a periodic select statement to keep the connection open when particularly long-running queries are executing (> 4 hours). Default: False (see note below).",
"type": "boolean"
},
"database": {
"$ref": "#definitions/database"
},
"query_tag": {
"description": "A value with which to tag all queries, for later searching in QUERY_HISTORY view.",
"type": "string"
},
"role": {
"description": "The role to assume when running queries as the specified user.",
"type": "string"
},
"schema": {
"description": "The schema to build models into by default. Can be overridden with custom schemas.",
"type": "string"
},
"type": {
"const": "snowflake",
"description": "Snowflake Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/snowflake-profile"
},
"user": {
"description": "The user to log in as.",
"type": "string"
},
"warehouse": {
"description": "The warehouse to use when building models.",
"type": "string"
}
},
"required": [
"type",
"account",
"user",
"database",
"warehouse",
"schema",
"query_tag"
],
"type": "object"
},
"sparkProfile": {
"oneOf": [
{
"oneOf": [
{
"properties": {
"endpoint": {
"type": "string"
}
},
"required": [
"endpoint"
]
},
{
"properties": {
"cluster": {
"type": "string"
}
},
"required": [
"cluster"
]
}
],
"properties": {
"driver": {
"description": "path/to/driver",
"type": "string"
},
"method": {
"const": "odbc",
"description": "Use the odbc connection method if you are connecting to a Databricks SQL endpoint or interactive cluster via ODBC driver."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"driver",
"organization",
"token"
]
},
{
"properties": {
"auth": {
"type": "string"
},
"kerberos_service_name": {
"type": "string"
},
"method": {
"const": "thrift",
"description": "Use the thrift connection method if you are connecting to a Thrift server sitting in front of a Spark cluster, e.g. a cluster running locally or on Amazon EMR."
}
},
"required": [
"method",
"auth",
"kerberos_service_name"
]
},
{
"properties": {
"cluster": {
"type": "string"
},
"connect_retries": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"connect_timeout": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"method": {
"const": "http",
"description": "Use the http method if your Spark provider supports generic connections over HTTP (e.g. Databricks interactive cluster)."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"organization",
"token",
"cluster"
]
}
],
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "spark",
"description": "Apache Spark Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/spark-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"schema",
"host",
"port",
"user"
],
"type": "object"
},
"threadsField": {
"properties": {
"threads": {
"default": 1,
"description": "The number of threads the dbt project will run on.",
"type": "integer"
}
},
"type": "object"
}
},
"description": "Contains configuration for connecting dbt to your destination. See https://docs.getdbt.com/reference/profiles.yml.",
"patternProperties": {
".*": {
"additionalProperties": false,
"description": "The name of the profile. Contains all the details required to connect to your data warehouse. sure that this is the same name as the profile indicated in your dbt_project.yml file.",
"properties": {
"outputs": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#definitions/postgresProfile"
},
{
"$ref": "#definitions/redshiftProfile"
},
{
"$ref": "#definitions/bigQueryProfile"
},
{
"$ref": "#definitions/snowflakeProfile"
},
{
"$ref": "#definitions/sparkProfile"
},
{
"$ref": "#definitions/prestoProfile"
}
]
}
},
"type": "object"
},
"target": {
"description": "This is the default target your dbt project will use. It must be one of the targets you define in your profile. Commonly it is set to dev.",
"type": "string"
}
},
"required": [
"target",
"outputs"
]
},
"config": {
"additionalProperties": false,
"description": "Contains not database specific options.",
"properties": {
"partial_parse": {
"description": "Partial parsing can improve the performance characteristics of dbt runs by limiting the number of files that are parsed by dbt.\nSee https://docs.getdbt.com/reference/profiles.yml#partial_parse.\nDefault: false.",
"type": "boolean"
},
"printer_width": {
"description": "By default, dbt will print out lines padded to 80 characters wide. You can change it using this option.",
"type": "integer"
},
"send_anonymous_usage_stats": {
"description": "Whether to send anonymous usage statistics or not.\nDefault: true.",
"type": "boolean"
},
"use_colors": {
"description": "By default, dbt will colorize the output it prints in your terminal. You can turn this on and off using this option.\nDefault: true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "dbt profiles.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | dda96143b9fdb75962cd67393816459558c54957 | 2021-06-04T09:07:40 | schemas/profiles.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/profiles.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"bigQueryProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-via-gcloud",
"allOf": [
{
"$ref": "#/definitions/retriesField"
},
{
"$ref": "#/definitions/locationField"
}
],
"properties": {
"impersonate_service_account": {
"type": "string"
},
"maximum_bytes_billed": {
"type": "integer"
},
"method": {
"const": "oauth"
}
},
"required": [
"retries"
]
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-token-based",
"allOf": [
{
"$ref": "#/definitions/retriesField"
},
{
"$ref": "#/definitions/locationField"
}
],
"oneOf": [
{
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"refresh_token": {
"description": "Using the refresh token and client information, dbt will mint new access tokens as necessary.",
"type": "string"
},
"token_uri": {
"type": "string"
}
},
"required": [
"refresh_token",
"client_id",
"client_secret",
"token_uri"
]
},
{
"properties": {
"token": {
"description": "dbt will use the one-time access token, no questions asked. This approach makes sense if you have an external deployment process that can mint new access tokens and update the profile file accordingly.",
"type": "string"
}
},
"required": [
"token"
]
}
],
"properties": {
"method": {
"const": "oauth-secrets"
}
},
"required": [
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-file",
"allOf": [
{
"$ref": "#definitions/retriesField"
}
],
"properties": {
"keyfile": {
"description": "/path/to/bigquery/keyfile.json",
"type": "string"
},
"method": {
"const": "service-account"
}
},
"required": [
"keyfile",
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-json",
"properties": {
"keyfile_json": {
"properties": {
"auth_provider_x509_cert_url": {
"type": "string"
},
"auth_uri": {
"type": "string"
},
"client_email": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_x509_cert_url": {
"type": "string"
},
"private_key": {
"type": "string"
},
"private_key_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"token_uri": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"project_id",
"private_key_id",
"private_key",
"client_email",
"client_id",
"auth_uri",
"token_uri",
"auth_provider_x509_cert_url",
"client_x509_cert_url"
],
"type": "object"
},
"method": {
"const": "service-account-json"
}
},
"required": [
"keyfile_json"
],
"type": "object"
}
],
"properties": {
"dataset": {
"description": "The name of your dbt dataset",
"type": "string"
},
"priority": {
"description": "The priority for the BigQuery jobs that dbt executes can be configured with the priority configuration in your BigQuery profile. This field can be set to one of batch or interactive. For more information on query priority, consult the BigQuery documentation.",
"enum": [
"batch",
"interactive"
],
"type": "string"
},
"project": {
"description": "GCP project id",
"type": "string"
},
"timeout_seconds": {
"default": 300,
"description": "BigQuery supports query timeouts. By default, the timeout is set to 300 seconds. If a dbt model takes longer than this timeout to complete, then BigQuery may cancel the query.",
"type": "integer"
},
"type": {
"const": "bigquery",
"description": "BigQuery Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile"
}
},
"required": [
"type",
"method",
"project",
"dataset",
"timeout_seconds",
"priority"
],
"type": "object"
},
"common": {
"allOf": [
{
"$ref": "#/definitions/threadsField"
}
],
"properties": {
"dbname": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The default schema that dbt will build objects in.",
"type": "string"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"host",
"user",
"port",
"dbname",
"schema"
],
"type": "object"
},
"database": {
"description": "The database that dbt should create models in.",
"type": "string"
},
"keepalivesIdleField": {
"properties": {
"keepalives_idle": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"locationField": {
"properties": {
"location": {
"anyOf": [
{
"const": "US"
},
{
"const": "EU"
},
{
"type": "string"
}
],
"description": "The location of BigQuery datasets can be configured using the location configuration in a BigQuery profile. location may be iether a multi-regional location (e.g. EU, US), or a regional location (e.g. us-west2) as per the the BigQuery documentation describes."
}
},
"type": "object"
},
"passwordField": {
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
},
"postgresProfile": {
"allOf": [
{
"$ref": "#/definitions/common"
},
{
"$ref": "#/definitions/passwordField"
},
{
"$ref": "#/definitions/keepalivesIdleField"
}
],
"properties": {
"role": {
"description": "Controls the Postgres role that dbt assumes when opening new connections to the database.",
"type": "string"
},
"search_path": {
"description": "Controls the Postgres \"search path\" that dbt configures when opening new connections to the database. By default, the Postgres search path is \"$user, public\", meaning that unqualified table names will be searched for in the public schema, or a schema with the same name as the logged-in user. Note: Setting the search_path to a custom value is not necessary or recommended for typical usage of dbt.",
"type": "string"
},
"sslmode": {
"description": "Controls how dbt connectes to Postgres databases using SSL. See the Postgres docs on sslmode for usage information. When unset, dbt will connect to databases using the Postgres default, prefer, as the sslmode.",
"type": "string"
},
"type": {
"const": "postgres",
"description": "Postgres Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/postgres-profile"
}
},
"type": "object"
},
"prestoProfile": {
"allOf": [
{
"$ref": "#/definitions/passwordField"
},
{
"$ref": "#/definitions/threadsField"
}
],
"properties": {
"database": {
"$ref": "#/definitions/database"
},
"host": {
"type": "string"
},
"method": {
"enum": [
"none",
"ldap",
"kerberos"
]
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "presto",
"description": "Presto Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/presto-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"user",
"password",
"database",
"host",
"port",
"schema"
],
"type": "object"
},
"redshiftProfile": {
"allOf": [
{
"$ref": "#/definitions/common"
},
{
"$ref": "#/definitions/keepalivesIdleField"
}
],
"else": {
"allOf": [
{
"$ref": "#/definitions/passwordField"
}
],
"properties": {
"postal_code": {
"pattern": "[A-Z][0-9][A-Z] [0-9][A-Z][0-9]"
}
}
},
"if": {
"properties": {
"method": {
"const": "iam"
}
},
"required": [
"method"
]
},
"properties": {
"search_path": {
"default": "public",
"type": "string"
},
"sslmode": {
"description": "Sets the sslmode used to connect to the database (in case this parameter is set, will look for ca in ~/.postgresql/root.crt)",
"type": "string"
},
"type": {
"const": "redshift",
"description": "Redshift Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/redshift-profile"
}
},
"then": {
"properties": {
"autocreate": {
"type": "boolean"
},
"cluster_id": {
"type": "string"
},
"db_groups": {
"type": "array"
},
"iam_duration_seconds": {
"type": "integer"
},
"iam_profile": {
"description": "When value is set, dbt will use the specified profile from your ~/.aws/config file instead of using the profile name default.",
"type": "string"
}
},
"required": [
"cluster_id"
]
},
"type": "object"
},
"retriesField": {
"properties": {
"retries": {
"default": 1,
"description": "The number of times dbt should retry queries that result in unhandled server errors.",
"type": "integer"
}
},
"type": "object"
},
"snowflakeProfile": {
"allOf": [
{
"$ref": "#/definitions/threadsField"
}
],
"oneOf": [
{
"$ref": "#/definitions/passwordField"
},
{
"properties": {
"private_key_passphrase": {
"description": "passphrase for the private key, if key is encrypted",
"type": "string"
},
"private_key_path": {
"description": "path/to/private.key",
"type": "string"
}
},
"required": [
"private_key_path",
"private_key_passphrase"
]
},
{
"properties": {
"authenticator": {
"description": "Can be one of 'externalbrowser' or a valid Okta URL.",
"type": "string"
}
},
"required": [
"authenticator"
]
}
],
"properties": {
"account": {
"description": "The account to connect to as per Snowflake's documentation.",
"type": "string"
},
"client_session_keep_alive": {
"default": false,
"description": "If provided, issue a periodic select statement to keep the connection open when particularly long-running queries are executing (> 4 hours). Default: False (see note below).",
"type": "boolean"
},
"database": {
"$ref": "#/definitions/database"
},
"query_tag": {
"description": "A value with which to tag all queries, for later searching in QUERY_HISTORY view.",
"type": "string"
},
"role": {
"description": "The role to assume when running queries as the specified user.",
"type": "string"
},
"schema": {
"description": "The schema to build models into by default. Can be overridden with custom schemas.",
"type": "string"
},
"type": {
"const": "snowflake",
"description": "Snowflake Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/snowflake-profile"
},
"user": {
"description": "The user to log in as.",
"type": "string"
},
"warehouse": {
"description": "The warehouse to use when building models.",
"type": "string"
}
},
"required": [
"type",
"account",
"user",
"database",
"warehouse",
"schema",
"query_tag"
],
"type": "object"
},
"sparkProfile": {
"oneOf": [
{
"oneOf": [
{
"properties": {
"endpoint": {
"type": "string"
}
},
"required": [
"endpoint"
]
},
{
"properties": {
"cluster": {
"type": "string"
}
},
"required": [
"cluster"
]
}
],
"properties": {
"driver": {
"description": "path/to/driver",
"type": "string"
},
"method": {
"const": "odbc",
"description": "Use the odbc connection method if you are connecting to a Databricks SQL endpoint or interactive cluster via ODBC driver."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"driver",
"organization",
"token"
]
},
{
"properties": {
"auth": {
"type": "string"
},
"kerberos_service_name": {
"type": "string"
},
"method": {
"const": "thrift",
"description": "Use the thrift connection method if you are connecting to a Thrift server sitting in front of a Spark cluster, e.g. a cluster running locally or on Amazon EMR."
}
},
"required": [
"method",
"auth",
"kerberos_service_name"
]
},
{
"properties": {
"cluster": {
"type": "string"
},
"connect_retries": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"connect_timeout": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"method": {
"const": "http",
"description": "Use the http method if your Spark provider supports generic connections over HTTP (e.g. Databricks interactive cluster)."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"organization",
"token",
"cluster"
]
}
],
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "spark",
"description": "Apache Spark Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/spark-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"schema",
"host",
"port",
"user"
],
"type": "object"
},
"threadsField": {
"properties": {
"threads": {
"default": 1,
"description": "The number of threads the dbt project will run on.",
"type": "integer"
}
},
"type": "object"
}
},
"description": "Contains configuration for connecting dbt to your destination. See https://docs.getdbt.com/reference/profiles.yml.",
"patternProperties": {
".*": {
"additionalProperties": false,
"description": "The name of the profile. Contains all the details required to connect to your data warehouse. Make sure that this is the same name as the profile indicated in your dbt_project.yml file.",
"properties": {
"outputs": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/definitions/postgresProfile"
},
{
"$ref": "#/definitions/redshiftProfile"
},
{
"$ref": "#/definitions/bigQueryProfile"
},
{
"$ref": "#/definitions/snowflakeProfile"
},
{
"$ref": "#/definitions/sparkProfile"
},
{
"$ref": "#/definitions/prestoProfile"
}
]
}
},
"type": "object"
},
"target": {
"description": "This is the default target your dbt project will use. It must be one of the targets you define in your profile. Commonly it is set to dev.",
"type": "string"
}
},
"required": [
"target",
"outputs"
]
},
"config": {
"additionalProperties": false,
"description": "Common configuration for all profiles.",
"properties": {
"partial_parse": {
"default": false,
"description": "Partial parsing can improve the performance characteristics of dbt runs by limiting the number of files that are parsed by dbt.\nSee https://docs.getdbt.com/reference/profiles.yml#partial_parse",
"type": "boolean"
},
"printer_width": {
"default": 80,
"description": "By default, dbt will print out lines padded to 80 characters wide. You can change it using this option.",
"type": "integer"
},
"send_anonymous_usage_stats": {
"default": true,
"description": "Whether to send anonymous usage statistics or not.",
"type": "boolean"
},
"use_colors": {
"default": true,
"description": "By default, dbt will colorize the output it prints in your terminal. You can turn this on and off using this option.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "dbt profiles.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | e2e4ab0db66d33c5f5fe63dd441a6a42d60c677c | 2021-06-03T19:03:21 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"additionalProperties": false,
"description": "Whether dbt should quote databases, schemas, and identifiers when creating relations (tables/views) or when resolving a ref function to a direct relation reference.\nThe default values vary by database.\nNote that for BigQuery quoting configuration, 'database' and 'schema' should be used here, though these configs will apply to project and dataset names respectively.",
"properties": {
"database": {
"type": "boolean"
},
"identifier": {
"type": "boolean"
},
"schema": {
"type": "boolean"
}
},
"type": "object"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
DiSSCo/openDS | d9cd00689724d015d10b11102948f73081252418 | 2023-12-14T10:05:18 | data-model/annotations/0.1.0/schema/INTERNAL_annotation_backend_request.json | 15 | 2024-05-27T22:12:25.395619Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"course": {
"allOf": [
{
"$ref": "https://schemas.dissco.tech/schemas/annotations/0.1.0/annotations.json"
},
{
"properties": {
"text": {
"pattern": "[a-z][0-9]"
}
}
}
]
}
}
} | Apache-2.0 | null |
DiSSCo/openDS | 3f055d3678e61dde921b54216b8510e43e7a50d9 | 2024-03-05T13:25:23 | data-model/annotations/0.1.0/schema/annotation-for-mas.json | 15 | 2024-05-27T22:12:25.395619Z | {
"$id": "https://schemas.dissco.tech/schemas/annotations/0.1.0/annotations-for-mas.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Schema specific to Machine Annotation Services providing information to DiSSCo.",
"properties": {
"dcterms:created": {
"format": "date-time",
"type": "string"
},
"oa:body": {
"properties": {
"dcterms:reference": {
"type": "string"
},
"oa:value": {
"type": "array"
},
"ods:score": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"ods:type": {
"type": "string"
}
},
"required": [
"ods:type",
"oa:value"
],
"type": "object"
},
"oa:creator": {
"properties": {
"foaf:name": {
"type": "string"
},
"ods:id": {
"type": "string"
},
"ods:type": {
"type": "string"
}
},
"required": [
"ods:id",
"ods:type"
],
"type": "object"
},
"oa:motivatedBy": {
"type": "string"
},
"oa:motivation": {
"enum": [
"ods:adding",
"oa:assessing",
"oa:editing",
"oa:commenting"
]
},
"oa:target": {
"properties": {
"oa:selector": {
"oneOf": [
{
"properties": {
"ods:field": {
"type": "string"
},
"ods:type": {
"const": "FieldSelector"
}
},
"required": [
"ods:type",
"ods:field"
],
"type": "object"
},
{
"properties": {
"oa:class": {
"type": "string"
},
"ods:type": {
"const": "ClassSelector"
}
},
"required": [
"ods:type",
"oa:class"
],
"type": "object"
},
{
"properties": {
"ac:hasRoi": {
"properties": {
"ac:heightFrac": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"ac:widthFrac": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"ac:xFrac": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"ac:yFrac": {
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"required": [
"ac:xFrac",
"ac:yFrac",
"ac:widthFrac",
"ac:heightFrac"
],
"type": "object"
},
"dcterms:conformsTo": {
"type": "string"
},
"ods:type": {
"const": "FragmentSelector"
}
},
"required": [
"ods:type",
"ac:hasRoi"
],
"type": "object"
}
],
"type": "object"
},
"ods:id": {
"type": "string"
},
"ods:type": {
"type": "string"
}
},
"required": [
"ods:id",
"ods:type"
],
"type": "object"
},
"ods:id": {
"type": "string"
},
"placeInBatch": {
"type": "number"
},
"rdf:type": {
"const": "Annotation"
},
"schema.org:aggregateRating": {
"properties": {
"ods:type": {
"type": "string"
},
"schema.org:ratingCount": {
"type": "number"
},
"schema.org:ratingValue": {
"type": "number"
}
},
"required": [
"ods:type",
"schema.org:ratingCount",
"schema.org:ratingValue"
],
"type": "object"
}
},
"required": [
"rdf:type",
"oa:motivation",
"oa:target",
"oa:body",
"oa:creator"
],
"type": "object"
} | Apache-2.0 | null |
FormantIO/formant | b31bfa7a5e8efdb08b320e206dfb6a1332ca2b9d | 2022-10-04T14:25:20 | examples/python/formant_module/agent/adapter_with_config/config_schema.json | 5 | 2024-05-29T09:17:18.132857Z | {
"$id": "https://formant.io/formant_ping_adapter_configuration.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Configuration for the ping adapter.",
"properties": {
"formant_stream": {
"description": "The Formant stream to send the ping results to.",
"type": "string"
},
"hostname": {
"description": "The host to ping.",
"format": "hostname",
"type": "string"
},
"interval": {
"description": "The interval in seconds between ping attempts.",
"exclusiveMinimum": 0,
"type": "number"
},
"timeout": {
"description": "The timeout in seconds to wait for a response from the host.",
"minimum": 0,
"type": "number"
}
},
"title": "Formant Ping Adapter Configuration",
"type": "object"
} | Apache-2.0 | en |
FormantIO/formant | 2686d53f59312dc6672818f31427544b205fa2b4 | 2023-02-10T03:17:09 | examples/python/formant_module/agent/JSON/config_schema.json | 5 | 2024-05-29T09:17:18.132857Z | {
"$id": "",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Configuration for all data to be read from JSON.",
"properties": {
"json_adapter_configuration": {
"description": "A list of the data to pull from the json.",
"items": {
"properties": {
"data_key": {
"description": "The list of keys to use for bitset or numeric set data.",
"items": {
"properties": {
"key": {
"description": "The key of the tag to use for this data."
}
},
"required": [
"key"
],
"type": "string"
},
"type": "array"
},
"data_units": {
"description": "The units to use for numeric set data.",
"items": {
"properties": {
"unit": {
"description": "The unit use for this data."
}
},
"required": [
"unit"
],
"type": "string"
},
"type": "array"
},
"fields": {
"description": "List of field values",
"items": {
"properties": {
"field": {
"description": "If retrieving data from a list (i.e if index is used), you can optionally specify a specific field form the item"
}
},
"type": "string"
},
"type": "array"
},
"indices": {
"description": "List of individual indices to grab from an array entry",
"items": {
"properties": {
"index": {
"description": "If the path leads to a list, specify which index from the list to ingest"
}
},
"type": "integer"
},
"type": "array"
},
"paths": {
"description": "A list of paths within the json to select data from for a particular stream.",
"items": {
"properties": {
"path": {
"description": "The path of the data queried in the system state json."
}
},
"required": [
"path"
],
"type": "string"
},
"type": "array"
},
"stream_name": {
"description": "The Formant stream name to ingest data using.",
"type": "string"
},
"tag_key": {
"description": "The key of the tag to use for this data.",
"type": "string"
},
"tag_value": {
"description": "The value of the tag to use for this data.",
"type": "string"
},
"type": {
"description": "The Formant Client function that should be used to ingest this data; e.g text, json, numeric. (https://docs.formant.io/reference/sending-basic-datapoints)",
"type": "string"
}
},
"required": [
"paths",
"type"
],
"type": "object"
},
"type": "array"
},
"json_path": {
"description": "File path where JSON files are generated",
"type": "string"
}
},
"title": "Formant JSON Adapter Configuration",
"type": "object"
} | Apache-2.0 | en |
pwall567/json-kotlin-schema-codegen | d7741eb098431e002ee670e99d2bcf213008d6e3 | 2022-02-20T12:42:54 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 57a28024315708cdda39e41c133a856afd3fffb7 | 2024-02-25T14:27:59 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"additionalPropertiesOption": {
"enum": [
"ignore",
"strict"
],
"type": "string"
},
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"companionObject": {
"items": {
"type": "string"
},
"type": [
"boolean",
"array"
]
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"defaultValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"examplesValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 6a08095a2c5466fc2371ae2275bdf1dc354722e4 | 2024-03-04T14:13:18 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"additionalPropertiesOption": {
"enum": [
"ignore",
"strict"
],
"type": "string"
},
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-zA-Z0-9%:./_~-]+:$": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"companionObject": {
"items": {
"type": "string"
},
"type": [
"boolean",
"array"
]
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"defaultValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"examplesValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"extensibleEnumKeyword": {
"pattern": "^x(-[A-Za-z0-9]+)+$",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 39bb0a3a27dca2b72e241b5f9f52147e97756e5b | 2023-01-04T11:54:20 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"companionObject": {
"items": {
"type": "string"
},
"type": [
"boolean",
"array"
]
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 76cba5be9951dc3324f1d540a09f5ee579f9c17b | 2021-11-21T12:44:38 | src/test/resources/json-schema-org/product.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"dimensions": {
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"length",
"width",
"height"
],
"type": "object"
},
"price": {
"description": "The price of the product",
"exclusiveMinimum": 0,
"type": "number"
},
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
},
"tags": {
"description": "Tags for the product",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"warehouseLocation": {
"$ref": "https://example.com/geographical-location.schema.json",
"description": "Coordinates of the warehouse where the product is located."
}
},
"required": [
"productId",
"productName",
"price"
],
"title": "Product",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | a5390e14d17576254beecccdee06ac950d4ef186 | 2022-07-19T15:38:28 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 344e85313297fd6f3b605573f60688d10bd7a7bf | 2021-11-21T12:47:25 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"CustomClassByFormat": {
"properties": {
"className": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"format": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"format",
"className"
],
"type": "object"
},
"CustomClassByKeyword": {
"properties": {
"className": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"keyword": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"value": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"keyword",
"value",
"className"
],
"type": "object"
},
"CustomClassByURI": {
"properties": {
"className": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"uri": {
"format": "uri",
"type": "string"
}
},
"required": [
"uri",
"className"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"classNames": {
"items": {
"properties": {
"id": {
"format": "uri",
"type": "string"
},
"name": {
"maxLength": 512,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"customClasses": {
"items": {
"oneOf": [
{
"$ref": "#/$defs/CustomClassByFormat"
},
{
"$ref": "#/$defs/CustomClassByURI"
},
{
"$ref": "#/$defs/CustomClassByKeyword"
}
]
},
"type": "array"
},
"generatorComment": {
"minLength": 1,
"type": "string"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 91640e85916f907257f950d696046bf4cf39021c | 2024-02-07T14:03:44 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"additionalPropertiesOption": {
"enum": [
"ignore",
"strict"
],
"type": "string"
},
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"companionObject": {
"items": {
"type": "string"
},
"type": [
"boolean",
"array"
]
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | a8ff584c47c35f12ac88d14124631d48521884ab | 2021-12-08T14:02:02 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"classNames": {
"patternProperties": {
"^[a-z]+:": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema-codegen | 608b8a7252b548f9260127cb468fbfc05915bade | 2024-03-10T12:58:38 | src/main/resources/schema/codegen-config.schema.json | 74 | 2024-05-27T22:02:49.472969Z | {
"$defs": {
"ClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"QualifiedClassName": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/pwall567/json-kotlin-schema-codegen/main/src/main/resources/schema/codegen-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Code Generation Configuration File",
"properties": {
"additionalPropertiesOption": {
"enum": [
"ignore",
"strict"
],
"type": "string"
},
"annotations": {
"additionalProperties": false,
"properties": {
"classes": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"fields": {
"additionalProperties": false,
"patternProperties": {
"^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"classNames": {
"patternProperties": {
"^[a-zA-Z0-9%:./_~-]+:$": {
"$ref": "#/$defs/QualifiedClassName"
}
},
"type": "object"
},
"companionObject": {
"items": {
"type": "string"
},
"type": [
"boolean",
"array"
]
},
"customClasses": {
"properties": {
"extension": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"format": {
"additionalProperties": false,
"patternProperties": {
"^[A-Za-z][A-Za-z0-9]*(-[A-Za-z0-9]+)*$": {
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
},
"uri": {
"additionalProperties": false,
"patternProperties": {
"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?": {
"$comment": "The URI pattern above is taken from https://www.rfc-editor.org/rfc/rfc3986#appendix-B",
"$ref": "#/$defs/ClassName"
}
},
"type": "object"
}
},
"type": "object"
},
"decimalClassName": {
"$ref": "#/$defs/QualifiedClassName"
},
"defaultValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"derivePackageFromStructure": {
"type": "boolean"
},
"description": {
"$comment": "For documentation purposes only",
"type": "string"
},
"examplesValidationOption": {
"enum": [
"none",
"warn",
"block"
],
"type": "string"
},
"extensibleEnumKeyword": {
"pattern": "^x(-[A-Za-z0-9]+)+$",
"type": "string"
},
"extensionValidations": {
"additionalProperties": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"type": "object"
},
"generatorComment": {
"minLength": 1,
"type": [
"string",
"null"
]
},
"markerInterface": {
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z][a-z0-9]*\\.)*[A-Za-z][A-Za-z0-9]*$",
"type": [
"string",
"null"
]
},
"nestedClassNameOption": {
"enum": [
"property",
"refSchema"
],
"type": "string"
},
"nonStandardFormat": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2019-09/meta/applicator"
},
"type": "object"
},
"packageName": {
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)*$",
"type": [
"string",
"null"
]
},
"targetLanguage": {
"enum": [
"kotlin",
"java",
"typescript"
],
"type": "string"
},
"title": {
"$comment": "For documentation purposes only",
"type": "string"
},
"version": {
"$comment": "For documentation purposes only",
"type": "string"
}
},
"title": "CodegenConfig",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema | 172b7aca72289d8cb1f9f8577b30cfbce62df5f6 | 2022-02-20T11:00:34 | src/test/resources/http/testhttp2.json | 82 | 2024-05-27T21:49:13.354502Z | {
"$defs": {
"Def1": {
"properties": {
"aaa": {
"type": "integer"
}
},
"required": [
"aaa"
],
"type": "object"
}
},
"$id": "http://pwall.net/test/schema/testhttp2.json",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | en |
pwall567/json-kotlin-schema | 2c04ec10f15b6013c9ed9d5f958fd71ff266524a | 2021-06-20T06:14:32 | src/test/resources/test-domestic-address.schema.json | 82 | 2024-05-27T21:49:13.354502Z | {
"$id": "https://pwall.net/test-domestic-address",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"line1": {
"minLength": 1,
"type": "string"
},
"line2": {
"minLength": 1,
"type": "string"
},
"postcode": {
"pattern": "^[0-9]{4}$",
"type": "string"
},
"state": {
"enum": [
"NSW",
"QLD",
"VIC",
"TAS",
"SA",
"WA",
"ACT",
"NT"
],
"type": "string"
}
},
"required": [
"line1",
"state",
"postcode"
],
"title": "Domestic Address",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema | 2c04ec10f15b6013c9ed9d5f958fd71ff266524a | 2021-06-20T06:14:32 | src/test/resources/test-international-address.schema.json | 82 | 2024-05-27T21:49:13.354502Z | {
"$id": "https://pwall.net/test-international-address",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"country": {
"minLength": 1,
"type": "string"
},
"line1": {
"minLength": 1,
"type": "string"
},
"line2": {
"minLength": 1,
"type": "string"
},
"line3": {
"minLength": 1,
"type": "string"
},
"line4": {
"minLength": 1,
"type": "string"
}
},
"required": [
"line1",
"line2",
"country"
],
"title": "Domestic Address",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema | 2c04ec10f15b6013c9ed9d5f958fd71ff266524a | 2021-06-20T06:14:32 | src/test/resources/test-oneof.schema.json | 82 | 2024-05-27T21:49:13.354502Z | {
"$id": "https://pwall.net/test-oneof",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"properties": {
"customerType": {
"const": "domestic"
},
"domesticAddress": {
"$ref": "test-domestic-address.schema.json"
}
},
"required": [
"domesticAddress"
]
},
{
"properties": {
"customerType": {
"const": "international"
},
"internationalAddress": {
"$ref": "test-international-address.schema.json"
}
},
"required": [
"internationalAddress"
]
}
],
"properties": {
"customerType": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"name",
"customerType"
],
"title": "Customer",
"type": "object"
} | MIT | en |
pwall567/json-kotlin-schema | 172b7aca72289d8cb1f9f8577b30cfbce62df5f6 | 2022-02-20T11:00:34 | src/test/resources/http/testhttp1.json | 82 | 2024-05-27T21:49:13.354502Z | {
"$id": "http://pwall.net/test/schema/testhttp1.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"xxx": {
"$ref": "testhttp2.json#/$defs/Def1"
}
},
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 1cb42c2eef83f6c818cba9cbb506d9f0deacad66 | 2023-09-27T01:05:49 | schemas/mof.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 67e65785623330af60f7bbf2eab7f48d4580f322 | 2022-07-19T23:24:57 | schemas/mof.1.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.1.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"const": 1
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 1076067f404510d8ef3b4c8b8d6cd87ac13151a4 | 2021-03-09T07:47:45 | schemas/mof.0.6.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.0.5.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `variable`.",
"examples": [
"{\"type\": \"SingleVariable\", \"variable\": \"x\"}"
],
"properties": {
"type": {
"const": "SingleVariable"
},
"variable": {
"type": "string"
}
},
"required": [
"variable"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"IndicatorSet\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "IndicatorSet"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 sum\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 0
},
"minor": {
"const": 6
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | cab89d5b8083ffdfb9df7d890e00c3aafe83a927 | 2021-09-09T02:45:14 | schemas/mof.1.0.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.0.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"const": 0
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | e0260b4d397e051bd6f75d6e194109ed06bb588c | 2021-03-09T07:50:55 | schemas/mof.0.6.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.0.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `variable`.",
"examples": [
"{\"type\": \"SingleVariable\", \"variable\": \"x\"}"
],
"properties": {
"type": {
"const": "SingleVariable"
},
"variable": {
"type": "string"
}
},
"required": [
"variable"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"IndicatorSet\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "IndicatorSet"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 sum\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 0
},
"minor": {
"const": 6
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 550bd2ddbe3647436a3486254c5650a4c76db594 | 2023-09-28T22:27:39 | schemas/mof.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.7.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"abs",
"sqrt",
"cbrt",
"abs2",
"inv",
"log",
"log10",
"log2",
"log1p",
"exp",
"exp2",
"expm1",
"sin",
"cos",
"tan",
"sec",
"csc",
"cot",
"sind",
"cosd",
"tand",
"secd",
"cscd",
"cotd",
"asin",
"acos",
"atan",
"asec",
"acsc",
"acot",
"asind",
"acosd",
"atand",
"asecd",
"acscd",
"acotd",
"sinh",
"cosh",
"tanh",
"sech",
"csch",
"coth",
"asinh",
"acosh",
"atanh",
"asech",
"acsch",
"acoth",
"deg2rad",
"rad2deg",
"erf",
"erfinv",
"erfc",
"erfcinv",
"erfi",
"gamma",
"lgamma",
"digamma",
"invdigamma",
"trigamma",
"airyai",
"airybi",
"airyaiprime",
"airybiprime",
"besselj0",
"besselj1",
"bessely0",
"bessely1",
"erfcx",
"dawson",
"floor",
"ceil"
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^",
"atan",
"&&",
"||",
"<=",
"<",
">=",
">",
"=="
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"ifelse",
"min",
"max"
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"type",
"real",
"imag"
],
"type": "object"
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"type",
"index"
],
"type": "object"
},
{
"description": "A reference to an optimization variable",
"examples": [
"\"x\""
],
"type": "string"
},
{
"description": "A real-valued numeric constant",
"examples": [
1.0
],
"type": "number"
}
]
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 81c35507c6c36d552aa4c07f545b453555e099a9 | 2020-08-23T21:50:23 | schemas/mof.0.5.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.0.5.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `variable`.",
"examples": [
"{\"type\": \"SingleVariable\", \"variable\": \"x\"}"
],
"properties": {
"type": {
"const": "SingleVariable"
},
"variable": {
"type": "string"
}
},
"required": [
"variable"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"IndicatorSet\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "IndicatorSet"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 sum\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 0
},
"minor": {
"const": 5
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | c29e2dd35392a85594cb9a24210b8241ee26f409 | 2021-07-06T01:25:26 | schemas/mof.0.6.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.0.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `variable`.",
"examples": [
"{\"type\": \"SingleVariable\", \"variable\": \"x\"}"
],
"properties": {
"type": {
"const": "SingleVariable"
},
"variable": {
"type": "string"
}
},
"required": [
"variable"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"IndicatorSet\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "IndicatorSet"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 0
},
"minor": {
"const": 6
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 1d0129ade1bf71c8c756f835c5fe4e898b04f243 | 2023-04-27T23:14:57 | schemas/mof.1.3.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.3.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 550bd2ddbe3647436a3486254c5650a4c76db594 | 2023-09-28T22:27:39 | schemas/mof.1.7.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.7.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"abs",
"sqrt",
"cbrt",
"abs2",
"inv",
"log",
"log10",
"log2",
"log1p",
"exp",
"exp2",
"expm1",
"sin",
"cos",
"tan",
"sec",
"csc",
"cot",
"sind",
"cosd",
"tand",
"secd",
"cscd",
"cotd",
"asin",
"acos",
"atan",
"asec",
"acsc",
"acot",
"asind",
"acosd",
"atand",
"asecd",
"acscd",
"acotd",
"sinh",
"cosh",
"tanh",
"sech",
"csch",
"coth",
"asinh",
"acosh",
"atanh",
"asech",
"acsch",
"acoth",
"deg2rad",
"rad2deg",
"erf",
"erfinv",
"erfc",
"erfcinv",
"erfi",
"gamma",
"lgamma",
"digamma",
"invdigamma",
"trigamma",
"airyai",
"airybi",
"airyaiprime",
"airybiprime",
"besselj0",
"besselj1",
"bessely0",
"bessely1",
"erfcx",
"dawson",
"floor",
"ceil"
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^",
"atan",
"&&",
"||",
"<=",
"<",
">=",
">",
"=="
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"ifelse",
"min",
"max"
]
}
},
"required": [
"type",
"args"
],
"type": "object"
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"type",
"real",
"imag"
],
"type": "object"
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"type",
"index"
],
"type": "object"
},
{
"description": "A reference to an optimization variable",
"examples": [
"\"x\""
],
"type": "string"
},
{
"description": "A real-valued numeric constant",
"examples": [
1.0
],
"type": "number"
}
]
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 7cc33ef69fcb93bbc75b2b55ceb61dbafc7220f3 | 2023-09-27T03:10:52 | schemas/mof.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"abs",
"sqrt",
"cbrt",
"abs2",
"inv",
"log",
"log10",
"log2",
"log1p",
"exp",
"exp2",
"expm1",
"sin",
"cos",
"tan",
"sec",
"csc",
"cot",
"sind",
"cosd",
"tand",
"secd",
"cscd",
"cotd",
"asin",
"acos",
"atan",
"asec",
"acsc",
"acot",
"asind",
"acosd",
"atand",
"asecd",
"acscd",
"acotd",
"sinh",
"cosh",
"tanh",
"sech",
"csch",
"coth",
"asinh",
"acosh",
"atanh",
"asech",
"acsch",
"acoth",
"deg2rad",
"rad2deg",
"erf",
"erfinv",
"erfc",
"erfcinv",
"erfi",
"gamma",
"lgamma",
"digamma",
"invdigamma",
"trigamma",
"airyai",
"airybi",
"airyaiprime",
"airybiprime",
"besselj0",
"besselj1",
"bessely0",
"bessely1",
"erfcx",
"dawson",
"floor",
"ceil"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^",
"atan",
"&&",
"||",
"<=",
"<",
">=",
">",
"=="
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"ifelse",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 7cc33ef69fcb93bbc75b2b55ceb61dbafc7220f3 | 2023-09-27T03:10:52 | schemas/mof.1.6.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"abs",
"sqrt",
"cbrt",
"abs2",
"inv",
"log",
"log10",
"log2",
"log1p",
"exp",
"exp2",
"expm1",
"sin",
"cos",
"tan",
"sec",
"csc",
"cot",
"sind",
"cosd",
"tand",
"secd",
"cscd",
"cotd",
"asin",
"acos",
"atan",
"asec",
"acsc",
"acot",
"asind",
"acosd",
"atand",
"asecd",
"acscd",
"acotd",
"sinh",
"cosh",
"tanh",
"sech",
"csch",
"coth",
"asinh",
"acosh",
"atanh",
"asech",
"acsch",
"acoth",
"deg2rad",
"rad2deg",
"erf",
"erfinv",
"erfc",
"erfcinv",
"erfi",
"gamma",
"lgamma",
"digamma",
"invdigamma",
"trigamma",
"airyai",
"airybi",
"airyaiprime",
"airybiprime",
"besselj0",
"besselj1",
"bessely0",
"bessely1",
"erfcx",
"dawson",
"floor",
"ceil"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^",
"atan",
"&&",
"||",
"<=",
"<",
">=",
">",
"=="
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"ifelse",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | aba1e78b1c6d56a03ba02978d739bb3402986c16 | 2023-09-07T00:15:00 | schemas/mof.1.5.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.5.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 83c973194bb4541769457a2ea177006c286bde31 | 2023-05-08T21:40:52 | schemas/mof.1.4.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.4.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns, such that the off-diagonal entries are scaled by \u221a2. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"ScaledPositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 01af5b9d4c90bf094ef6e1fd252aec7260e294d8 | 2022-11-29T22:00:13 | schemas/mof.1.2.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.2.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 1cb42c2eef83f6c818cba9cbb506d9f0deacad66 | 2023-09-27T01:05:49 | schemas/mof.1.6.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.6.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "The vector-valued nonlinear function `f(x)`, comprised of a vector of `ScalarNonlinearFunction`.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"type": {
"const": "VectorNonlinearFunction"
}
},
"required": [
"rows",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5,
6
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 81c35507c6c36d552aa4c07f545b453555e099a9 | 2020-08-23T21:50:23 | schemas/mof.0.4.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.0.4.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"head": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"head": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"head": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"head\": \"real\", \"value\": 1.0}"
],
"properties": {
"head": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"head\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"head": {
"const": "complex"
},
"imag": {
"type": "number"
},
"real": {
"type": "number"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"head\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"head": {
"const": "variable"
},
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"head\": \"node\", \"index\": 2}"
],
"properties": {
"head": {
"const": "node"
},
"index": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"index"
]
}
],
"required": [
"head"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `variable`.",
"examples": [
"{\"head\": \"SingleVariable\", \"variable\": \"x\"}"
],
"properties": {
"head": {
"const": "SingleVariable"
},
"variable": {
"type": "string"
}
},
"required": [
"variable"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"head\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"head": {
"const": "ScalarAffineFunction"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"head\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"head": {
"const": "ScalarQuadraticFunction"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"head": {
"const": "ScalarNonlinearFunction"
},
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"head"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"head\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"head": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"head\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"head": {
"const": "GreaterThan"
},
"lower": {
"type": "number"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"head\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"head": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"head\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"head": {
"const": "Interval"
},
"lower": {
"type": "number"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"head\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"head": {
"const": "Semiinteger"
},
"lower": {
"type": "number"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"head\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"head": {
"const": "Semicontinuous"
},
"lower": {
"type": "number"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"head\": \"ZeroOne\"}"
],
"properties": {
"head": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"head\": \"Integer\"}"
],
"properties": {
"head": {
"const": "Integer"
}
}
}
],
"required": [
"head"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"head\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"head": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"head\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"head": {
"const": "VectorAffineFunction"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"head": {
"const": "VectorQuadraticFunction"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"head"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"head\": \"ExponentialCone\"}"
],
"properties": {
"head": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"head\": \"DualExponentialCone\"}"
],
"properties": {
"head": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"head\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"head": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"head\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"head": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"head\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"head\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"head\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"head\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"head\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"head\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"head\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"head": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"head\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "RootDetConeTriangle"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"head\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "RootDetConeSquare"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"head\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "LogDetConeTriangle"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"head\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "LogDetConeSquare"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"head\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "PositiveSemidefiniteConeTriangle"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"head\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"head": {
"const": "PositiveSemidefiniteConeSquare"
},
"side_dimension": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"head\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"head": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"head\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"head": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"head\": \"IndicatorSet\", \"set\": {\"head\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"head": {
"const": "IndicatorSet"
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"head\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"head": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"head\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"head": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
}
],
"required": [
"head"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 0
},
"minor": {
"const": 4
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | 065e5b131e4707a6e00f39b1347bb6aed5d6178f | 2022-07-19T22:30:34 | schemas/mof.1.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.1.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/scalar_functions"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"function": {
"$ref": "#/definitions/vector_functions"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"const": 1
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
jump-dev/MathOptFormat | b43eab66ca9cf9bff2f49b530cec3f2fd7d54e43 | 2023-09-27T00:53:50 | schemas/mof.1.schema.json | 18 | 2024-05-29T10:55:02.525813Z | {
"$id": "https://jump.dev/MathOptFormat/schemas/mof.1.5.schema.json",
"$schema": "https://json-schema.org/schema#",
"definitions": {
"NonlinearTerm": {
"description": "A node in an expresion graph representing a nonlinear function.",
"oneOf": [
{
"description": "Unary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"log",
"log10",
"exp",
"sqrt",
"floor",
"ceil",
"abs",
"cos",
"sin",
"tan",
"acos",
"asin",
"atan",
"cosh",
"sinh",
"tanh",
"acosh",
"asinh",
"atanh"
]
}
},
"required": [
"args"
]
},
{
"description": "Binary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"/",
"^"
]
}
},
"required": [
"args"
]
},
{
"description": "N-ary operators",
"properties": {
"args": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"+",
"-",
"*",
"min",
"max"
]
}
},
"required": [
"args"
]
},
{
"description": "A real-valued numeric constant",
"examples": [
"{\"type\": \"real\", \"value\": 1.0}"
],
"properties": {
"type": {
"const": "real"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "A complex-valued numeric constant",
"examples": [
"{\"type\": \"complex\", \"real\": 1.0, \"imag\": 2.0}"
],
"properties": {
"imag": {
"type": "number"
},
"real": {
"type": "number"
},
"type": {
"const": "complex"
}
},
"required": [
"real",
"imag"
]
},
{
"description": "A reference to an optimization variable",
"examples": [
"{\"type\": \"variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "variable"
}
},
"required": [
"name"
]
},
{
"description": "A pointer to a (1-indexed) element in the `node_list` field in a nonlinear function",
"examples": [
"{\"type\": \"node\", \"index\": 2}"
],
"properties": {
"index": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "node"
}
},
"required": [
"index"
]
}
],
"required": [
"type"
],
"type": "object"
},
"ScalarAffineTerm": {
"description": "A helper object that represents `coefficent * variable`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable": {
"type": "string"
}
},
"required": [
"coefficient",
"variable"
],
"type": "object"
},
"ScalarQuadraticTerm": {
"description": "A helper object that represents `coefficent * variable_1 * variable_2`.",
"properties": {
"coefficient": {
"type": "number"
},
"variable_1": {
"type": "string"
},
"variable_2": {
"type": "string"
}
},
"required": [
"coefficient",
"variable_1",
"variable_2"
],
"type": "object"
},
"VectorAffineTerm": {
"description": "A helper object that represents a `ScalarAffineTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarAffineTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"VectorQuadraticTerm": {
"description": "A helper object that represents a `ScalarQuadraticTerm` in row `output_index`.",
"properties": {
"output_index": {
"minimum": 1,
"type": "integer"
},
"scalar_term": {
"$ref": "#/definitions/ScalarQuadraticTerm"
}
},
"required": [
"output_index",
"scalar_term"
],
"type": "object"
},
"scalar_functions": {
"description": "A schema for the scalar-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "The scalar variable `x`.",
"examples": [
"{\"type\": \"Variable\", \"name\": \"x\"}"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "Variable"
}
},
"required": [
"name"
]
},
{
"description": "The function `a'x + b`, where `a` is a sparse vector specified by a list of `ScalarAffineTerm`s in `terms` and `b` is the scalar in `constant`. Duplicate variables in `terms` are accepted, and the corresponding coefficients are summed together.",
"examples": [
"{\"type\": \"ScalarAffineFunction\", \"constant\": 1.0, \"terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}]}"
],
"properties": {
"constant": {
"type": "number"
},
"terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"type": {
"const": "ScalarAffineFunction"
}
},
"required": [
"constant",
"terms"
]
},
{
"description": "The function `0.5x'Qx + a'x + b`, where `a` is a sparse vector of `ScalarAffineTerm`s in `affine_terms`, `b` is the scalar `constant`, and `Q` is a symmetric matrix specified by a list of `ScalarQuadraticTerm`s in `quadratic_terms`. Duplicate indices in `affine_terms` and `quadratic` are accepted, and the corresponding coefficients are summed together. Mirrored indices in `quadratic_terms` (i.e., `(i,j)` and `(j, i)`) are considered duplicates; only one need to be specified.",
"examples": [
"{\"type\": \"ScalarQuadraticFunction\", \"constant\": 1.0, \"affine_terms\": [{\"coefficient\": 2.5, \"variable\": \"x\"}], \"quadratic_terms\": [{\"coefficient\": 2.0, \"variable_1\": \"x\", \"variable_2\": \"y\"}]}"
],
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/ScalarAffineTerm"
},
"type": "array"
},
"constant": {
"type": "number"
},
"quadratic_terms": {
"items": {
"$ref": "#/definitions/ScalarQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "ScalarQuadraticFunction"
}
},
"required": [
"constant",
"affine_terms",
"quadratic_terms"
]
},
{
"description": "An expression graph representing a scalar nonlinear function.",
"properties": {
"node_list": {
"items": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": "array"
},
"root": {
"$ref": "#/definitions/NonlinearTerm"
},
"type": {
"const": "ScalarNonlinearFunction"
}
},
"required": [
"root",
"node_list"
]
}
],
"required": [
"type"
],
"type": "object"
},
"scalar_sets": {
"description": "A schema for the scalar-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "(-\u221e, upper]",
"examples": [
"{\"type\": \"LessThan\", \"upper\": 2.1}"
],
"properties": {
"type": {
"const": "LessThan"
},
"upper": {
"type": "number"
}
},
"required": [
"upper"
]
},
{
"description": "[lower, \u221e)",
"examples": [
"{\"type\": \"GreaterThan\", \"lower\": 2.1}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "GreaterThan"
}
},
"required": [
"lower"
]
},
{
"description": "{value}",
"examples": [
"{\"type\": \"EqualTo\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "EqualTo"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
{
"description": "[lower, upper]",
"examples": [
"{\"type\": \"Interval\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Interval"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a {lower, lower + 1, ..., upper}",
"examples": [
"{\"type\": \"Semiinteger\", \"lower\": 2, \"upper\": 4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semiinteger"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0} \u222a [lower, upper]",
"examples": [
"{\"type\": \"Semicontinuous\", \"lower\": 2.1, \"upper\": 3.4}"
],
"properties": {
"lower": {
"type": "number"
},
"type": {
"const": "Semicontinuous"
},
"upper": {
"type": "number"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "{0, 1}",
"examples": [
"{\"type\": \"ZeroOne\"}"
],
"properties": {
"type": {
"const": "ZeroOne"
}
}
},
{
"description": "\u2124",
"examples": [
"{\"type\": \"Integer\"}"
],
"properties": {
"type": {
"const": "Integer"
}
}
},
{
"description": "{value}",
"examples": [
"{\"type\": \"Parameter\", \"value\": 2.1}"
],
"properties": {
"type": {
"const": "Parameter"
},
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_functions": {
"description": "A schema for the vector-valued functions defined by MathOptFormat.See http://www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Functions-and-function-modifications-1 for a list of the functions and their meanings.",
"oneOf": [
{
"description": "An ordered list of variables.",
"examples": [
"{\"type\": \"VectorOfVariables\", \"variables\": [\"x\", \"y\"]}"
],
"properties": {
"type": {
"const": "VectorOfVariables"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"variables"
]
},
{
"description": "The function `Ax + b`, where `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `terms` and `b` is a dense vector specified by `constants`.",
"examples": [
"{\"type\": \"VectorAffineFunction\", \"constants\": [1.0], \"terms\": [{\"output_index\": 1, \"scalar_term\": {\"coefficient\": 2.5, \"variable\": \"x\"}}]}"
],
"properties": {
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"type": {
"const": "VectorAffineFunction"
}
},
"required": [
"constants",
"terms"
]
},
{
"description": "The vector-valued quadratic function `q(x) + Ax + b`, where `q(x)` is specified by a list of `VectorQuadraticTerm`s in `quadratic_terms`, `A` is a sparse matrix specified by a list of `VectorAffineTerm`s in `affine_terms` and `b` is a dense vector specified by `constants`.",
"properties": {
"affine_terms": {
"items": {
"$ref": "#/definitions/VectorAffineTerm"
},
"type": "array"
},
"constants": {
"items": {
"type": "number"
},
"type": "array"
},
"quadratc_terms": {
"items": {
"$ref": "#/definitions/VectorQuadraticTerm"
},
"type": "array"
},
"type": {
"const": "VectorQuadraticFunction"
}
},
"required": [
"constants",
"affine_terms",
"quadratic_terms"
]
}
],
"required": [
"type"
],
"type": "object"
},
"vector_sets": {
"description": "A schema for the vector-valued sets defined by MathOptFormat. See http: //www.juliaopt.org/MathOptInterface.jl/v0.8/apireference/#Sets-1 for a list of the sets and their meanings.",
"oneOf": [
{
"description": "[x, y, z] \u2208 {R\u00b3: y * exp(x / y) \u2264 z, y \u2265 0}",
"examples": [
"{\"type\": \"ExponentialCone\"}"
],
"properties": {
"type": {
"const": "ExponentialCone"
}
}
},
{
"description": "[u, v, w] \u2208 {R\u00b3: -u * exp(v / u) \u2264 exp(1) * w, u < 0}",
"examples": [
"{\"type\": \"DualExponentialCone\"}"
],
"properties": {
"type": {
"const": "DualExponentialCone"
}
}
},
{
"description": "A special ordered set of type I.",
"examples": [
"{\"type\": \"SOS1\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS1"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "A special ordered set of type II.",
"examples": [
"{\"type\": \"SOS2\", \"weights\": [1, 3, 2]}"
],
"properties": {
"type": {
"const": "SOS2"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"weights"
]
},
{
"description": "[t, x] \u2208 {R^{dimension}: t \u2264 (\u03a0x\u1d62)^{1 / (dimension-1)}}",
"examples": [
"{\"type\": \"GeometricMeanCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "GeometricMeanCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, x] \u2208 {R^{dimension} : t \u2265 ||x||\u2082",
"examples": [
"{\"type\": \"SecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "SecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "[t, u, x] \u2208 {R^{dimension} : 2tu \u2265 (||x||\u2082)\u00b2; t, u \u2265 0}",
"examples": [
"{\"type\": \"RotatedSecondOrderCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RotatedSecondOrderCone"
}
},
"required": [
"dimension"
]
},
{
"description": "{0}^{dimension}",
"examples": [
"{\"type\": \"Zeros\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Zeros"
}
},
"required": [
"dimension"
]
},
{
"description": "R^{dimension}",
"examples": [
"{\"type\": \"Reals\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Reals"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208b^{dimension}",
"examples": [
"{\"type\": \"Nonpositives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonpositives"
}
},
"required": [
"dimension"
]
},
{
"description": "R\u208a^{dimension}",
"examples": [
"{\"type\": \"Nonnegatives\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Nonnegatives"
}
},
"required": [
"dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d(d+1)/2} : t \u2264 det(X)^{1/d}}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, X] \u2208 R^{1 + d^2} : t \u2264 det(X)^{1/d}, X symmetric}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"RootDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "RootDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d(d+1)/2} : t \u2264 u log(det(X/u)), u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeTriangle`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "{[t, u, X] \u2208 R^{2 + d^2} : t \u2264 u log(det(X/u)), X symmetric, u > 0}, where the matrix `X` is represented in the same symmetric packed format as in the `PositiveSemidefiniteConeSquare`. The argument `side_dimension` is the side dimension of the matrix `X`, i.e., its number of rows or columns.",
"examples": [
"{\"type\": \"LogDetConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "LogDetConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The (vectorized) cone of symmetric positive semidefinite matrices, with `side_dimension` rows and columns. The entries of the upper-right triangular part of the matrix are given column by column (or equivalently, the entries of the lower-left triangular part are given row by row).",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "DEPRECATED: use the Scaled set combinned with PositiveSemidefiniteConeTriangle instead.",
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "ScaledPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The cone of symmetric positive semidefinite matrices, with side length `side_dimension`. The entries of the matrix are given column by column (or equivalently, row by row). The matrix is both constrained to be symmetric and to be positive semidefinite. That is, if the functions in entries `(i, j)` and `(j, i)` are different, then a constraint will be added to make sure that the entries are equal.",
"examples": [
"{\"type\": \"PositiveSemidefiniteConeSquare\", \"side_dimension\": 2}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "PositiveSemidefiniteConeSquare"
}
},
"required": [
"side_dimension"
]
},
{
"description": "[x, y, z] \u2208 {R\u00b3: x^{exponent} y^{1-exponent} \u2265 |z|; x, y \u2265 0}",
"examples": [
"{\"type\": \"PowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "PowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "[u, v, w] \u2208 {R\u00b3: (u / exponent)^{exponent} (v / (1-exponent))^{1-exponent} \u2265 |w|; u, v \u2265 0}",
"examples": [
"{\"type\": \"DualPowerCone\", \"exponent\": 2.0}"
],
"properties": {
"exponent": {
"type": "number"
},
"type": {
"const": "DualPowerCone"
}
},
"required": [
"exponent"
]
},
{
"description": "If `activate_on=one`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 0 \u27f9 x \u2208 S, otherwise when `activate_on=zero`: (y, x) \u2208 {0,1}\u00d7R\u1d3a: y = 1 \u27f9 x \u2208 S.",
"examples": [
"{\"type\": \"Indicator\", \"set\": {\"type\": \"LessThan\", \"upper\": 2.0}, \"activate_on\": \"one\"}"
],
"properties": {
"activate_on": {
"enum": [
"one",
"zero"
]
},
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Indicator"
}
},
"required": [
"set",
"activate_on"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 \u03a3\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormOneCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormOneCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, x) \u2208 {R^{dimension}: t \u2265 max\u1d62|x\u1d62|}",
"examples": [
"{\"type\": \"NormInfinityCone\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "NormInfinityCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(u, v, w) \u2208 {R^{dimension}: u \u2265 \u03a3\u1d62 w\u1d62log(w\u1d62/v\u1d62), v\u1d62 \u2265 0, w\u1d62 \u2265 0}",
"examples": [
"{\"type\": \"RelativeEntropyCone\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 3,
"type": "integer"
},
"type": {
"const": "RelativeEntropyCone"
}
},
"required": [
"dimension"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03c3\u2081(X)}",
"examples": [
"{\"type\": \"NormSpectralCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormSpectralCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "(t, X) \u2208 {R^{1+row_dim\u00d7column_dim}: t \u2265 \u03a3\u1d62 \u03c3\u1d62(X)}",
"examples": [
"{\"type\": \"NormNuclearCone\", \"row_dim\": 1, \"column_dim\": 2}"
],
"properties": {
"column_dim": {
"minimum": 1,
"type": "integer"
},
"row_dim": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "NormNuclearCone"
}
},
"required": [
"row_dim",
"column_dim"
]
},
{
"description": "The set corresponding to a mixed complementarity constraint. Complementarity constraints should be specified with an AbstractVectorFunction-in-Complements(dimension) constraint. The dimension of the vector-valued function `F` must be `dimension`. This defines a complementarity constraint between the scalar function `F[i]` and the variable in `F[i + dimension/2]`. Thus, `F[i + dimension/2]` must be interpretable as a single variable `x_i` (e.g., `1.0 * x + 0.0`). The mixed complementarity problem consists of finding `x_i` in the interval `[lb, ub]` (i.e., in the set `Interval(lb, ub)`), such that the following holds: 1. `F_i(x) == 0` if `lb_i < x_i < ub_i`; 2. `F_i(x) >= 0` if `lb_i == x_i`; 3. `F_i(x) <= 0` if `x_i == ub_i`. Classically, the bounding set for `x_i` is `Interval(0, Inf)`, which recovers: `0 <= F_i(x) \u27c2 x_i >= 0`, where the `\u27c2` operator implies `F_i(x) * x_i = 0`.",
"examples": [
"{\"type\": \"Complements\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 2,
"type": "integer"
},
"type": {
"const": "Complements"
}
},
"required": [
"dimension"
]
},
{
"description": "The set {x in Z^d} such that no two elements in x take the same value and dimension=d.",
"examples": [
"{\"type\": \"AllDifferent\", \"dimension\": 2}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "AllDifferent"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^d}` where `d = length(w)`, such that each item `i` in `1:d` of weight `w[i]` is put into bin `x[i]`, and the total weight of each bin does not exceed `c`.",
"examples": [
"{\"type\": \"BinPacking\", \"capacity\": 3.0, \"weights\": [1.0, 2.0, 3.0]}"
],
"properties": {
"capacity": {
"type": "number"
},
"type": {
"const": "BinPacking"
},
"weights": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"capacity",
"weights"
]
},
{
"description": "The set `{x in {1..d}^d}` that constraints `x` to be a circuit, such that `x_i = j` means that `j` is the successor of `i`, and `dimension = d`.",
"examples": [
"{\"type\": \"Circuit\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Circuit"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{x in Z^{d_1 + d_2 + ldots d_N}}`, where `x` is partitioned into `N` subsets (`{x_1, ldots, x_{d_1}}`, `{x_{d_1 + 1}, ldots, x_{d_1 + d_2}}` and so on), and at least `n` elements of each subset take one of the values in `set`.",
"examples": [
"{\"type\": \"CountAtLeast\", \"n\": 1, \"partitions\": [2, 2], \"set\": [3]}"
],
"properties": {
"n": {
"minimum": 0,
"type": "integer"
},
"partitions": {
"items": {
"type": "integer"
},
"type": "array"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountAtLeast"
}
},
"required": [
"n",
"partitions",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that `n` elements of the vector `x` take on of the values in `set` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountBelongs\", \"dimension\": 3, \"set\": [3, 4, 5]}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"set": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "CountBelongs"
}
},
"required": [
"dimension",
"set"
]
},
{
"description": "The set `{(n, x) in Z^{1+d}}`, such that the number of distinct values in `x` is `n` and `dimension = 1 + d`.",
"examples": [
"{\"type\": \"CountDistinct\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountDistinct"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(c, y, x) in Z^{1+1+d}}`, such that `c` is strictly greater than the number of occurances of `y` in `x` and `dimension = 1 + 1 + d`.",
"examples": [
"{\"type\": \"CountGreaterThan\", \"dimension\": 3}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "CountGreaterThan"
}
},
"required": [
"dimension"
]
},
{
"description": "The set `{(s, d, r, b) in Z^{3n+1}}`, representing the `cumulative` global constraint, where `n == length(s) == length(r) == length(b)` and `dimension = 3n + 1`. `Cumulative` requires that a set of tasks given by start times `s`, durations `d`, and resource requirements `r`, never requires more than the global resource bound `b` at any one time.",
"examples": [
"{\"type\": \"Cumulative\", \"dimension\": 10}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "Cumulative"
}
},
"required": [
"dimension"
]
},
{
"description": "Given a graph comprised of a set of nodes `1..N` and a set of arcs `1..E` represented by an edge from node `from[i]` to node `to[i]`, `Path` constrains the set `(s, t, ns, es) in (1..N)times(1..E)times{0,1}^Ntimes{0,1}^E`, to form subgraph that is a path from node `s` to node `t`, where node `n` is in the path if `ns[n]` is `1`, and edge `e` is in the path if `es[e]` is `1`. The path must be acyclic, and it must traverse all nodes `n` for which `ns[n]` is `1`, and all edges `e` for which `es[e]` is `1`.",
"examples": [
"{\"type\": \"Path\", \"from\": [1, 1, 2, 2, 3], \"to\": [2, 3, 3, 4, 4]}"
],
"properties": {
"from": {
"items": {
"type": "integer"
},
"type": "array"
},
"to": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": {
"const": "Path"
}
},
"required": [
"from",
"to"
]
},
{
"description": "The set `{x in R^d}` where `d = size(table, 2)`, such that `x` belongs to one row of `table`. That is, there exists some `j` in `1:size(table, 1)`, such that `x[i] = table[j, i]` for all `i=1:size(table, 2)`.",
"examples": [
"{\"type\": \"Table\", \"table\": [[1, 1, 0], [0, 1, 1]]}"
],
"properties": {
"table": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"type": "array"
},
"type": {
"const": "Table"
}
},
"required": [
"table"
]
},
{
"description": "(z, f(x)) \u2208 {R^{dimension}: z iff f(x) \u2208 S}",
"examples": [
"{\"type\": \"Reified\", \"set\": {\"type\": \"GreaterThan\", \"lower\": 0}}"
],
"properties": {
"set": {
"oneOf": [
{
"$ref": "#/definitions/scalar_sets"
},
{
"$ref": "#/definitions/vector_sets"
}
]
},
"type": {
"const": "Reified"
}
},
"required": [
"set"
]
},
{
"description": "x \u2208 {R^d: x_i \u2208 [lower_i, upper_i]}",
"examples": [
"{\"type\": \"HyperRectangle\", \"lower\": [0, 0], \"upper\": [1, 1]}"
],
"properties": {
"lower": {
"items": {
"type": "number"
},
"type": "array"
},
"type": {
"const": "HyperRectangle"
},
"upper": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"lower",
"upper"
]
},
{
"description": "The (vectorized) cone of Hermitian positive semidefinite matrices, with non-negative side_dimension rows and columns.",
"examples": [
"{\"type\": \"HermitianPositiveSemidefiniteConeTriangle\", \"side_dimension\": 3}"
],
"properties": {
"side_dimension": {
"minimum": 1,
"type": "integer"
},
"type": {
"const": "HermitianPositiveSemidefiniteConeTriangle"
}
},
"required": [
"side_dimension"
]
},
{
"description": "The p-norm cone (t, x) \u2208 {R^d : t \u2265 (\u03a3\u1d62|x\u1d62|^p)^(1/p)}.",
"examples": [
"{\"type\": \"NormCone\", \"dimension\": 3, \"p\": 1.5}"
],
"properties": {
"dimension": {
"minimum": 1,
"type": "integer"
},
"p": {
"type": "number"
},
"type": {
"const": "NormCone"
}
},
"required": [
"dimension",
"p"
]
},
{
"description": "The set in the `set` field, scaled such that the inner product of two elements in the set is the same as the dot product of the two vector functions. This is most useful for solvers which require PSD matrices in _scaled_ form.",
"examples": [
"{\"type\": \"Scaled\", \"set\": {\"type\": \"PositiveSemidefiniteConeTriangle\", \"side_dimension\": 2}}"
],
"properties": {
"set": {
"$ref": "#/definitions/vector_sets"
},
"type": {
"const": "Scaled"
}
},
"required": [
"set"
]
}
],
"required": [
"type"
],
"type": "object"
}
},
"properties": {
"author": {
"description": "The author of the model for citation purposes.",
"type": "string"
},
"constraints": {
"description": "An array of constraints in the model. Scalar-valued functions can only be paired with scalar-sets, and the same applies for vector-valued functions and sets.",
"items": {
"oneOf": [
{
"description": "A scalar-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial scalar value for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"function": {
"$ref": "#/definitions/scalar_functions"
},
"primal_start": {
"description": "An initial scalar value for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
},
"set": {
"$ref": "#/definitions/scalar_sets"
}
}
},
{
"description": "A vector-valued constraint.",
"properties": {
"dual_start": {
"description": "An initial vector for the constraint's dual solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"function": {
"$ref": "#/definitions/vector_functions"
},
"primal_start": {
"description": "An initial vector for the constraint's primal solution that the optimizer may use to warm-start the solution process.",
"items": {
"type": "number"
},
"type": "array"
},
"set": {
"$ref": "#/definitions/vector_sets"
}
}
}
],
"properties": {
"name": {
"type": "string"
}
},
"required": [
"function",
"set"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A human-readable description of the model.",
"type": "string"
},
"name": {
"description": "The name of the model.",
"type": "string"
},
"objective": {
"description": "The objective of the model.",
"oneOf": [
{
"properties": {
"function": {
"oneOf": [
{
"$ref": "#/definitions/scalar_functions"
},
{
"$ref": "#/definitions/vector_functions"
}
]
},
"sense": {
"enum": [
"min",
"max"
]
}
}
},
{
"properties": {
"sense": {
"const": "feasibility"
}
}
}
],
"required": [
"sense"
],
"type": "object"
},
"variables": {
"description": "An array of variables in the model. Each must have a unique name.",
"items": {
"properties": {
"name": {
"type": "string"
},
"primal_start": {
"description": "An initial value for the variable's primal solution that the optimizer may use to warm-start the solution process.",
"type": "number"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"version": {
"description": "The version of MathOptFormat that this schema validates against.",
"properties": {
"major": {
"const": 1
},
"minor": {
"enum": [
0,
1,
2,
3,
4,
5
]
}
},
"required": [
"minor",
"major"
],
"type": "object"
}
},
"required": [
"version",
"variables",
"objective",
"constraints"
],
"title": "The schema for MathOptFormat",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | 534e468646b2698776f69621d7fc526899e8ace1 | 2023-07-27T19:18:18 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$defs": {
"additionalAnnotations": {
"additionalProperties": true,
"description": "",
"type": "object"
},
"additionalControllerArgs": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"additionalControllerSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"args": false,
"image": false,
"name": false
},
"type": "object"
},
"additionalLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalServiceSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"ports": false,
"selector": false
},
"type": "object"
},
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"additionalTemplateLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalTemplateSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"common": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
}
},
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the frontend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"replicas": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"replicas",
"port"
],
"type": "object"
},
"image": {
"description": "",
"type": "string"
},
"postgresql": {
"description": "",
"oneOf": [
{
"properties": {
"connect_timeout": {
"description": "",
"type": "number"
},
"dbname": {
"description": "",
"type": "string"
},
"host": {
"description": "",
"type": "string"
},
"password": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"sslcert": {
"description": "",
"type": "string"
},
"sslkey": {
"description": "",
"type": "string"
},
"sslmode": {
"description": "",
"enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
"sslrootcert": {
"description": "",
"type": "string"
},
"user": {
"description": "",
"type": "string"
}
},
"required": [
"user",
"password",
"dbname",
"host"
]
},
{
"additionalProperties": {
"from_file": {
"description": "",
"type": "string"
}
},
"required": [
"from_file"
]
}
],
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalSpec": {
"#ref": "#/$defs/additionalServiceSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"port"
],
"type": "object"
}
},
"required": [
"frontend",
"backend",
"image",
"service"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | 77ec420e4469772d441aaf854995ce38960a6034 | 2023-01-24T19:53:38 | charts/server/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"image": {
"description": "The Juice container image to use",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "",
"properties": {
"name": false
},
"type": "object"
},
"name": {
"description": "The metadata name of the POD",
"type": "string"
},
"serverContainer": {
"additionalProperties": true,
"description": "",
"properties": {
"image": false
},
"type": "object"
},
"spec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"required": [
"name",
"image"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | 3d06e0b154dd1cc4ef3a1e3068032c6c5a4a4dca | 2023-03-27T21:05:28 | charts/server/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"image": {
"description": "The Juice container image to use",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"description": "",
"properties": {
"name": false
},
"type": "object"
},
"name": {
"description": "The metadata name of the POD",
"type": "string"
},
"pod": {
"description": "",
"type": "boolean"
},
"serverContainer": {
"additionalProperties": true,
"description": "",
"properties": {
"image": false
},
"type": "object"
},
"spec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"required": [
"name",
"image"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | ef42c3027402686bb660a268a9ec1d440987a91e | 2023-07-27T17:01:21 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$defs": {
"additionalControllerArgs": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"additionalControllerSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"args": false,
"image": false,
"name": false
},
"type": "object"
},
"additionalLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalServiceSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"ports": false,
"selector": false
},
"type": "object"
},
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"additionalTemplateLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalTemplateSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"common": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
}
},
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the frontend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"replicas": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"replicas",
"port"
],
"type": "object"
},
"image": {
"description": "",
"type": "string"
},
"postgresql": {
"description": "",
"oneOf": [
{
"properties": {
"connect_timeout": {
"description": "",
"type": "number"
},
"dbname": {
"description": "",
"type": "string"
},
"host": {
"description": "",
"type": "string"
},
"password": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"sslcert": {
"description": "",
"type": "string"
},
"sslkey": {
"description": "",
"type": "string"
},
"sslmode": {
"description": "",
"enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
"sslrootcert": {
"description": "",
"type": "string"
},
"user": {
"description": "",
"type": "string"
}
},
"required": [
"user",
"password",
"dbname",
"host"
]
},
{
"additionalProperties": {
"from_file": {
"description": "",
"type": "string"
}
},
"required": [
"from_file"
]
}
],
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"#ref": "#/$defs/additionalServiceSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"port"
],
"type": "object"
}
},
"required": [
"frontend",
"backend",
"image",
"service"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | b212c250c9662e628ba05fb938d37e787bc324e9 | 2023-07-23T00:04:55 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
},
"spec": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"template": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
},
"controller": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"image": false,
"name": false
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"name": {
"description": "The metadata name for the frontend deployment",
"type": "string"
},
"replicas": {
"description": "",
"type": "number"
},
"spec": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"selector": false
},
"type": "object"
},
"template": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
},
"controller": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"image": false,
"name": false
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"name",
"replicas"
],
"type": "object"
},
"image": {
"description": "The container image to use",
"type": "string"
}
},
"required": [
"frontend",
"backend",
"image"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | e2b01c053be8fc92ace115d419fedf2a9028d2b2 | 2023-07-28T00:25:03 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$defs": {
"additionalAnnotations": {
"additionalProperties": true,
"description": "",
"type": "object"
},
"additionalControllerArgs": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"additionalControllerSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"args": false,
"image": false,
"name": false
},
"type": "object"
},
"additionalLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalServiceSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"ports": false,
"selector": false
},
"type": "object"
},
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"additionalTemplateLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalTemplateSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"common": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
}
},
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "The metadata name for the frontend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"replicas": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"replicas",
"port"
],
"type": "object"
},
"image": {
"description": "",
"type": "string"
},
"postgresql": {
"description": "",
"oneOf": [
{
"properties": {
"connect_timeout": {
"description": "",
"type": "number"
},
"dbname": {
"description": "",
"type": "string"
},
"host": {
"description": "",
"type": "string"
},
"password": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"sslcert": {
"description": "",
"type": "string"
},
"sslkey": {
"description": "",
"type": "string"
},
"sslmode": {
"description": "",
"enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
"sslrootcert": {
"description": "",
"type": "string"
},
"user": {
"description": "",
"type": "string"
}
},
"required": [
"user",
"password",
"dbname",
"host"
]
},
{
"additionalProperties": {
"from_file": {
"description": "",
"type": "string"
}
},
"required": [
"from_file"
]
}
],
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "",
"properties": {
"port": {
"description": "",
"type": "number"
}
},
"required": [
"port"
],
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalSpec": {
"#ref": "#/$defs/additionalServiceSpec"
},
"name": {
"description": "The metadata name for the backend deployment",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"port"
],
"type": "object"
}
},
"required": [
"frontend",
"backend",
"image",
"service"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | 927b4d0e00b845c670492e371bdc2e5ba610d2d3 | 2023-07-28T16:13:19 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$defs": {
"additionalAnnotations": {
"additionalProperties": true,
"description": "",
"type": "object"
},
"additionalControllerArgs": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"additionalControllerSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"args": false,
"image": false,
"name": false
},
"type": "object"
},
"additionalLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalServiceSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"ports": false,
"selector": false
},
"type": "object"
},
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"additionalTemplateLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalTemplateSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"common": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
}
},
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
},
"replicas": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"replicas"
],
"type": "object"
},
"image": {
"description": "",
"type": "string"
},
"postgresql": {
"description": "",
"oneOf": [
{
"properties": {
"connect_timeout": {
"description": "",
"type": "number"
},
"dbname": {
"description": "",
"type": "string"
},
"host": {
"description": "",
"type": "string"
},
"password": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"sslcert": {
"description": "",
"type": "string"
},
"sslkey": {
"description": "",
"type": "string"
},
"sslmode": {
"description": "",
"enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
"sslrootcert": {
"description": "",
"type": "string"
},
"user": {
"description": "",
"type": "string"
}
},
"required": [
"user",
"password",
"dbname",
"host"
]
},
{
"additionalProperties": {
"from_file": {
"description": "",
"type": "string"
}
},
"required": [
"from_file"
]
}
],
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"port"
],
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalSpec": {
"#ref": "#/$defs/additionalServiceSpec"
},
"namePrefix": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"namePrefix",
"port"
],
"type": "object"
}
},
"required": [
"frontend",
"backend",
"image",
"service"
],
"title": "Values",
"type": "object"
} | MIT | en |
Juice-Labs/Juice-Labs | 313129040b10a2c188d4327e8cc93661fc686469 | 2023-07-28T19:20:54 | charts/controller/values.schema.json | 397 | 2024-05-27T06:44:03.467313Z | {
"$defs": {
"additionalAnnotations": {
"additionalProperties": true,
"description": "",
"type": "object"
},
"additionalControllerArgs": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"additionalControllerSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"args": false,
"image": false,
"name": false
},
"type": "object"
},
"additionalLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalServiceSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"ports": false,
"selector": false
},
"type": "object"
},
"additionalSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"replicas": false,
"selector": false
},
"type": "object"
},
"additionalTemplateAnnotations": {
"additionalProperties": true,
"description": "",
"type": "object"
},
"additionalTemplateLabels": {
"additionalProperties": true,
"description": "",
"properties": {
"app.juicelabs.co/controller": false
},
"type": "object"
},
"additionalTemplateSpec": {
"additionalProperties": true,
"description": "",
"properties": {
"containers": false
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"additionalProperties": false,
"properties": {
"backend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateAnnotations": {
"#ref": "#/$defs/additionalTemplateAnnotations"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"common": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateAnnotations": {
"#ref": "#/$defs/additionalTemplateAnnotations"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
}
},
"type": "object"
},
"frontend": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateAnnotations": {
"#ref": "#/$defs/additionalTemplateAnnotations"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
},
"replicas": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"replicas"
],
"type": "object"
},
"image": {
"description": "",
"type": "string"
},
"postgresql": {
"description": "",
"oneOf": [
{
"properties": {
"connect_timeout": {
"description": "",
"type": "number"
},
"dbname": {
"description": "",
"type": "string"
},
"host": {
"description": "",
"type": "string"
},
"password": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
},
"sslcert": {
"description": "",
"type": "string"
},
"sslkey": {
"description": "",
"type": "string"
},
"sslmode": {
"description": "",
"enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
"sslrootcert": {
"description": "",
"type": "string"
},
"user": {
"description": "",
"type": "string"
}
},
"required": [
"user",
"password",
"dbname",
"host"
]
},
{
"additionalProperties": {
"from_file": {
"description": "",
"type": "string"
}
},
"required": [
"from_file"
]
}
],
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalControllerArgs": {
"#ref": "#/$defs/additionalControllerArgs"
},
"additionalControllerSpec": {
"#ref": "#/$defs/additionalControllerSpec"
},
"additionalLabels": {
"#ref": "#/$defs/additionalSpec"
},
"additionalSpec": {
"#ref": "#/$defs/additionalSpec"
},
"additionalTemplateAnnotations": {
"#ref": "#/$defs/additionalTemplateAnnotations"
},
"additionalTemplateLabels": {
"#ref": "#/$defs/additionalTemplateLabels"
},
"additionalTemplateSpec": {
"#ref": "#/$defs/additionalTemplateSpec"
},
"name": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"name",
"port"
],
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "",
"properties": {
"additionalAnnotations": {
"#ref": "#/$defs/additionalAnnotations"
},
"additionalSpec": {
"#ref": "#/$defs/additionalServiceSpec"
},
"namePrefix": {
"description": "",
"type": "string"
},
"port": {
"description": "",
"type": "number"
}
},
"required": [
"namePrefix",
"port"
],
"type": "object"
}
},
"required": [
"frontend",
"backend",
"image",
"service"
],
"title": "Values",
"type": "object"
} | MIT | en |
rafaribe/home-ops | cd3829fbe0d35deb4638f48e887017b8641f90d9 | 2024-04-07T09:31:00 | infrastructure/talos/clusterconfig/talconfig.json | 35 | 2024-05-27T09:34:15.619728Z | {
"$defs": {
"Bond": {
"additionalProperties": false,
"properties": {
"adActorSysPrio": {
"type": "integer"
},
"adActorSystem": {
"type": "string"
},
"adSelect": {
"type": "string"
},
"adUserPortKey": {
"type": "integer"
},
"allSlavesActive": {
"type": "integer"
},
"arpAllTargets": {
"type": "string"
},
"arpIPTarget": {
"items": {
"type": "string"
},
"type": "array"
},
"arpInterval": {
"type": "integer"
},
"arpValidate": {
"type": "string"
},
"deviceSelectors": {
"items": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"type": "array"
},
"downdelay": {
"type": "integer"
},
"failOverMac": {
"type": "string"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"lacpRate": {
"type": "string"
},
"lpInterval": {
"type": "integer"
},
"miimon": {
"type": "integer"
},
"minLinks": {
"type": "integer"
},
"mode": {
"type": "string"
},
"numPeerNotif": {
"type": "integer"
},
"packetsPerSlave": {
"type": "integer"
},
"peerNotifyDelay": {
"type": "integer"
},
"primary": {
"type": "string"
},
"primaryReselect": {
"type": "string"
},
"resendIgmp": {
"type": "integer"
},
"tlbDynamicLb": {
"type": "integer"
},
"updelay": {
"type": "integer"
},
"useCarrier": {
"type": "boolean"
},
"xmitHashPolicy": {
"type": "string"
}
},
"type": "object"
},
"Bridge": {
"additionalProperties": false,
"properties": {
"interfaces": {
"items": {
"type": "string"
},
"type": "array"
},
"stp": {
"$ref": "#/$defs/STP"
}
},
"type": "object"
},
"CNIConfig": {
"additionalProperties": false,
"properties": {
"flannel": {
"$ref": "#/$defs/FlannelCNIConfig"
},
"name": {
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Customization": {
"additionalProperties": false,
"properties": {
"extraKernelArgs": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"items": {
"$ref": "#/$defs/MetaValue"
},
"type": "array"
},
"systemExtensions": {
"$ref": "#/$defs/SystemExtensions"
}
},
"type": "object"
},
"DHCPOptions": {
"additionalProperties": false,
"properties": {
"duidv6": {
"type": "string"
},
"ipv4": {
"type": "boolean"
},
"ipv6": {
"type": "boolean"
},
"routeMetric": {
"type": "integer"
}
},
"type": "object"
},
"Device": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"bond": {
"$ref": "#/$defs/Bond"
},
"bridge": {
"$ref": "#/$defs/Bridge"
},
"cidr": {
"type": "string"
},
"deviceSelector": {
"$ref": "#/$defs/NetworkDeviceSelector"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"dummy": {
"type": "boolean"
},
"ignore": {
"type": "boolean"
},
"interface": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlans": {
"$ref": "#/$defs/VlanList"
},
"wireguard": {
"$ref": "#/$defs/DeviceWireguardConfig"
}
},
"type": "object"
},
"DeviceVIPConfig": {
"additionalProperties": false,
"properties": {
"equinixMetal": {
"$ref": "#/$defs/VIPEquinixMetalConfig"
},
"hcloud": {
"$ref": "#/$defs/VIPHCloudConfig"
},
"ip": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardConfig": {
"additionalProperties": false,
"properties": {
"firewallMark": {
"type": "integer"
},
"listenPort": {
"type": "integer"
},
"peers": {
"items": {
"$ref": "#/$defs/DeviceWireguardPeer"
},
"type": "array"
},
"privateKey": {
"type": "string"
}
},
"type": "object"
},
"DeviceWireguardPeer": {
"additionalProperties": false,
"properties": {
"allowedIPs": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"persistentKeepaliveInterval": {
"type": "integer"
},
"publicKey": {
"type": "string"
}
},
"type": "object"
},
"DiskPartition": {
"additionalProperties": false,
"properties": {
"mountpoint": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"FlannelCNIConfig": {
"additionalProperties": false,
"properties": {
"extraArgs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFactory": {
"additionalProperties": false,
"properties": {
"ISOURLTmpl": {
"default": "{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}.iso{{end}}",
"description": "Template for ISO image URL",
"type": "string"
},
"installerURLTmpl": {
"default": "{{.RegistryURL}}/installer{{if .Secureboot}}-secureboot{{end}}/{{.ID}}:{{.Version}}",
"description": "Template for installer image URL",
"type": "string"
},
"protocol": {
"default": "https",
"description": "Protocol of the registry(https or http)",
"type": "string"
},
"registryURL": {
"default": "factory.talos.dev",
"description": "Registry url or the image",
"type": "string"
},
"schematicEndpoint": {
"default": "/schematics",
"type": "string"
}
},
"type": "object"
},
"IngressConfigWrapper": {
"additionalProperties": false,
"properties": {
"except": {
"description": "Source subnet to exclude from the subnet",
"type": "string"
},
"subnet": {
"description": "Source subnet",
"type": "string"
}
},
"type": "object"
},
"IngressFirewallWrapper": {
"additionalProperties": false,
"properties": {
"defaultAction": {
"default": "block",
"description": "Default action for all not explicitly configured traffic",
"type": "string"
},
"rules": {
"description": "List of matching network rules to allow or block against the defaultAction",
"items": {
"$ref": "#/$defs/NetworkRuleWrapper"
},
"type": "array"
}
},
"type": "object"
},
"InstallDiskSelectorWrapper": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"modalias": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"serial": {
"type": "string"
},
"size": {
"description": "Disk size",
"examples": [
"4GB"
],
"type": "string"
},
"type": {
"examples": [
"ssd"
],
"type": "string"
},
"uuid": {
"type": "string"
},
"wwid": {
"type": "string"
}
},
"type": "object"
},
"KernelModuleConfig": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MachineDisk": {
"additionalProperties": false,
"properties": {
"device": {
"type": "string"
},
"partitions": {
"items": {
"$ref": "#/$defs/DiskPartition"
},
"type": "array"
}
},
"type": "object"
},
"MachineFile": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
}
},
"type": "object"
},
"MachineSpec": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Machine architecture (e.g: amd64",
"type": "string"
},
"mode": {
"default": "metal",
"description": "Machine mode (e.g: metal)",
"type": "string"
},
"secureboot": {
"default": false,
"description": "Whether to enable Secure Boot",
"type": "boolean"
},
"useUKI": {
"default": false,
"description": "Whether to use UKI if Secure Boot is enabled",
"type": "boolean"
}
},
"type": "object"
},
"MetaValue": {
"additionalProperties": false,
"properties": {
"key": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"NetworkDeviceSelector": {
"additionalProperties": false,
"properties": {
"busPath": {
"type": "string"
},
"driver": {
"type": "string"
},
"hardwareAddr": {
"type": "string"
},
"pciID": {
"type": "string"
},
"physical": {
"type": "boolean"
}
},
"type": "object"
},
"NetworkRuleWrapper": {
"additionalProperties": false,
"properties": {
"ingress": {
"description": "List of source subnets allowed to access the host ports/protocols",
"items": {
"$ref": "#/$defs/IngressConfigWrapper"
},
"type": "array"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"portSelector": {
"$ref": "#/$defs/PortSelectorWrapper",
"description": "Ports and protocols on the host affected by the rule"
}
},
"type": "object"
},
"Node": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"installDisk"
],
"title": "installDiskSelector"
},
{
"required": [
"installDiskSelector"
],
"title": "installDisk"
}
],
"properties": {
"controlPlane": {
"description": "Whether the node is a controlplane",
"type": "boolean"
},
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"description": "Hostname of the node",
"type": "string"
},
"ignoreHostname": {
"description": "Whether to set \"machine.network.hostname\" to the generated config file",
"type": "boolean"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"installDisk": {
"description": "The disk used for installation",
"type": "string"
},
"installDiskSelector": {
"$ref": "#/$defs/InstallDiskSelectorWrapper",
"description": "Look up disk used for installation"
},
"ipAddress": {
"description": "IP address where the node can be reached",
"examples": [
"192.168.200.11"
],
"type": "string"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"overrideExtraManifests": {
"description": "Whether \"extraManifests\" defined here should override the one defined in node group",
"type": "boolean"
},
"overridePatches": {
"description": "Whether \"patches\" defined here should override the one defined in node group",
"type": "boolean"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"required": [
"hostname",
"ipAddress"
],
"type": "object"
},
"NodeConfigs": {
"additionalProperties": false,
"properties": {
"disableSearchDomain": {
"description": "Whether to disable generating default search domain",
"type": "boolean"
},
"extraManifests": {
"description": "List of manifest files to be added to the node",
"items": {
"type": "string"
},
"type": "array"
},
"ingressFirewall": {
"$ref": "#/$defs/IngressFirewallWrapper",
"description": "Machine firewall specification"
},
"kernelModules": {
"description": "List of additional kernel modules to load inside the node",
"items": {
"$ref": "#/$defs/KernelModuleConfig"
},
"type": "array"
},
"machineDisks": {
"description": "List of additional disks to partition",
"items": {
"$ref": "#/$defs/MachineDisk"
},
"type": "array"
},
"machineFiles": {
"description": "List of files to create inside the node",
"items": {
"$ref": "#/$defs/MachineFile"
},
"type": "array"
},
"machineSpec": {
"$ref": "#/$defs/MachineSpec",
"description": "Machine hardware specification"
},
"nameservers": {
"description": "List of nameservers for the node",
"items": {
"type": "string"
},
"type": "array"
},
"networkInterfaces": {
"description": "List of network interface configuration for the node",
"items": {
"$ref": "#/$defs/Device"
},
"type": "array"
},
"nodeLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to be added to the node",
"type": "object"
},
"nodeTaints": {
"additionalProperties": {
"type": "string"
},
"description": "Node taints for the node. Effect is optional",
"type": "object"
},
"patches": {
"description": "Patches to be applied to the node",
"items": {
"type": "string"
},
"type": "array"
},
"schematic": {
"$ref": "#/$defs/Schematic",
"description": "Talos image customization to be used in the installer image"
},
"talosImageURL": {
"description": "Talos installer image url for the node",
"examples": [
"factory.talos.dev/installer/e9c7ef96884d4fbc8c0a1304ccca4bb0287d766a8b4125997cb9dbe84262144e"
],
"type": "string"
}
},
"type": "object"
},
"PortSelectorWrapper": {
"additionalProperties": false,
"properties": {
"ports": {
"description": "List of ports or port ranges",
"items": true,
"type": "array"
},
"protocol": {
"description": "Protocol (can be tcp or udp)",
"type": "string"
}
},
"type": "object"
},
"Route": {
"additionalProperties": false,
"properties": {
"gateway": {
"type": "string"
},
"metric": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"network": {
"type": "string"
},
"source": {
"type": "string"
}
},
"type": "object"
},
"STP": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"Schematic": {
"additionalProperties": false,
"properties": {
"customization": {
"$ref": "#/$defs/Customization"
}
},
"type": "object"
},
"SystemExtensions": {
"additionalProperties": false,
"properties": {
"officialExtensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TalhelperConfig": {
"additionalProperties": false,
"properties": {
"additionalApiServerCertSans": {
"description": "Extra certificate SANs for the API server's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMachineCertSans": {
"description": "Extra certificate SANs for the machine's certificate",
"items": {
"type": "string"
},
"type": "array"
},
"allowSchedulingOnControlPlanes": {
"description": "Whether to allow running workload on controlplane nodes. It is an alias to \"AllowSchedulingOnMasters\"",
"type": "boolean"
},
"allowSchedulingOnMasters": {
"description": "Whether to allow running workload on controlplane nodes",
"type": "boolean"
},
"clusterName": {
"description": "Name of the cluster",
"type": "string"
},
"clusterPodNets": {
"description": "The pod subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"clusterSvcNets": {
"description": "The service subnet CIDR list",
"items": {
"type": "string"
},
"type": "array"
},
"cniConfig": {
"$ref": "#/$defs/CNIConfig",
"description": "The CNI to be used for the cluster's network"
},
"controlPlane": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all controlplane nodes"
},
"domain": {
"description": "The domain to be used by Kubernetes DNS",
"examples": [
"cluster.local"
],
"type": "string"
},
"endpoint": {
"description": "Cluster's controlplane endpoint",
"examples": [
"https://192.168.200.10:6443"
],
"type": "string"
},
"imageFactory": {
"$ref": "#/$defs/ImageFactory"
},
"kubernetesVersion": {
"description": "Kubernetes version to use",
"examples": [
"v1.27.0"
],
"type": "string"
},
"nodes": {
"description": "List of configurations for Node",
"items": {
"$ref": "#/$defs/Node"
},
"type": "array"
},
"patches": {
"description": "Patches to be applied to all nodes",
"items": {
"type": "string"
},
"type": "array"
},
"talosVersion": {
"description": "Talos version to perform installation",
"examples": [
"v1.5.4"
],
"type": "string"
},
"worker": {
"$ref": "#/$defs/NodeConfigs",
"description": "Configurations targetted for all worker nodes"
}
},
"required": [
"clusterName",
"endpoint",
"nodes"
],
"type": "object"
},
"VIPEquinixMetalConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"VIPHCloudConfig": {
"additionalProperties": false,
"properties": {
"apiToken": {
"type": "string"
}
},
"type": "object"
},
"Vlan": {
"additionalProperties": false,
"properties": {
"addresses": {
"items": {
"type": "string"
},
"type": "array"
},
"cidr": {
"type": "string"
},
"dhcp": {
"type": "boolean"
},
"dhcpOptions": {
"$ref": "#/$defs/DHCPOptions"
},
"mtu": {
"type": "integer"
},
"routes": {
"items": {
"$ref": "#/$defs/Route"
},
"type": "array"
},
"vip": {
"$ref": "#/$defs/DeviceVIPConfig"
},
"vlanId": {
"type": "integer"
}
},
"type": "object"
},
"VlanList": {
"items": {
"$ref": "#/$defs/Vlan"
},
"type": "array"
}
},
"$id": "https://github.com/budimanjojo/talhelper/pkg/config/talhelper-config",
"$ref": "#/$defs/TalhelperConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | en |
megaease/easeprobe | 16750ec688159cf9cfe519283d6dad6eeb7e747b | 2023-07-31T07:34:51 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('' or '-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": "regular",
"description": "the notification interval strategy such as regular",
"enum": [
"regular",
"increment",
"exponent"
],
"title": "Alert Interval Strategy",
"type": "string"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 668a312aa83f87546fb941ad23aefdf02876a10c | 2022-09-27T04:31:48 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"debug": {
"default": false,
"description": "if true the SLA report will be printed to stdout",
"title": "Debug",
"type": "boolean"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 73697eaa8211dbb2c5469412e0d81ad8a0779bde | 2023-09-14T08:55:30 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
},
"websocket": {
"description": "WebSocket Probe Configuration",
"items": {
"$ref": "#/$defs/probe_websocket_WebSocket"
},
"title": "WebSocket Probe",
"type": "array"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('' or '-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": "regular",
"description": "the notification interval strategy such as regular",
"enum": [
"regular",
"increment",
"exponent"
],
"title": "Alert Interval Strategy",
"type": "string"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_websocket_WebSocket": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers for the initial HTTP request",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "proxy to use for the HTTP request",
"title": "Proxy Server",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "WebSocket URL to probe",
"format": "uri",
"title": "WebSocket URL",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | c4e27709607bd8dc4945df273ef274a8ecd569d2 | 2023-05-08T08:00:47 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('' or '-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": 0,
"description": "the notification interval strategy such as regular",
"title": "Alert Interval Strategy",
"type": "integer"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | da3082aff6c932c8df9176ea2833cc2a9788d995 | 2023-04-06T10:41:44 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": 0,
"description": "the notification interval strategy such as regular",
"title": "Alert Interval Strategy",
"type": "integer"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 1b7cf3469fec5c62d09125bdcbffa5abe23107d5 | 2023-12-05T08:04:17 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"additionalProperties": {
"$ref": "#/$defs/probe_ssh_Endpoint"
},
"type": "object"
},
"Labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
},
"websocket": {
"description": "WebSocket Probe Configuration",
"items": {
"$ref": "#/$defs/probe_websocket_WebSocket"
},
"title": "WebSocket Probe",
"type": "array"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('' or '-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": "regular",
"description": "the notification interval strategy such as regular",
"enum": [
"regular",
"increment",
"exponent"
],
"title": "Alert Interval Strategy",
"type": "string"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The data of the client",
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"examples": [
"[\"/\""
],
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"additionalProperties": {
"type": "number"
},
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "HTTP headers to use for HTTP requests",
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"minimum": 0,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_websocket_WebSocket": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "HTTP headers for the initial HTTP request",
"title": "HTTP Headers",
"type": "object"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "proxy to use for the HTTP request",
"title": "Proxy Server",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "WebSocket URL to probe",
"format": "uri",
"title": "WebSocket URL",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 77dd1e600dd5c345dbf12848c250ad30ad406fb8 | 2022-10-19T02:39:56 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"debug": {
"default": false,
"description": "if true the SLA report will be printed to stdout",
"title": "Debug",
"type": "boolean"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | aa3a17061aecc90684710658c3e0ea51f55c4798 | 2022-11-25T08:51:42 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 6c3c65f5295a773661cdea5fc353a0472e04f67c | 2022-09-13T00:36:48 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"debug": {
"default": false,
"description": "if true the SLA report will be printed to stdout",
"title": "Debug",
"type": "boolean"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | 7ec427354bd062ad200501a51250879d7ffe25ce | 2023-08-23T02:34:40 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert settings",
"title": "Alert"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"alert"
],
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('' or '-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_NotificationStrategySettings": {
"additionalProperties": false,
"properties": {
"factor": {
"default": 1,
"description": "the factor to increase the interval",
"title": "Factor",
"type": "integer"
},
"max": {
"default": 1,
"description": "the max times to send notification",
"title": "Max Times",
"type": "integer"
},
"strategy": {
"default": "regular",
"description": "the notification interval strategy such as regular",
"enum": [
"regular",
"increment",
"exponent"
],
"title": "Alert Interval Strategy",
"type": "string"
}
},
"required": [
"strategy",
"factor",
"max"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"alert",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert": {
"$ref": "#/$defs/global_NotificationStrategySettings",
"description": "the alert strategy of probe",
"title": "Probe Alert"
},
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels",
"description": "the labels of probe",
"title": "Probe LabelMap"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"alert",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | eabeaa12ef49281b9e4c7c67979d6a6626ca91fb | 2022-10-20T02:53:47 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
megaease/easeprobe | a070e22c6258d029347b84762cc2b6daab7ec7be | 2022-11-30T02:24:46 | resources/schema.json | 2,033 | 2024-05-27T03:58:48.763581Z | {
"$defs": {
"BastionMapType": {
"patternProperties": {
".*": {
"$ref": "#/$defs/probe_ssh_Endpoint"
}
},
"type": "object"
},
"conf_Conf": {
"additionalProperties": false,
"properties": {
"client": {
"description": "Native Client Probe Configuration",
"items": {
"$ref": "#/$defs/probe_client_Client"
},
"title": "Native Client Probe",
"type": "array"
},
"host": {
"$ref": "#/$defs/probe_host_Host",
"description": "Host Probe Configuration",
"title": "Host Probe"
},
"http": {
"description": "HTTP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_http_HTTP"
},
"title": "HTTP Probe",
"type": "array"
},
"notify": {
"$ref": "#/$defs/notify_Config",
"description": "Notification Configuration",
"title": "Notification"
},
"ping": {
"description": "Ping Probe Configuration",
"items": {
"$ref": "#/$defs/probe_ping_Ping"
},
"title": "Ping Probe",
"type": "array"
},
"settings": {
"$ref": "#/$defs/conf_Settings",
"description": "EaseProbe Global configuration",
"title": "Global Settings"
},
"shell": {
"description": "Shell Probe Configuration",
"items": {
"$ref": "#/$defs/probe_shell_Shell"
},
"title": "Shell Probe",
"type": "array"
},
"ssh": {
"$ref": "#/$defs/probe_ssh_SSH",
"description": "SSH Probe Configuration",
"title": "SSH Probe"
},
"tcp": {
"description": "TCP Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tcp_TCP"
},
"title": "TCP Probe",
"type": "array"
},
"tls": {
"description": "TLS Probe Configuration",
"items": {
"$ref": "#/$defs/probe_tls_TLS"
},
"title": "TLS Probe",
"type": "array"
},
"version": {
"description": "Version of the EaseProbe configuration",
"title": "Version",
"type": "string"
}
},
"type": "object"
},
"conf_HTTPServer": {
"additionalProperties": false,
"properties": {
"ip": {
"description": "the local ip address of the http server need to listen on",
"examples": [
"0.0.0.0"
],
"title": "Web Server IP",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "access log of the http server",
"title": "Access Log"
},
"port": {
"default": 8181,
"description": "port of the http server",
"title": "Web Server Port",
"type": "integer"
},
"refresh": {
"description": "auto refresh time of the http server",
"examples": [
"5s"
],
"title": "Auto Refresh Time",
"type": "string"
}
},
"required": [
"ip",
"port"
],
"type": "object"
},
"conf_Log": {
"additionalProperties": false,
"properties": {
"age": {
"description": "the max age of the log file. the log file will be rotated if the age is larger than this value",
"title": "Max Age",
"type": "integer"
},
"backups": {
"description": "the max backups of the log file. the rotated log file will be deleted if the backups is larger than this value",
"title": "Max Backups",
"type": "integer"
},
"compress": {
"description": "whether to compress the rotated log file",
"title": "Compress",
"type": "boolean"
},
"file": {
"description": "the file to save the log",
"title": "Log File",
"type": "string"
},
"level": {
"description": "Log Level",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal",
"panic"
],
"title": "Log Level",
"type": "string"
},
"self_rotate": {
"description": "whether to rotate the log file by self",
"title": "Self Rotate",
"type": "boolean"
},
"size": {
"description": "the max size of the log file. the log file will be rotated if the size is larger than this value",
"title": "Max Size",
"type": "integer"
}
},
"type": "object"
},
"conf_Notify": {
"additionalProperties": false,
"properties": {
"dry": {
"default": false,
"description": "set true to make the notification dry run and will not be sent the message",
"title": "dry",
"type": "boolean"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "the retry settings",
"title": "retry"
}
},
"type": "object"
},
"conf_Probe": {
"additionalProperties": false,
"properties": {
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"default": "1m",
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"default": "30s",
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"type": "object"
},
"conf_SLAReport": {
"additionalProperties": false,
"properties": {
"backups": {
"default": 5,
"description": "the number of backups of SLA report",
"title": "Backups",
"type": "integer"
},
"channels": {
"description": "the channels of SLA report",
"items": {
"type": "string"
},
"title": "Channels",
"type": "array"
},
"data": {
"description": "the data file of SLA report",
"title": "Data File",
"type": "string"
},
"schedule": {
"description": "the schedule of SLA report",
"enum": [
"none",
"minutely",
"hourly",
"daily",
"weekly",
"monthly"
],
"title": "Schedule",
"type": "string"
},
"time": {
"description": "the time of SLA report need to send out",
"examples": [
"23:59:59+08:00"
],
"title": "Time",
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
},
"conf_Settings": {
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/$defs/conf_HTTPServer",
"description": "The HTTP server settings of the EaseProbe instance",
"title": "HTTP Server Settings"
},
"icon": {
"description": "The URL of the icon of the EaseProbe instance",
"title": "Icon URL",
"type": "string"
},
"log": {
"$ref": "#/$defs/conf_Log",
"description": "The log settings of the EaseProbe instance",
"title": "EaseProbe Log"
},
"name": {
"default": "EaseProbe",
"description": "The name of the EaseProbe instance",
"title": "EaseProbe Name",
"type": "string"
},
"notify": {
"$ref": "#/$defs/conf_Notify",
"description": "The global notify settings of the EaseProbe instance",
"title": "Notify Settings"
},
"pid": {
"description": "The PID file of the EaseProbe instance ('-' means no PID file)",
"title": "PID File",
"type": "string"
},
"probe": {
"$ref": "#/$defs/conf_Probe",
"description": "The global probe settings of the EaseProbe instance",
"title": "Probe Settings"
},
"sla": {
"$ref": "#/$defs/conf_SLAReport",
"description": "The SLA report settings of the EaseProbe instance",
"title": "SLA Report Settings"
},
"timeformat": {
"default": "2006-01-02 15:04:05Z07:00",
"description": "The time format of the EaseProbe instance",
"title": "Time Format",
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The time zone of the EaseProbe instance",
"examples": [
"Asia/Shanghai",
"Europe/Berlin"
],
"title": "Time Zone",
"type": "string"
}
},
"type": "object"
},
"eval_Evaluator": {
"additionalProperties": false,
"properties": {
"doc": {
"description": "Document Type",
"enum": [
"html",
"xml",
"json",
"text"
],
"title": "Document Type",
"type": "string"
},
"expression": {
"description": "Expression need to be evaluated",
"title": "Expression",
"type": "string"
},
"variables": {
"description": "define the variables used in the expression",
"items": {
"$ref": "#/$defs/eval_Variable"
},
"title": "Variables Definition",
"type": "array"
}
},
"required": [
"doc",
"expression"
],
"type": "object"
},
"eval_Variable": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Variable Name",
"title": "Variable Name",
"type": "string"
},
"query": {
"description": "XPath/Regex Expression to extract the value",
"title": "Query",
"type": "string"
},
"type": {
"description": "Variable Type",
"enum": [
"int",
"string",
"bool",
"float",
"bool",
"time",
"duration"
],
"title": "Variable Type",
"type": "string"
}
},
"required": [
"name",
"type",
"query"
],
"type": "object"
},
"global_Retry": {
"additionalProperties": false,
"properties": {
"interval": {
"description": "the interval between each retry",
"title": "Retry Interval",
"type": "string"
},
"times": {
"description": "how many times need to retry",
"minimum": 1,
"title": "Retry Times",
"type": "integer"
}
},
"type": "object"
},
"notify_Config": {
"additionalProperties": false,
"properties": {
"aws_sns": {
"description": "AWS SNS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_aws_NotifyConfig"
},
"title": "AWS SNS Notification",
"type": "array"
},
"dingtalk": {
"description": "DingTalk Notification Configuration",
"items": {
"$ref": "#/$defs/notify_dingtalk_NotifyConfig"
},
"title": "DingTalk Notification",
"type": "array"
},
"discord": {
"description": "Discord Notification Configuration",
"items": {
"$ref": "#/$defs/notify_discord_NotifyConfig"
},
"title": "Discord Notification",
"type": "array"
},
"email": {
"description": "Email Notification Configuration",
"items": {
"$ref": "#/$defs/notify_email_NotifyConfig"
},
"title": "Email Notification",
"type": "array"
},
"lark": {
"description": "Lark Notification Configuration",
"items": {
"$ref": "#/$defs/notify_lark_NotifyConfig"
},
"title": "Lark Notification",
"type": "array"
},
"log": {
"description": "Log Notification Configuration",
"items": {
"$ref": "#/$defs/notify_log_NotifyConfig"
},
"title": "Log Notification",
"type": "array"
},
"ringcentral": {
"description": "RingCentral Notification Configuration",
"items": {
"$ref": "#/$defs/notify_ringcentral_NotifyConfig"
},
"title": "RingCentral Notification",
"type": "array"
},
"shell": {
"description": "Shell Notification Configuration",
"items": {
"$ref": "#/$defs/notify_shell_NotifyConfig"
},
"title": "Shell Notification",
"type": "array"
},
"slack": {
"description": "Slack Notification Configuration",
"items": {
"$ref": "#/$defs/notify_slack_NotifyConfig"
},
"title": "Slack Notification",
"type": "array"
},
"sms": {
"description": "SMS Notification Configuration",
"items": {
"$ref": "#/$defs/notify_sms_NotifyConfig"
},
"title": "SMS Notification",
"type": "array"
},
"teams": {
"description": "Teams Notification Configuration",
"items": {
"$ref": "#/$defs/notify_teams_NotifyConfig"
},
"title": "Teams Notification",
"type": "array"
},
"telegram": {
"description": "Telegram Notification Configuration",
"items": {
"$ref": "#/$defs/notify_telegram_NotifyConfig"
},
"title": "Telegram Notification",
"type": "array"
},
"wecom": {
"description": "WeCom Notification Configuration",
"items": {
"$ref": "#/$defs/notify_wecom_NotifyConfig"
},
"title": "WeCom Notification",
"type": "array"
}
},
"type": "object"
},
"notify_aws_Credentials": {
"additionalProperties": false,
"properties": {
"id": {
"description": "AWS Access Key ID",
"title": "AWS Access Key ID",
"type": "string"
},
"key": {
"description": "AWS Access Key Secret",
"title": "AWS Access Key Secret",
"type": "string"
}
},
"required": [
"id",
"key"
],
"type": "object"
},
"notify_aws_NotifyConfig": {
"additionalProperties": false,
"properties": {
"arn": {
"description": "The ARN of the SNS topic",
"title": "Topic ARN",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"credential": {
"$ref": "#/$defs/notify_aws_Credentials",
"description": "AWS Credential",
"title": "AWS Credential"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"endpoint": {
"description": "AWS Endpoint",
"examples": [
"\"https://sns.us-west-2.amazonaws.com\""
],
"title": "AWS Endpoint",
"type": "string"
},
"format": {
"default": "text",
"description": "Format of the notification",
"enum": [
"text",
"html",
"markdown",
"json"
],
"title": "Format of the Notification",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"profile": {
"description": "AWS Profile",
"title": "AWS Profile",
"type": "string"
},
"region": {
"description": "AWS Region ID",
"examples": [
"\"us-west-2\""
],
"title": "AWS Region ID",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"region",
"endpoint",
"credential",
"arn"
],
"type": "object"
},
"notify_dingtalk_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The Dingtalk Robot Secret",
"title": "Secret",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Dingtalk Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_discord_NotifyConfig": {
"additionalProperties": false,
"properties": {
"avatar": {
"description": "Discord Avatar for the notification",
"examples": [
"https://example.com/avatar.png"
],
"format": "uri",
"title": "Avatar",
"type": "string"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"thumbnail": {
"description": "Discord Thumbnail for the notification",
"examples": [
"https://example.com/thumbnail.png"
],
"format": "uri",
"title": "Thumbnail",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"username": {
"description": "Discord Username for the notification",
"title": "Username",
"type": "string"
},
"webhook": {
"description": "Discord Webhook URL for the notification",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_email_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "Email address from",
"examples": [
"\"[email protected]\""
],
"title": "From",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"password": {
"description": "SMTP password",
"examples": [
"\"password\""
],
"title": "SMTP Password",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"server": {
"description": "SMTP server with port",
"examples": [
"\"smtp.example.com:465\""
],
"format": "hostname",
"title": "SMTP Server",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"to": {
"description": "Email address to send",
"examples": [
"\"[email protected];[email protected]\""
],
"title": "To",
"type": "string"
},
"username": {
"description": "SMTP username",
"examples": [
"\"[email protected]\""
],
"title": "SMTP Username",
"type": "string"
}
},
"required": [
"name",
"server",
"username",
"password",
"to"
],
"type": "object"
},
"notify_lark_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Lark Robot Webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_log_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"file": {
"description": "The log file to write the notification message",
"title": "Log File",
"type": "string"
},
"host": {
"description": "The log host to write the notification message",
"title": "Syslog Host",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"network": {
"description": "The syslog network to write the notification message",
"enum": [
"tcp",
"udp"
],
"title": "Syslog Network",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"notify_ringcentral_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The RingCentral webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_shell_NotifyConfig": {
"additionalProperties": false,
"properties": {
"args": {
"description": "the arguments for command",
"items": {
"type": "string"
},
"title": "Arguments",
"type": "array"
},
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment Variables",
"type": "boolean"
},
"cmd": {
"description": "the command to run",
"title": "Command",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"env": {
"description": "the environment variables for command",
"items": {
"type": "string"
},
"title": "Environment variables",
"type": "array"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"notify_slack_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Slack webhook URL",
"format": "uri",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_sms_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"from": {
"description": "The sender of the notification message",
"title": "From",
"type": "string"
},
"key": {
"description": "The key of the SMS provider",
"title": "Key",
"type": "string"
},
"mobile": {
"description": "The mobile number to send the notification message",
"examples": [
"\"123456789,987654321\""
],
"title": "Mobile",
"type": "string"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"provider": {
"description": "The SMS provider to send the notification message",
"enum": [
"yunpian",
"twilio",
"nexmo"
],
"title": "SMS Provider",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"secret": {
"description": "The secret of the SMS provider",
"title": "Secret",
"type": "string"
},
"sign": {
"description": "The sign of the SMS provider",
"title": "Sign",
"type": "string"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"url": {
"description": "The URL of the SMS provider",
"format": "uri",
"title": "URL",
"type": "string"
}
},
"required": [
"name",
"provider",
"mobile",
"key"
],
"type": "object"
},
"notify_teams_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Microsoft Teams Robot Webhook URL",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"notify_telegram_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"chat_id": {
"description": "Telegram Group ID or Channel ID",
"title": "Telegram Chat ID",
"type": "string"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"token": {
"description": "Telegram Bot Token",
"title": "Telegram Bot Token",
"type": "string"
}
},
"required": [
"name",
"token",
"chat_id"
],
"type": "object"
},
"notify_wecom_NotifyConfig": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "The channels of the notification",
"items": {
"type": "string"
},
"title": "Notification Channels",
"type": "array"
},
"dry": {
"description": "If true the notification will not send the message",
"title": "Dry Run",
"type": "boolean"
},
"name": {
"description": "The name of the notification",
"title": "Notification Name",
"type": "string"
},
"retry": {
"$ref": "#/$defs/global_Retry",
"description": "The retry of the notification",
"title": "Retry"
},
"timeout": {
"description": "The timeout of the notification",
"title": "Timeout",
"type": "integer"
},
"webhook": {
"description": "The Webhook URL of Wecom",
"title": "Webhook URL",
"type": "string"
}
},
"required": [
"name",
"webhook"
],
"type": "object"
},
"probe_client_Client": {
"additionalProperties": false,
"properties": {
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"data": {
"description": "The data of the client",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "Data",
"type": "object"
},
"driver": {
"description": "The driver of the client",
"enum": [
"mysql",
"redis",
"memcache",
"kafka",
"mongo",
"postgres",
"zookeeper"
],
"examples": [
"mysql"
],
"title": "Driver",
"type": "string"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host of the client",
"examples": [
"10.1.1.1:9000"
],
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"password": {
"description": "The password of the client",
"examples": [
"123456"
],
"title": "Password",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "The username of the client",
"examples": [
"root"
],
"title": "Username",
"type": "string"
}
},
"required": [
"name",
"host",
"driver"
],
"type": "object"
},
"probe_host_Host": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion server for ssh login",
"title": "Bastion Servers"
},
"servers": {
"description": "the host servers to be monitored",
"items": {
"$ref": "#/$defs/probe_host_Server"
},
"title": "Host Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_host_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"disks": {
"description": "the disks to be monitored",
"items": {
"type": "string"
},
"title": "Disks",
"type": "array"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"threshold": {
"$ref": "#/$defs/probe_host_Threshold",
"description": "the threshold of the probe for cpu/memory/disk",
"title": "Threshold"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_host_Threshold": {
"additionalProperties": false,
"properties": {
"cpu": {
"description": "CPU threshold (default: 0.8)",
"title": "CPU threshold",
"type": "number"
},
"disk": {
"description": "Disk threshold (default: 0.95)",
"title": "Disk threshold",
"type": "number"
},
"load": {
"description": "Load Average M1/M5/M15 threshold (default: 0.8)",
"patternProperties": {
".*": {
"type": "number"
}
},
"title": "Load average threshold",
"type": "object"
},
"mem": {
"description": "Memory threshold (default: 0.8)",
"title": "Memory threshold",
"type": "number"
}
},
"type": "object"
},
"probe_http_HTTP": {
"additionalProperties": false,
"properties": {
"body": {
"description": "HTTP body to use for HTTP requests",
"title": "HTTP Body",
"type": "string"
},
"ca": {
"description": "the CA file path",
"title": "CA File",
"type": "string"
},
"cert": {
"description": "the Cert file path",
"title": "Cert File",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"content_encoding": {
"description": "content encoding to use for HTTP requests",
"title": "Content Encoding",
"type": "string"
},
"eval": {
"$ref": "#/$defs/eval_Evaluator",
"description": "HTTP evaluator to use for HTTP requests",
"title": "HTTP Evaluator"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"headers": {
"description": "HTTP headers to use for HTTP requests",
"patternProperties": {
".*": {
"type": "string"
}
},
"title": "HTTP Headers",
"type": "object"
},
"insecure": {
"description": "whether to skip the TLS verification",
"title": "Insecure",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the Key file path",
"title": "Key File",
"type": "string"
},
"method": {
"description": "HTTP method to use for HTTP requests",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"HEAD",
"OPTIONS",
"PATCH",
"TRACE",
"CONNECT"
],
"title": "HTTP Method",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"password": {
"description": "HTTP Basic Auth Password",
"title": "HTTP Basic Auth Password",
"type": "string"
},
"proxy": {
"description": "proxy to use for HTTP requests",
"title": "Proxy Server",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"success_code": {
"description": "Preferred HTTP response code ranges. If not set the default is [0, 499].",
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"title": "HTTP Success Code Range",
"type": "array"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"url": {
"description": "HTTP URL to probe",
"format": "uri",
"title": "HTTP URL",
"type": "string"
},
"username": {
"description": "HTTP Basic Auth Username",
"title": "HTTP Basic Auth Username",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"probe_ping_Ping": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"count": {
"default": 3,
"description": "The number of ping packets to send",
"minimum": 1,
"title": "Count",
"type": "integer"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to ping",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"lost": {
"default": 0,
"description": "The threshold of packet loss",
"maximum": 1,
"title": "Lost Threshold",
"type": "number"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"privileged": {
"description": "Run ping with privileged modem",
"title": "Privileged",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host",
"count",
"lost",
"privileged"
],
"type": "object"
},
"probe_shell_Shell": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Command Line Arguments",
"items": {
"type": "string"
},
"title": "Command Line Arguments",
"type": "array"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"clean_env": {
"description": "set it to true to keep the environment variables of the current process",
"title": "Clean Environment",
"type": "boolean"
},
"cmd": {
"description": "Command Line",
"title": "Command Line",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "Environment Variables",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"cmd"
],
"type": "object"
},
"probe_ssh_Endpoint": {
"additionalProperties": false,
"properties": {
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"probe_ssh_SSH": {
"additionalProperties": false,
"properties": {
"bastion": {
"$ref": "#/$defs/BastionMapType",
"description": "the bastion hosts configuration",
"title": "Bastion Servers"
},
"servers": {
"description": "SSH servers to probe",
"items": {
"$ref": "#/$defs/probe_ssh_Server"
},
"title": "SSH Servers",
"type": "array"
}
},
"required": [
"servers"
],
"type": "object"
},
"probe_ssh_Server": {
"additionalProperties": false,
"properties": {
"args": {
"description": "arguments for the command",
"items": {
"type": "string"
},
"title": "Shell Command Arguments",
"type": "array"
},
"bastion": {
"description": "the bastion host id",
"title": "Bastion Server",
"type": "string"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"cmd": {
"description": "command to run",
"title": "Shell Command",
"type": "string"
},
"contain": {
"description": "the string must be contained",
"title": "Contain Text",
"type": "string"
},
"env": {
"description": "environment variables for the command",
"items": {
"type": "string"
},
"title": "Environment Variables",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "the host for ssh probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"key": {
"description": "the private key file path for ssh login",
"title": "Private Key",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"not_contain": {
"description": "the string must not be contained",
"title": "Not Contain Text",
"type": "string"
},
"passphrase": {
"description": "the passphrase for ssh private key",
"title": "Passphrase",
"type": "string"
},
"password": {
"description": "the password for ssh probe",
"title": "Password",
"type": "string"
},
"regex": {
"description": "use regular expression to check the contain or not contain",
"title": "regex",
"type": "boolean"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
},
"username": {
"description": "the username for ssh probe",
"title": "User",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tcp_TCP": {
"additionalProperties": false,
"properties": {
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
},
"probe_tls_TLS": {
"additionalProperties": false,
"properties": {
"alert_expire_before": {
"description": "The alert expire before time",
"title": "Alert Expire Before",
"type": "integer"
},
"channels": {
"description": "the channels of probe message need to send to",
"items": {
"type": "string"
},
"title": "Probe Channels",
"type": "array"
},
"expire_skip_verify": {
"description": "Whether to skip verifying the certificate expire time",
"title": "Expire Skip Verify",
"type": "boolean"
},
"failure": {
"default": 1,
"description": "the failures threshold to change the status such as 3",
"title": "Failure Threshold",
"type": "integer"
},
"host": {
"description": "The host to probe",
"format": "hostname",
"title": "Host",
"type": "string"
},
"insecure_skip_verify": {
"description": "Whether to skip verifying the certificate chain and host name",
"title": "Insecure Skip Verify",
"type": "boolean"
},
"interval": {
"description": "the interval of probe",
"title": "Probe Interval",
"type": "string"
},
"name": {
"description": "the name of probe must be unique",
"title": "Probe Name",
"type": "string"
},
"proxy": {
"description": "The proxy to use for the TLS connection",
"format": "hostname",
"title": "Proxy",
"type": "string"
},
"root_ca_pem": {
"description": "The root CA PEM",
"title": "Root CA PEM",
"type": "string"
},
"root_ca_pem_path": {
"description": "The path to the root CA PEM file",
"title": "Root CA PEM Path",
"type": "string"
},
"success": {
"default": 1,
"description": "the success threshold to change the status such as 2",
"title": "Success Threshold",
"type": "integer"
},
"timeout": {
"description": "the timeout of probe",
"title": "Probe Timeout",
"type": "string"
}
},
"required": [
"name",
"host"
],
"type": "object"
}
},
"$id": "https://github.com/megaease/easeprobe/conf/conf_-conf",
"$ref": "#/$defs/conf_Conf",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
Orange-OpenSource/its-client | 84ed0aeb52d502f8422aa7b20cba5efa96a2a34d | 2022-12-07T06:13:42 | schema/denm_schema_1-1-3.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0.1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0.01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "denm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.3",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 78c5e8b435601b321695c2f192e17d3317dc6c34 | 2022-10-06T14:51:38 | schema/denm_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "denm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.2",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 5512a07c45540f4217ed89e892cf4bd3c908cef6 | 2021-09-16T13:38:51 | schema/denm_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "denm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/cpm_schema_1-0-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"generation_delta_time": {
"description": "Unit: millisecond. Time of the reference position in the CPM, considered as time of the CPM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"description": "Station type of the originating ITS-S. unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"message_id": {
"description": "Type of ITS message",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"number_of_perceived_objects": {
"description": "The number of perceived objects by the transmitting ITS-S. This number does not have to match up with the number of objects included in the transmitted message due to the object inclusion scheme. ",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"perceived_object_container": {
"description": "List of information for individual perceived object",
"items": {
"properties": {
"distance": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"distance_confidence": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"object_confidence": {
"default": 0,
"description": "The confidence associated to the object; unknown(0), onePercent(1), oneHundredPercent(100),unavailable(101)",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object relative to which the measurement data is provided. In case no object reference - point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"speed": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in x-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in y-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"speed_confidence": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in x-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in y-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"time_of_measurement": {
"description": "Unit: milliseconds. Time difference from the message's generation delta time to the time of the measurement of the object",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"object_confidence",
"distance",
"distance_confidence",
"speed",
"speed_confidence",
"object_ref_point"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"protocol_version": {
"description": "Version of the ITS message and/or communication protocol",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"detection_area": {
"properties": {
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to the horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10)",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the refPointID. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100)",
"maximum": 0,
"minimum": -5000,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the refPointID. zeroPointZeroOneMeter(1), oneMeter(100). zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the refPointID",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ref_point_id",
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"properties": {
"intersection_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"road_regulator_id": {
"description": "Road regulator id. When is present the intersection_id is guaranteed to be globally unique.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"intersection_id"
],
"type": "object"
},
"road_segment_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement of the originating ITS-S with regards to the true north; equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy of the originating ITS-S; equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement of the originating ITS-S with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed of the originating ITS-S; standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "Identifier for an ITS-S",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"message_id",
"generation_delta_time",
"management_container",
"number_of_perceived_objects"
],
"type": "object"
},
"origin": {
"description": "The entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "Identifier",
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"cpm"
]
},
"version": {
"default": "1.0.0",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | f00df20ae66e54d3e9890ceb44043f60fdb08b2b | 2022-01-24T17:06:41 | schema/cpm_schema_1-0-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"generation_delta_time": {
"description": "Unit: millisecond. Time of the reference position in the CPM, considered as time of the CPM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"description": "Station type of the originating ITS-S. unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"message_id": {
"description": "Type of ITS message",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"number_of_perceived_objects": {
"description": "The number of perceived objects by the transmitting ITS-S. This number does not have to match up with the number of objects included in the transmitted message due to the object inclusion scheme. ",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"perceived_object_container": {
"description": "List of information for individual perceived object",
"items": {
"properties": {
"distance": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"distance_confidence": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"object_confidence": {
"default": 0,
"description": "The confidence associated to the object; unknown(0), onePercent(1), oneHundredPercent(100),unavailable(101)",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object relative to which the measurement data is provided. In case no object reference - point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"speed": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in x-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in y-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"speed_confidence": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in x-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in y-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"time_of_measurement": {
"description": "Unit: milliseconds. Time difference from the message's generation delta time to the time of the measurement of the object",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"object_confidence",
"distance",
"distance_confidence",
"speed",
"speed_confidence",
"object_ref_point"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"protocol_version": {
"description": "Version of the ITS message and/or communication protocol",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"detection_area": {
"properties": {
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to the horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10)",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the refPointID. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100)",
"maximum": 0,
"minimum": -5000,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the refPointID. zeroPointZeroOneMeter(1), oneMeter(100). zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the refPointID",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ref_point_id",
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"properties": {
"intersection_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"road_regulator_id": {
"description": "Road regulator id. When is present the intersection_id is guaranteed to be globally unique.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"intersection_id"
],
"type": "object"
},
"road_segment_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement of the originating ITS-S with regards to the true north; equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy of the originating ITS-S; equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement of the originating ITS-S with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed of the originating ITS-S; standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "Identifier for an ITS-S",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"message_id",
"generation_delta_time",
"management_container",
"number_of_perceived_objects"
],
"type": "object"
},
"origin": {
"description": "The entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "Identifier",
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cpm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.0.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 98321a1b7e5404a59fe91c5bf4ae644340ba46b1 | 2022-12-06T14:07:22 | schema/status_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"$comment": "Development version",
"const": "1.0.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 00f2ed47e2dc4402425e3d2df7b8ba4b18d5aa67 | 2023-03-10T18:32:17 | schema/status_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"items": {
"description": "signal quality metrics for specific transport technology",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
},
"technology": {
"type": "string"
}
},
"required": [
"technology"
],
"type": "object"
},
"type": "array"
},
"technology": {
"description": "technology used to establish the connection",
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"gnss": {
"$comment": "modelled after the gpsd protocol; references like {gpsd:XXX:YYY[:ZZZ...]} refer to gpsd object XXX, field YYY (sub-field ZZZ, etc...) as defined in the gpsd JSON protocol documentation: https://gpsd.io/gpsd_json.html",
"description": "status of the GNSS subsystem",
"properties": {
"mode": {
"$comment": "0: unkown; 1: none; 2: 2D-FIX; 3: 3D-FIX",
"description": "FIX mode {gpsd:TPV:mode}",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"model": {
"$comment": "concatenation of the three fields: {gpsd:DEVICE:driver}, {gpsd:DEVICE:subtype}, and {gpsd:DEVICE:subtype1}",
"description": "Brand and model of the GNSS device (free form)",
"type": "string"
},
"nSat": {
"description": "Number of satellites seen {gpsd:SKY:nSat}",
"minimum": 1,
"type": "integer"
},
"rate": {
"$comment": "seconds with arbitrary sub-second precision",
"description": "mesaurement rate {gpsd:DEVICE:cycle}",
"exclusiveMinimum": 0.0,
"type": "number"
},
"software": {
"$comment": "typically: literal 'gpsd' followed by {gpsd:VERSION:release}",
"description": "name and version of the gnss daemon (free form)",
"type": "string"
},
"status": {
"$comment": "2: DGPS; 3: RTK-fixed; 4: RTK-floating",
"description": "FIX status {gpsd:TPV:status}",
"enum": [
2,
3,
4
],
"type": "integer"
},
"uSat": {
"description": "Number of satellites used in navigation solution {gpsd:SKY:uSat}",
"minimum": 1,
"type": "integer"
}
},
"required": [
"software",
"model",
"mode"
],
"type": "object"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"const": "1.1.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular",
"gnss"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | f00df20ae66e54d3e9890ceb44043f60fdb08b2b | 2022-01-24T17:06:41 | schema/information_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"central_instance_id": {
"description": "unique id all other the world for the central server if the instance is of type edge",
"type": "string"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"instance_type": {
"description": "type of instance",
"enum": [
"edge",
"central"
],
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.1.0",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"instance_type",
"running",
"timestamp",
"validity_duration"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 84ed0aeb52d502f8422aa7b20cba5efa96a2a34d | 2022-12-07T06:13:42 | schema/cpm_schema_1-2-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"area_circular": {
"description": "a circular area. The circle is centred about the reference point or about the nodeCenterPoint (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset"
},
"radius": {
"description": "Unit: 0.1 meter. The radius of the circular area. zeroPointZeroOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"radius"
],
"type": "object"
},
"area_ellipse": {
"description": "An elliptical area. The ellipse is centred about the reference point or about the node center point (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset",
"description": "Offset point about which the ellipse is centred with respect to the reference position."
},
"semi_height": {
"description": "Unit: 0.1 meter. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_length": {
"description": "Unit: 0.1 meter. Major radius of the ellipse. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_orientation": {
"description": "Unit: 0.1 degrees. Orientation of the semi major range length of the ellipse in the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_range_length": {
"description": "Unit: 0.1 meter. Minor radius of the ellipse. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_range_length",
"semi_minor_range_length",
"semi_major_range_orientation"
],
"type": "object"
},
"area_polygon": {
"description": "Polygonal area constructed by connecting the offset points in the sequence provided. The last point shall be connected with the first point to close the polygon.",
"items": {
"$ref": "#/$defs/offset"
},
"maxItems": 16,
"minItems": 3,
"type": "array"
},
"area_rectangle": {
"description": "A rectangular area. The rectangle is centred about the reference point or about the node center point (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset",
"description": "Offset point about which the rectangle is centred with respect to the reference position."
},
"semi_height": {
"description": "Unit: 0.1 meter. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_length": {
"description": "Unit: 0.1 meter. Half length of the rectangle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_orientation": {
"description": "Unit: 0.1 degrees.Orientation of the semi major range length of the rectangle in the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_range_length": {
"description": "Unit: 0.1 meter. Half width of the rectangle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_range_length",
"semi_minor_range_length",
"semi_major_range_orientation"
],
"type": "object"
},
"offset": {
"additionalProperties": false,
"description": "Offset JSon schema. Describes an offset position in a two- or three-dimensional plane.",
"properties": {
"x": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"y": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"z": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cpm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"free_space_addendum_container": {
"description": "List of information for individual perceived object",
"items": {
"description": "This container shall only be added if the confidence indication needs to be altered with respect to the isotropic @see FreeSpace Confidence confidence level indication provided in the Sensor Information.",
"properties": {
"free_space_area": {
"description": "free space area for which the free space confidence of this addendum container is valid. The described area that is considered as not occupied by any traffic participant or obstacle.",
"oneOf": [
{
"required": [
"free_space_polygon"
]
},
{
"required": [
"free_space_circular"
]
},
{
"required": [
"free_space_ellipse"
]
},
{
"required": [
"free_space_rectangle"
]
}
],
"properties": {
"free_space_circular": {
"$ref": "#/$defs/area_circular"
},
"free_space_ellipse": {
"$ref": "#/$defs/area_ellipse"
},
"free_space_polygon": {
"$ref": "#/$defs/area_polygon"
},
"free_space_rectangle": {
"$ref": "#/$defs/area_rectangle"
}
},
"type": "object"
},
"free_space_confidence": {
"description": "Isotropic free space confidence that applies to the entire area as defined in the free space area of a particular free space addendum container. Confidence indicating that an area is not occupied by a traffic participant or obstacle. unknown(0) if the free space confidence is unknown for the described area, onePercent(1), oneHundredPercent(100), unavailable(101) if the confidence could not be computed and does not apply.",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"sensor_id_list": {
"description": "list of pseudonym sensor id which performed the measurement to indicate the free space.",
"items": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"shadowing_applies": {
"default": true,
"description": "if simple shadowing mechanism applies within the area described by the free space area.",
"type": "boolean"
}
},
"requires": [
"free_space_area",
"free_space_confidence"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"generation_delta_time": {
"description": "time of the reference position in the CAM, considered as time of the CAM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z. oneMilliSec(1).",
"examples": [
1,
1245
],
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable).",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable).",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable).",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable).",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001).",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth(10), oneMicrodegreeSouth(-10), unavailable(900000001).",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast(10), oneMicrodegreeWest(-10), unavailable(1800000001).",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown).",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15).",
"maximum": 254,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"perceived_object_container": {
"description": "List of information for individual perceived object. The total number of detected objects by the station at the time of generating the message. Due to the dynamic message generation rules, this number does not have to reflect the number of objects included in this message but states the number of objects known to the sender at the time of generating the message.",
"items": {
"properties": {
"classification": {
"description": "Provides the classification of the described object. Multi-dimensional classification may be provided.",
"items": {
"properties": {
"confidence": {
"description": "Describes the confidence value for the type of a detected object. unknown(0) in case the confidence value is unknown but the reported classification is still valid, onePercent(1), oneHundredPercent(100), unavailable(101) in case the class confidence value computation is not available for this object, indicates that the class assignment is invalid",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_class": {
"description": "The class that best describes the detected object. The object can be classified into one of three main categories: vehicle, VRU and other.",
"oneOf": [
{
"required": [
"vehicle"
]
},
{
"required": [
"single_vru"
]
},
{
"required": [
"vru_group"
]
},
{
"required": [
"other"
]
}
],
"properties": {
"other": {
"description": "Detected object for class other. unknown(0), roadSideUnit(1).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"single_vru": {
"oneOf": [
{
"required": [
"pedestrian"
]
},
{
"required": [
"bicyclist"
]
},
{
"required": [
"motorcylist"
]
},
{
"required": [
"animal"
]
}
],
"properties": {
"animal": {
"description": "unavailable(0), wild-animal(1), farm-animal(2), service-animal(3), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"bicyclist": {
"description": "unavailable(0), bicyclist(1), wheelchair-user(2), horse-and-rider(3), rollerskater(4), e-scooter(5), personal-transporter(6), pedelec(7), speed-pedelec(8), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"motorcylist": {
"description": "unavailable(0), moped(1), motorcycle(2), motorcycle-and-sidecar-right(3), motorcycle-and-sidecar-left(4), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"pedestrian": {
"description": "unavailable(0), ordinary-pedestrian(1), road-worker(2), first-responder(3), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"vehicle": {
"description": "Describes the subclass of a detected object for class vehicle. unknown(0) the type of vehicle is unknown, passengerCar(1) the detected object is a small passenger car, bus(2) the detected object is a large passenger vehicle, lightTruck(3) the detected object is a light goods vehicle, heavyTruck(4) the detected object is a heavy goods vehicle, trailer(5) the detected object is an unpowered vehicle that is intended to be towed by a powered vehicle, specialVehicles(6) the detected object is a vehicle which has a special purpose other than the above (e.g. moving road works vehicle), tram(7) the detected object is a vehicle running on tracks along public streets, emergencyVehicle(8) the detected object is a vehicle used in an emergency situation, such as an ambulance, police car or fire engine, agricultural(9) the detected object is a vehicle used for agricultural purposes.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vru_group": {
"description": "group of VRUs",
"properties": {
"cluster_id": {
"description": "If the group is associated to a VRU cluster, this element indicates the ID of the associated cluster. The ClusterId can only be assigned if a VRU cluster which is transmitting VAMs has been detected.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"group_size": {
"description": "Indicates an estimation of the number of VRUs in the group. unavailable(0), onlyLeader(1).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"group_type": {
"properties": {
"animal": {
"type": "boolean"
},
"bicyclist": {
"type": "boolean"
},
"motorcyclist": {
"type": "boolean"
},
"pedestrian": {
"type": "boolean"
}
},
"required": [
"pedestrian",
"bicyclist",
"motorcyclist",
"animal"
],
"type": "object"
}
},
"required": [
"group_type",
"group_size"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"object_class",
"confidence"
],
"type": "object"
},
"maxItems": 8,
"minItems": 1,
"type": "array"
},
"confidence": {
"longitudinal_lane_position": {
"description": "Unit: 0.01 m. Absolute accuracy of longitudinal lane position measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101) shall be set if the accuracy is out of range, unavailable(102) shall be set if the accuracy data is unavailable",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"object": {
"description": "The confidence associated to the object. The computation of the object confidence is based on a sensor's or, fusion system's specific detection confidence, the binary detection success that is, if an object has been successfully detected by the last measurement and the object age. A single-value indication about the overall information quality of a perceived object. Its computation is based on several scaling factors and moving averages. noConfidence(0) no confidence in detected object, e.g. for ghost-objects or if confidence could not be computed, fullConfidence(15) full confidence in detected object",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"pitch_acceleration": {
"description": "Pitch acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0.01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0.1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"pitch_angle": {
"description": "Pitch angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"pitch_rate": {
"description": "Pitch rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0.01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0.1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_1": {
"description": "Unit: 0.01 m. Accuracy of first provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_2": {
"description": "Unit: 0.01 m. Accuracy of second provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"required": [
"x_distance",
"y_distance",
"x_speed",
"y_speed",
"object"
],
"roll_acceleration": {
"description": "Roll acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0.01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0.1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"roll_angle": {
"description": "Roll angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"roll_rate": {
"description": "Roll rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0.01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0.1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"vertical_object_dimension": {
"description": "Unit: 0.01 m. Accuracy of vertical provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"x_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in x-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in x-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"x_speed": {
"description": "Speed confidence of detected object from the reference point in x-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"y_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in y-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in y-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"y_speed": {
"description": "Speed confidence of detected object from the reference point in y-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"yaw_acceleration": {
"description": "Yaw acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0.01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0.1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"yaw_angle": {
"description": "Yaw angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"yaw_rate": {
"description": "Yaw rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0.01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0.05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0.1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"z_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in z-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"z_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in z-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"z_speed": {
"description": "Speed confidence of detected object from the reference point in z-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
}
},
"dynamic_status": {
"description": "Indicated the dynamic capabilities of a detected object. Indication whether the detected object is classified as a dynamic (i.e. moving) object. This value indicates whether an object has the general capability to move, i.e. change its position. dynamic(0) the object is moving, hasBeenDynamic(1) indicates whether an object has been dynamic before, e.g., a car stopping at a traffic light, static(2) shall be used in case an object is identified to be not moving throughout any previous observation",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"lower_triangular_correlation_matrix_columns": {
"description": "Provides the columns of a lower triangular positive semi definite correlation matrix for the kinematic state and attitude space provided for this object. The order of the columns and rows of the correlation matrix is as follows: x_distance , y_distance , z_distance , x_speed , y_speed , z_speed , x_acceleration , y_acceleration , z_acceleration , roll_angle , pitch_angle , yaw_angle , roll_rate , pitch_rate , yaw_rate , roll_acceleration , pitch_acceleration , yaw_acceleration The number of lower_triangular_correlation_matrix_columns to be included k is thereby the number of provided values n of the kinematic state and attitude space minus 1: k = n-1. Each column i of the lower_triangular_correlation_matrix_columns contains k-(i-1) values. In case certain values of the kinematic state and attitude space are not provided, they are omitted from the lower_triangular_correlation_matrix_columns. A general data frame to express the elements of a lower triangular positive semi-definite matrix, not including the main diagonal elements of the matrix. Given a matrix A of size n x n, the number of columns to be included in the lower triangular matrix is k=n-1.",
"items": {
"description": "The column of the lower triangular positive semi-definite matrix consists of correlation row values. Given a matrix A of size n x n, the number of columns to be included in the lower triangular matrix is k=n-1. Each column i of the lower triangular then contains k-(i-1) values, where i refers to the column number count starting at 1 from the left.",
"items": {
"description": "The Bravais-Pearson correlation value for each cell of the lower triangular correlation matrix. Scaled by 100. full-negative-correlation(-100) full negative correlation, no-correlation(0) if not correlated or unavailable, point-one(10), full-positive-correlation(100) full positive correlation",
"maximum": 100,
"minimum": -100,
"type": "integer"
},
"maxItems": 17,
"minItems": 1,
"type": "array"
},
"maxItems": 17,
"minItems": 1,
"type": "array"
},
"matched_position": {
"description": "Unit: . The map-matched position of an object. This requires that a MAP-message is provided. Conveys an assigned index that is unique within the intersection.",
"properties": {
"lane_id": {
"description": "Conveys an assigned index that is unique within the intersection.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"longitudinal_lane_position": {
"description": "Unit: 0.1 meter. Indicates the longitudinal offset of the map-matched position of a particular object along the matched lane, beginning from the lane\u2019s starting point. zeroPointOneMeter(1).",
"maximum": 32767,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"object_age": {
"description": "Unit: 1 ms. Provides the age of the detected and described object. Age of object in milliseconds, i.e. for how long the object has been observed by the disseminating station. oneMiliSec(1), moreThan1Point5Second(1500).",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object which remains constant as long as the object is perceived. Numbers are assigned in an increasing round-robin fashion. When the last identifier in the allowed range has been used, the first counter for the identifier starts from the beginning of the range again.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object. The kinematic attitude and state data provided for this object are valid for this reference point of the object. In case no object reference point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8).",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"pitch_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Pitch acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"pitch_angle": {
"description": "Unit: 0.1 degrees. Pitch angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the y-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"pitch_rate": {
"description": "Unit: 0.01 degrees/s. Pitch rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"planar_object_dimension_1": {
"description": "Unit: 0.1 m. First dimension of object as provided by the sensor or environment model. This dimension is always contained in the plane which is oriented perpendicular to the direction of the angle indicated by the yawAngle and which contains the object's reference point. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_2": {
"description": "Unit: 0.1 m. Second dimension of the object as provided by the sensor environment model. This dimension is contained in the plane oriented in the direction of the angle indicated by the yawAngle and the object's reference point. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"roll_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Roll acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"roll_angle": {
"description": "Unit: 0.1 degrees. Roll angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"roll_rate": {
"description": "Unit: 0.01 degrees/s. Roll rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"sensor_id_list": {
"description": "List of sensor-IDs which provided the measurement data.",
"items": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"time_of_measurement": {
"description": "Unit: 1 millisecond. Time difference from the message\u2019s generation delta time to the time of the measurement of the object.",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
},
"vertical_object_dimension": {
"description": "Unit: 0.1 m. Vertical dimension of object as provided by the sensor or object model. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"x_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in x-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"x_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in x-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"x_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in x-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in y-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in y-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in y-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"yaw_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Yaw acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"yaw_angle": {
"description": "Unit: 0.1 degrees. Yaw angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the z-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"description": "Unit: 0.01 degrees/s. Yaw rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"z_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in z-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"z_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in z-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"z_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in z-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"x_distance",
"y_distance",
"x_speed",
"y_speed",
"object_age",
"confidence"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"protocol_version": {
"description": "version of the message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside.",
"items": {
"properties": {
"detection_area": {
"properties": {
"stationary_sensor_circular": {
"$ref": "#/$defs/area_circular"
},
"stationary_sensor_ellipse": {
"$ref": "#/$defs/area_ellipse"
},
"stationary_sensor_polygon": {
"$ref": "#/$defs/area_polygon"
},
"stationary_sensor_radial": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. The orientation indicating the end of the stationary sensor\u2019s horizontal opening angle in positive angular direction with respect to the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable (3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. The orientation indicating the start of the stationary sensor\u2019s horizontal opening angle in positive angular direction with respect to the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable (3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. The radial range of the sensor from the reference point or sensor point offset. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sensor_position_offset": {
"$ref": "#/$defs/offset",
"description": "The offset of the mounting point of this sensor from the station's reference position."
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. The orientation indicating the end of the stationary sensor\u2019s vertical opening angle in positive angular direction of a Cartesian coordinate system with its x-axis located in the north-east plane of the WGS84 coordinate system. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. The orientation indicating the start of the stationary sensor\u2019s vertical opening angle in positive angular direction of a Cartesian coordinate system with its x-axis located in the north-east plane of the WGS84 coordinate system. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"stationary_sensor_rectangle": {
"$ref": "#/$defs/area_rectangle"
},
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside.",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal opening angle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontal opening angle start to horizontal opening angle end in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal opening angle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontal opening angle start to horizontal opening angle end in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical opening angle extension. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontal opening angle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical opening angle extension. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontal opening angle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the ref point id. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100), negativeOutOfRange(-3094), positiveOneMeter(100),positiveOutOfRange(1001).",
"maximum": 1001,
"minimum": -3094,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the ref point id. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the ref point id. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11).",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"oneOf": [
{
"required": [
"originating_vehicle_container"
]
},
{
"required": [
"originating_rsu_container"
]
}
],
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"region": {
"description": "Road regulator id. When is present the intersection or road segment reference id is guaranteed to be globally unique.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"road_segment_reference_id": {
"description": "Road segment id. Unique within that region.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement with regards to the true north. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4).",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8).",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2).",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0.1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed. standstill(0), oneCentimeterPerSec(1), unavailable(16383).",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023).",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62).",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0.01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "identifier",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"generation_delta_time",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "identifier",
"examples": [
"ora_car_42"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01).",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cpm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.2.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 78c5e8b435601b321695c2f192e17d3317dc6c34 | 2022-10-06T14:51:38 | schema/cam_schema_1-1-2.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "CAM JSon schema",
"properties": {
"message": {
"properties": {
"basic_container": {
"properties": {
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"reference_position"
],
"type": "object"
},
"generation_delta_time": {
"description": "time of the reference position in the CAM, considered as time of the CAM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z. oneMilliSec(1)",
"examples": [
1,
1245
],
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"high_frequency_container": {
"description": "The basic vehicle container high frequency",
"properties": {
"acceleration_control": {
"description": "Current controlling mechanism for longitudinal movement of the vehicle. Represented as a bit string: brakePedalEngaged (0), gasPedalEngaged (1), emergencyBrakeEngaged (2), collisionWarningEngaged(3), accEngaged(4), cruiseControlEngaged(5), speedLimiterEngaged(6)",
"example": [
"0000000",
"1000000",
"0000011"
],
"maxLength": 7,
"minLength": 7,
"type": "string"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"description": "the high frequency container confidence fields. Note that no vehicle_width is defined",
"properties": {
"curvature": {
"description": "onePerMeter-0-00002 (0), onePerMeter-0-0001 (1), onePerMeter-0-0005 (2), onePerMeter-0-002 (3), onePerMeter-0-01 (4), onePerMeter-0-1 (5), outOfRange (6), unavailable (7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 4 (unavailable)",
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 8 (unavailable)",
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"curvature": {
"$comment": "if not provided, 'curvature' = 30001 (unavailable)",
"default": 1023,
"description": "straight(0), unavailable(1023)",
"maximum": 1023,
"minimum": -1023,
"type": "integer"
},
"curvature_calculation_mode": {
"$comment": "if not provided, 'curvature_calculation_mode' = 2 (unavailable)",
"default": 2,
"description": "It describes whether the yaw rate is used to calculate the curvature: yawRateUsed(0), yawRateNotUsed(1), unavailable(2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"drive_direction": {
"$comment": "if not provided, 'drive_direction' = 2 (unavailable)",
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 3601 (unavailable)",
"default": 3601,
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"$comment": "if not provided, 'longitudinal_acceleration' = 161 (unavailable)",
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 16383 (unavailable)",
"default": 16383,
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 1023 (unavailable)",
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"$comment": "if not provided, 'vehicle_width' = 62(unavailable)",
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 32767 (unavailable)",
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"type": "object"
},
"low_frequency_container": {
"description": "The basic vehicle container low frequency",
"properties": {
"exterior_lights": {
"description": "Status of the exterior light switches represented as a bit string: lowBeamHeadlightsOn (0), highBeamHeadlightsOn (1), leftTurnSignalOn (2), rightTurnSignalOn (3), daytimeRunningLightsOn (4), reverseLightOn (5), fogLightOn (6), parkingLightsOn (7)",
"example": [
"00000000",
"10011010",
"00000110"
],
"maxLength": 8,
"minLength": 8,
"type": "string"
},
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (generation_delta_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (reference_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
},
"vehicle_role": {
"$comment": "if not provided, 'vehicle_role' = 0 (default)",
"default": 0,
"description": "default(0), publicTransport(1), specialTransport(2), dangerousGoods(3), roadWork(4), rescue(5), emergency(6), safetyCar(7), agriculture(8),commercial(9),military(10),roadOperator(11),taxi(12), reserved1(13), reserved2(14), reserved3(15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"exterior_lights",
"path_history"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"generation_delta_time",
"basic_container",
"high_frequency_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "identifier",
"examples": [
"UNKNOWN",
"42"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cam",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.2",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | c1a7db60505fb662256f48540b0dfa565eea8d3d | 2021-09-13T13:52:12 | schema/denm_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"denm"
]
},
"version": {
"default": "1.1.0",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7657b355847077bcd8b8729f6bd4481abf51232c | 2023-01-30T10:09:18 | schema/information_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"central_instance_id": {
"description": "unique id all other the world for the central server if the instance is of type edge",
"type": "string"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"instance_type": {
"description": "type of instance",
"enum": [
"local",
"edge",
"central"
],
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.1.99",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"instance_type",
"running",
"timestamp",
"validity_duration"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | d8e782c06315a6c99ab4fe1b77c195d2059bb2aa | 2022-12-06T14:07:42 | schema/status_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"$comment": "Development version",
"const": "1.0.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 5512a07c45540f4217ed89e892cf4bd3c908cef6 | 2021-09-16T13:38:51 | schema/cpm_schema_1-0-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"generation_delta_time": {
"description": "Unit: millisecond. Time of the reference position in the CPM, considered as time of the CPM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"description": "Station type of the originating ITS-S. unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"message_id": {
"description": "Type of ITS message",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"number_of_perceived_objects": {
"description": "The number of perceived objects by the transmitting ITS-S. This number does not have to match up with the number of objects included in the transmitted message due to the object inclusion scheme. ",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"perceived_object_container": {
"description": "List of information for individual perceived object",
"items": {
"properties": {
"distance": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"distance_confidence": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"object_confidence": {
"default": 0,
"description": "The confidence associated to the object; unknown(0), onePercent(1), oneHundredPercent(100),unavailable(101)",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object relative to which the measurement data is provided. In case no object reference - point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"speed": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in x-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in y-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"speed_confidence": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in x-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in y-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"time_of_measurement": {
"description": "Unit: milliseconds. Time difference from the message's generation delta time to the time of the measurement of the object",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"object_confidence",
"distance",
"distance_confidence",
"speed",
"speed_confidence",
"object_ref_point"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"protocol_version": {
"description": "Version of the ITS message and/or communication protocol",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"detection_area": {
"properties": {
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to the horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10)",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the refPointID. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100)",
"maximum": 0,
"minimum": -5000,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the refPointID. zeroPointZeroOneMeter(1), oneMeter(100). zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the refPointID",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ref_point_id",
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"properties": {
"intersection_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"road_regulator_id": {
"description": "Road regulator id. When is present the intersection_id is guaranteed to be globally unique.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"intersection_id"
],
"type": "object"
},
"road_segment_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement of the originating ITS-S with regards to the true north; equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy of the originating ITS-S; equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement of the originating ITS-S with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed of the originating ITS-S; standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "Identifier for an ITS-S",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"message_id",
"generation_delta_time",
"management_container",
"number_of_perceived_objects"
],
"type": "object"
},
"origin": {
"description": "The entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "Identifier",
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cpm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.0.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | c1a7db60505fb662256f48540b0dfa565eea8d3d | 2021-09-13T13:52:12 | schema/information_schema_1-0-3.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the serveur",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"dns": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.2.0.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_logger": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.84.191.133:2203",
"81.169.166.64:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_logger": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.84.191.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"mqtt": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.88.40.59:1883",
"172.16.2.12:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.88.40.59:8883",
"172.16.2.12:18883"
],
"type": "string"
},
"type": "array"
},
"ntp": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.105.211.66",
"90.84.199.250",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"role": {
"description": "role of the server",
"enum": [
"edge",
"central"
],
"type": "string"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"default": [
"0",
"1",
"2",
"3"
],
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_logger": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.84.191.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity duration of the information relatively to the timestamp in minuts",
"type": "integer"
},
"version": {
"default": "1.0.3",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"running",
"timestamp",
"validity_duration",
"server_type"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/denm_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"denm"
]
},
"version": {
"const": "1.1.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | c1a7db60505fb662256f48540b0dfa565eea8d3d | 2021-09-13T13:52:12 | schema/cpm_schema_1-0-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"generation_delta_time": {
"description": "Unit: millisecond. Time of the reference position in the CPM, considered as time of the CPM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"description": "Station type of the originating ITS-S. unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"message_id": {
"description": "Type of ITS message",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"number_of_perceived_objects": {
"description": "The number of perceived objects by the transmitting ITS-S. This number does not have to match up with the number of objects included in the transmitted message due to the object inclusion scheme. ",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"perceived_object_container": {
"description": "List of information for individual perceived object",
"items": {
"properties": {
"distance": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"distance_confidence": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"object_confidence": {
"default": 0,
"description": "The confidence associated to the object; unknown(0), onePercent(1), oneHundredPercent(100),unavailable(101)",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object relative to which the measurement data is provided. In case no object reference - point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"speed": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in x-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in y-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"speed_confidence": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in x-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in y-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"time_of_measurement": {
"description": "Unit: milliseconds. Time difference from the message's generation delta time to the time of the measurement of the object",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"object_confidence",
"distance",
"distance_confidence",
"speed",
"speed_confidence",
"object_ref_point"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"protocol_version": {
"description": "Version of the ITS message and/or communication protocol",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"detection_area": {
"properties": {
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to the horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10)",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the refPointID. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100)",
"maximum": 0,
"minimum": -5000,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the refPointID. zeroPointZeroOneMeter(1), oneMeter(100). zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the refPointID",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ref_point_id",
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"properties": {
"intersection_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"road_regulator_id": {
"description": "Road regulator id. When is present the intersection_id is guaranteed to be globally unique.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"intersection_id"
],
"type": "object"
},
"road_segment_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement of the originating ITS-S with regards to the true north; equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy of the originating ITS-S; equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement of the originating ITS-S with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed of the originating ITS-S; standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "Identifier for an ITS-S",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"message_id",
"generation_delta_time",
"management_container",
"number_of_perceived_objects"
],
"type": "object"
},
"origin": {
"description": "The entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "Identifier",
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"cpm"
]
},
"version": {
"default": "1.0.0",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 4e46d89fee41063cae660abf138467442707c025 | 2021-09-16T13:38:51 | schema/denm_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"denm"
]
},
"version": {
"const": "1.1.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | f3c44bebf41bc220570d833de6b49f747885e81e | 2023-03-10T18:32:17 | schema/status_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"gnss": {
"$comment": "modelled after the gpsd protocol; references like {gpsd:XXX:YYY[:ZZZ...]} refer to gpsd object XXX, field YYY (sub-field ZZZ, etc...) as defined in the gpsd JSON protocol documentation: https://gpsd.io/gpsd_json.html",
"description": "status of the GNSS subsystem",
"properties": {
"mode": {
"$comment": "0: unkown; 1: none; 2: 2D-FIX; 3: 3D-FIX",
"description": "FIX mode {gpsd:TPV:mode}",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"model": {
"$comment": "concatenation of the three fields: {gpsd:DEVICE:driver}, {gpsd:DEVICE:subtype}, and {gpsd:DEVICE:subtype1}",
"description": "Brand and model of the GNSS device (free form)",
"type": "string"
},
"nSat": {
"description": "Number of satellites seen {gpsd:SKY:nSat}",
"minimum": 1,
"type": "integer"
},
"rate": {
"$comment": "seconds with arbitrary sub-second precision",
"description": "mesaurement rate {gpsd:DEVICE:cycle}",
"exclusiveMinimum": 0.0,
"type": "number"
},
"software": {
"$comment": "typically: literal 'gpsd' followed by {gpsd:VERSION:release}",
"description": "name and version of the gnss daemon (free form)",
"type": "string"
},
"status": {
"$comment": "2: DGPS; 3: RTK-fixed; 4: RTK-floating",
"description": "FIX status {gpsd:TPV:status}",
"enum": [
2,
3,
4
],
"type": "integer"
},
"uSat": {
"description": "Number of satellites used in navigation solution {gpsd:SKY:uSat}",
"minimum": 1,
"type": "integer"
}
},
"required": [
"software",
"model",
"mode"
],
"type": "object"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"const": "1.1.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular",
"gnss"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | e5c1a690d61ecdf1989e0a9f5842273171823ae4 | 2023-03-10T18:32:17 | schema/status_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"items": {
"description": "signal quality metrics for specific transport technology",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
},
"technology": {
"type": "string"
}
},
"required": [
"technology"
],
"type": "object"
},
"type": "array"
},
"technology": {
"description": "technology used to establish the connection",
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"gnss": {
"$comment": "modelled after the gpsd protocol; references like {gpsd:XXX:YYY[:ZZZ...]} refer to gpsd object XXX, field YYY (sub-field ZZZ, etc...) as defined in the gpsd JSON protocol documentation: https://gpsd.io/gpsd_json.html",
"description": "status of the GNSS subsystem",
"properties": {
"mode": {
"$comment": "0: unkown; 1: none; 2: 2D-FIX; 3: 3D-FIX",
"description": "FIX mode {gpsd:TPV:mode}",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"model": {
"$comment": "concatenation of the three fields: {gpsd:DEVICE:driver}, {gpsd:DEVICE:subtype}, and {gpsd:DEVICE:subtype1}",
"description": "Brand and model of the GNSS device (free form)",
"type": "string"
},
"nSat": {
"description": "Number of satellites seen {gpsd:SKY:nSat}",
"minimum": 1,
"type": "integer"
},
"rate": {
"$comment": "seconds with arbitrary sub-second precision",
"description": "mesaurement rate {gpsd:DEVICE:cycle}",
"exclusiveMinimum": 0.0,
"type": "number"
},
"software": {
"$comment": "typically: literal 'gpsd' followed by {gpsd:VERSION:release}",
"description": "name and version of the gnss daemon (free form)",
"type": "string"
},
"status": {
"$comment": "2: DGPS; 3: RTK-fixed; 4: RTK-floating",
"description": "FIX status {gpsd:TPV:status}",
"enum": [
2,
3,
4
],
"type": "integer"
},
"uSat": {
"description": "Number of satellites used in navigation solution {gpsd:SKY:uSat}",
"minimum": 1,
"type": "integer"
}
},
"required": [
"software",
"model",
"mode"
],
"type": "object"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"const": "1.2.0",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular",
"gnss"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | d66476042f98323a5243564bcaf150e28cd595a5 | 2021-09-15T14:55:19 | schema/information_schema_1-0-6.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"role": {
"description": "role of the server",
"enum": [
"edge",
"central"
],
"type": "string"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.0.6",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"running",
"timestamp",
"validity_duration",
"role"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/information_schema_1-0-3.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the serveur",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"dns": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.2.0.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_logger": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.84.191.133:2203",
"81.169.166.64:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_logger": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.84.191.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"mqtt": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.88.40.59:1883",
"172.16.2.12:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.88.40.59:8883",
"172.16.2.12:18883"
],
"type": "string"
},
"type": "array"
},
"ntp": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.105.211.66",
"90.84.199.250",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"role": {
"description": "role of the server",
"enum": [
"edge",
"central"
],
"type": "string"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"default": [
"0",
"1",
"2",
"3"
],
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_logger": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.84.191.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity duration of the information relatively to the timestamp in minuts",
"type": "integer"
},
"version": {
"default": "1.0.3",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"running",
"timestamp",
"validity_duration",
"server_type"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/information_schema_1-0-6.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"role": {
"description": "role of the server",
"enum": [
"edge",
"central"
],
"type": "string"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.0.6",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"running",
"timestamp",
"validity_duration",
"role"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 3c51589f6d74bf6291288e12a445dee7b30b9605 | 2022-12-06T14:07:42 | schema/status_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"gnss": {
"$comment": "modelled after the gpsd protocol; references like {gpsd:XXX:YYY[:ZZZ...]} refer to gpsd object XXX, field YYY (sub-field ZZZ, etc...) as defined in the gpsd JSON protocol documentation: https://gpsd.io/gpsd_json.html",
"description": "status of the GNSS subsystem",
"properties": {
"mode": {
"$comment": "0: unkown; 1: none; 2: 2D-FIX; 3: 3D-FIX",
"description": "FIX mode {gpsd:TPV:mode}",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"model": {
"$comment": "concatenation of the three fields: {gpsd:DEVICE:driver}, {gpsd:DEVICE:subtype}, and {gpsd:DEVICE:subtype1}",
"description": "Brand and model of the GNSS device (free form)",
"type": "string"
},
"nSat": {
"description": "Number of satellites seen {gpsd:SKY:nSat}",
"minimum": 1,
"type": "integer"
},
"rate": {
"$comment": "seconds with arbitrary sub-second precision",
"description": "mesaurement rate {gpsd:DEVICE:cycle}",
"exclusiveMinimum": 0.0,
"type": "number"
},
"software": {
"$comment": "typically: literal 'gpsd' followed by {gpsd:VERSION:release}",
"description": "name and version of the gnss daemon (free form)",
"type": "string"
},
"status": {
"$comment": "2: DGPS; 3: RTK-fixed; 4: RTK-floating",
"description": "FIX status {gpsd:TPV:status}",
"enum": [
2,
3,
4
],
"type": "integer"
},
"uSat": {
"description": "Number of satellites used in navigation solution {gpsd:SKY:uSat}",
"minimum": 1,
"type": "integer"
}
},
"required": [
"software",
"model",
"mode"
],
"type": "object"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"$comment": "Development version",
"const": "1.0.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular",
"gnss"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 11a26ae6902f90bc6d5c3db7c8a33bb2340132ee | 2023-01-30T10:09:18 | schema/information_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"central_instance_id": {
"description": "unique id all other the world for the central server if the instance is of type edge",
"type": "string"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"instance_type": {
"description": "type of instance",
"enum": [
"edge",
"central"
],
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.1.99",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"instance_type",
"running",
"timestamp",
"validity_duration"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 5285325a62b85d7ae9c39f2316dda1c62f3a20e7 | 2022-09-22T09:07:38 | schema/status_schema_1-0-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "harddware informatsion",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"required": [
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"description": "type of the server",
"enum": [
"obu",
"other"
],
"type": "string"
},
"version": {
"const": "1.0.0",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 658865d1d4e35c696b52e4da1c8aff3eab6399dc | 2022-11-22T14:07:14 | schema/denm_schema_1-1-2.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "denm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.2",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 8f7be8435caec75d609215ba03d0defffdd727ee | 2022-12-06T14:06:25 | schema/status_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"required": [
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"description": "type of the server",
"enum": [
"obu",
"other"
],
"type": "string"
},
"version": {
"$comment": "Development version",
"const": "1.0.99",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 84ed0aeb52d502f8422aa7b20cba5efa96a2a34d | 2022-12-07T06:13:42 | schema/cam_schema_1-1-3.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "CAM JSon schema",
"properties": {
"message": {
"properties": {
"basic_container": {
"properties": {
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"reference_position"
],
"type": "object"
},
"generation_delta_time": {
"description": "time of the reference position in the CAM, considered as time of the CAM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z. oneMilliSec(1)",
"examples": [
1,
1245
],
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"high_frequency_container": {
"description": "The basic vehicle container high frequency",
"properties": {
"acceleration_control": {
"description": "Current controlling mechanism for longitudinal movement of the vehicle. Represented as a bit string: brakePedalEngaged (0), gasPedalEngaged (1), emergencyBrakeEngaged (2), collisionWarningEngaged(3), accEngaged(4), cruiseControlEngaged(5), speedLimiterEngaged(6)",
"example": [
"0000000",
"1000000",
"0000011"
],
"maxLength": 7,
"minLength": 7,
"type": "string"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"description": "the high frequency container confidence fields. Note that no vehicle_width is defined",
"properties": {
"curvature": {
"description": "onePerMeter-0-00002 (0), onePerMeter-0-0001 (1), onePerMeter-0-0005 (2), onePerMeter-0-002 (3), onePerMeter-0-01 (4), onePerMeter-0-1 (5), outOfRange (6), unavailable (7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 4 (unavailable)",
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 8 (unavailable)",
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"curvature": {
"$comment": "if not provided, 'curvature' = 30001 (unavailable)",
"default": 1023,
"description": "straight(0), unavailable(1023)",
"maximum": 1023,
"minimum": -1023,
"type": "integer"
},
"curvature_calculation_mode": {
"$comment": "if not provided, 'curvature_calculation_mode' = 2 (unavailable)",
"default": 2,
"description": "It describes whether the yaw rate is used to calculate the curvature: yawRateUsed(0), yawRateNotUsed(1), unavailable(2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"drive_direction": {
"$comment": "if not provided, 'drive_direction' = 2 (unavailable)",
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 3601 (unavailable)",
"default": 3601,
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"$comment": "if not provided, 'longitudinal_acceleration' = 161 (unavailable)",
"default": 161,
"description": "unit: 0.1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 16383 (unavailable)",
"default": 16383,
"description": "Unit 0.01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 1023 (unavailable)",
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"$comment": "if not provided, 'vehicle_width' = 62(unavailable)",
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 32767 (unavailable)",
"default": 32767,
"description": "Unit: 0.01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"type": "object"
},
"low_frequency_container": {
"description": "The basic vehicle container low frequency",
"properties": {
"exterior_lights": {
"description": "Status of the exterior light switches represented as a bit string: lowBeamHeadlightsOn (0), highBeamHeadlightsOn (1), leftTurnSignalOn (2), rightTurnSignalOn (3), daytimeRunningLightsOn (4), reverseLightOn (5), fogLightOn (6), parkingLightsOn (7)",
"example": [
"00000000",
"10011010",
"00000110"
],
"maxLength": 8,
"minLength": 8,
"type": "string"
},
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (generation_delta_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (reference_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
},
"vehicle_role": {
"$comment": "if not provided, 'vehicle_role' = 0 (default)",
"default": 0,
"description": "default(0), publicTransport(1), specialTransport(2), dangerousGoods(3), roadWork(4), rescue(5), emergency(6), safetyCar(7), agriculture(8),commercial(9),military(10),roadOperator(11),taxi(12), reserved1(13), reserved2(14), reserved3(15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"exterior_lights",
"path_history"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"generation_delta_time",
"basic_container",
"high_frequency_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "identifier",
"examples": [
"UNKNOWN",
"42"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cam",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.3",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | f00df20ae66e54d3e9890ceb44043f60fdb08b2b | 2022-01-24T17:06:41 | schema/denm_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"path": {
"description": "List of ordered elements root source of the message",
"items": {
"properties": {
"message_type": {
"description": "root message type source of the element",
"enum": [
"denm",
"cam",
"cpm",
"po"
]
},
"position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
}
},
"required": [
"position",
"message_type"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "denm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | f32de795e87eeacd651bba63a3d0e21e9f97f541 | 2021-09-16T13:38:51 | schema/cpm_schema_1-0-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"generation_delta_time": {
"description": "Unit: millisecond. Time of the reference position in the CPM, considered as time of the CPM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"description": "Unit: 0.1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"description": "Unit: 1 cm. oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"description": "Station type of the originating ITS-S. unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"message_id": {
"description": "Type of ITS message",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"number_of_perceived_objects": {
"description": "The number of perceived objects by the transmitting ITS-S. This number does not have to match up with the number of objects included in the transmitted message due to the object inclusion scheme. ",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"perceived_object_container": {
"description": "List of information for individual perceived object",
"items": {
"properties": {
"distance": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance value to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"distance_confidence": {
"properties": {
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in x-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the ITS-S's reference point in y-direction at the time of measurement; zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_distance",
"y_distance"
],
"type": "object"
},
"object_confidence": {
"default": 0,
"description": "The confidence associated to the object; unknown(0), onePercent(1), oneHundredPercent(100),unavailable(101)",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object relative to which the measurement data is provided. In case no object reference - point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"speed": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in x-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed value of detected object from the ITS-S's reference point in y-direction at the time of measurement; standstill(0), oneCentimeterPerSec(1),unavailable(16383)",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"speed_confidence": {
"properties": {
"x_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in x-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed confidence of detected object from the ITS-S's reference point in y-direction at the time of measurement; equalOrWithinOneCentimeterPerSec(1),equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"required": [
"x_speed",
"y_speed"
],
"type": "object"
},
"time_of_measurement": {
"description": "Unit: milliseconds. Time difference from the message's generation delta time to the time of the measurement of the object",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"object_confidence",
"distance",
"distance_confidence",
"speed",
"speed_confidence",
"object_ref_point"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"protocol_version": {
"description": "Version of the ITS message and/or communication protocol",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"detection_area": {
"properties": {
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to the horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal OpeningAngle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontalOpeningAngleStart to horizontalOpeningAngleEnd in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10)",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical OpeningAngle extension. This is an optional DE. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontalOpeningAngle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the refPointID. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100)",
"maximum": 0,
"minimum": -5000,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the refPointID. zeroPointZeroOneMeter(1), oneMeter(100). zeroPointZeroOneMeter(1), oneMeter(100)",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the refPointID",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ref_point_id",
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"properties": {
"intersection_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"road_regulator_id": {
"description": "Road regulator id. When is present the intersection_id is guaranteed to be globally unique.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"intersection_id"
],
"type": "object"
},
"road_segment_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement of the originating ITS-S with regards to the true north; equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy of the originating ITS-S; equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement of the originating ITS-S with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed of the originating ITS-S; standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "Identifier for an ITS-S",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"message_id",
"generation_delta_time",
"management_container",
"number_of_perceived_objects"
],
"type": "object"
},
"origin": {
"description": "The entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "Identifier",
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"cpm"
]
},
"version": {
"default": "1.0.0",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 334d7466887fcf64cbc92924c19b7a2a9eb8cedf | 2023-01-30T10:09:18 | schema/information_schema_1-2-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"central_instance_id": {
"description": "unique id all other the world for the central server if the instance is of type edge",
"type": "string"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"instance_type": {
"description": "type of instance",
"enum": [
"local",
"edge",
"central"
],
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.2.0",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"instance_type",
"running",
"timestamp",
"validity_duration"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 4e6a1bfdb36258ed2a38b7b6ef56f4e02cea6f52 | 2022-12-06T14:07:42 | schema/status_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"genericTimeSource": {
"properties": {
"error": {
"description": "estimated error in seconds, with arbitrary sub-second precision",
"type": "number"
},
"offset": {
"description": "measured offset in seconds, with arbitrary sub-second precision",
"type": "number"
},
"state": {
"description": "state of the source",
"enum": [
"best",
"combined",
"not_combined",
"maybe_error",
"unstable",
"unusable"
],
"type": "string"
},
"stratum": {
"description": "stratum of the clock source",
"minimum": 0,
"type": "integer"
},
"type": {
"description": "type of the time source",
"enum": [
"ntp",
"pps",
"nmea"
],
"type": "string"
}
},
"required": [
"type",
"stratum",
"state",
"offset",
"error"
],
"type": "object"
},
"nmeaTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"stratum": {
"const": 0
},
"type": {
"const": "nmea"
}
},
"type": "object"
}
],
"type": "object"
},
"ntpTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"host": {
"description": "IP or hostname of the NTP server",
"type": "string"
},
"stratum": {
"minimum": 1
},
"type": {
"const": "ntp"
}
},
"required": [
"host"
],
"type": "object"
}
],
"type": "object"
},
"ppsTimeSource": {
"allOf": [
{
"$ref": "#/$defs/genericTimeSource"
},
{
"properties": {
"label": {
"description": "PPS label/name",
"type": "string"
},
"stratum": {
"const": 0
},
"type": {
"const": "pps"
}
},
"required": [
"label"
],
"type": "object"
}
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/status",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Status JSON schema",
"properties": {
"cellular": {
"description": "cellular connections",
"items": {
"description": "cellular connection status",
"properties": {
"connection": {
"description": "connection details",
"properties": {
"signal": {
"description": "signal quality metrics",
"properties": {
"ecio": {
"type": "number"
},
"io": {
"type": "number"
},
"rscp": {
"type": "number"
},
"rsrp": {
"type": "number"
},
"rsrq": {
"type": "number"
},
"rssi": {
"type": "number"
},
"sinr": {
"type": "number"
},
"snr": {
"type": "number"
}
},
"type": "object"
},
"technology": {
"examples": [
"gsm",
"cdma1x",
"evdo",
"umts",
"lte",
"5G"
],
"type": "string"
}
},
"type": "object"
},
"hardware": {
"description": "hardware information",
"properties": {
"model": {
"type": "string"
},
"revision": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"type": "object"
},
"operator": {
"description": "cellular operator",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"hardware"
],
"type": "object"
},
"type": "array"
},
"gnss": {
"$comment": "modelled after the gpsd protocol; references like {gpsd:XXX:YYY[:ZZZ...]} refer to gpsd object XXX, field YYY (sub-field ZZZ, etc...) as defined in the gpsd JSON protocol documentation: https://gpsd.io/gpsd_json.html",
"description": "status of the GNSS subsystem",
"properties": {
"mode": {
"$comment": "0: unkown; 1: none; 2: 2D-FIX; 3: 3D-FIX",
"description": "FIX mode {gpsd:TPV:mode}",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"model": {
"$comment": "concatenation of the three fields: {gpsd:DEVICE:driver}, {gpsd:DEVICE:subtype}, and {gpsd:DEVICE:subtype1}",
"description": "Brand and model of the GNSS device (free form)",
"type": "string"
},
"nSat": {
"description": "Number of satellites seen {gpsd:SKY:nSat}",
"minimum": 1,
"type": "integer"
},
"rate": {
"$comment": "seconds with arbitrary sub-second precision",
"description": "mesaurement rate {gpsd:DEVICE:cycle}",
"exclusiveMinimum": 0.0,
"type": "number"
},
"software": {
"$comment": "typically: literal 'gpsd' followed by {gpsd:VERSION:release}",
"description": "name and version of the gnss daemon (free form)",
"type": "string"
},
"status": {
"$comment": "2: DGPS; 3: RTK-fixed; 4: RTK-floating",
"description": "FIX status {gpsd:TPV:status}",
"enum": [
2,
3,
4
],
"type": "integer"
},
"uSat": {
"description": "Number of satellites used in navigation solution {gpsd:SKY:uSat}",
"minimum": 1,
"type": "integer"
}
},
"required": [
"software",
"model",
"mode"
],
"type": "object"
},
"id": {
"description": "unique id all over the world for this device",
"type": "string"
},
"system": {
"additionalProperties": true,
"description": "system low-level info",
"properties": {
"cpu_load": {
"description": "CPU load, as a 3-tuple: [1min_load, 5min_load, 15min_load]",
"items": {
"minimum": 0.0,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"hardware": {
"description": "type of hardware",
"examples": [
"vtc6221",
"vtc7251",
"rpi2"
],
"type": "string"
},
"memory": {
"description": "RAM usage, in bytes, as a 2-tuple: [total_ram, available_ram]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"os_release": {
"$comment": "all keys of os-release are optional; see https://www.freedesktop.org/software/systemd/man/os-release.html",
"additionalProperties": true,
"description": "a key-value representation of the os-release of the running OS",
"properties": {
"ID": {
"type": "string"
},
"NAME": {
"type": "string"
},
"PRETTY_NAME": {
"type": "string"
},
"VERSION": {
"type": "string"
},
"VERSION_ID": {
"type": "string"
}
},
"type": "object"
},
"storage": {
"description": "writable storage for data, as a 2-tuple: [total_space, free_space]",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"description": "type of device",
"enum": [
"obu",
"other"
],
"type": "string"
}
},
"required": [
"type",
"hardware",
"os_release",
"memory",
"storage",
"cpu_load"
],
"type": "object"
},
"time_sources": {
"description": "status of time-keeping services",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ntpTimeSource"
},
{
"$ref": "#/$defs/ppsTimeSource"
},
{
"$ref": "#/$defs/nmeaTimeSource"
}
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "date the information was generated, in seconds since 1970-01-01 00:00:00 +00:00, with arbitrary sub-second precision",
"minimum": 0.0,
"type": "number"
},
"type": {
"const": "status",
"description": "type of the message",
"type": "string"
},
"version": {
"const": "1.1.0",
"description": "version of the format of this JSON message",
"type": "string"
}
},
"required": [
"version",
"id",
"type",
"timestamp",
"system",
"time_sources",
"cellular",
"gnss"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 9e2810cdc1ff750cf4ada9ff72f9dc37ec8c09f8 | 2022-01-19T13:16:47 | schema/information_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/info",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Information JSon schema",
"properties": {
"cells_id": {
"description": "list of cell id of the server",
"items": {
"description": "cell id",
"type": "integer"
},
"type": "array"
},
"central_instance_id": {
"description": "unique id all other the world for the central server if the instance is of type edge",
"type": "string"
},
"domain_name_servers": {
"description": "list of Domain Name Server",
"items": {
"description": "Domain Name Server",
"examples": [
"1.1.1.1",
"194.28.10.20"
],
"type": "string"
},
"type": "array"
},
"fbeat_loggers": {
"description": "list of Filebeat server and port separated by a colon",
"items": {
"description": "Filebeat server and port (classically 2203) separated by a colon",
"examples": [
"90.11.41.133:2203",
"81.16.11.164:12203"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"gelf_loggers": {
"description": "list of Graylog Extended Log Format server and port separated by a colon",
"items": {
"description": "Graylog Extended Log Format server and port (classically 2201) separated by a colon",
"examples": [
"90.11.41.133:2201",
"81.169.166.64:12201"
],
"type": "string"
},
"type": "array"
},
"http_proxy": {
"description": "list of HTTP IP address and port separated by a colon",
"items": {
"description": "HTTP IP address and port (classically 8080) separated by a colon",
"examples": [
"84.188.43.159:8080",
"172.116.82.124:1280"
],
"type": "string"
},
"type": "array"
},
"instance_id": {
"description": "unique id all other the world for a server",
"type": "string"
},
"instance_type": {
"description": "type of instance",
"enum": [
"edge",
"central"
],
"type": "string"
},
"mqtt_ip": {
"description": "list of MQTT IP address and port separated by a colon",
"items": {
"description": "MQTT IP address and port (classically 1883) separated by a colon",
"examples": [
"84.188.43.159:1883",
"172.116.12.182:11883"
],
"type": "string"
},
"type": "array"
},
"mqtt_tls_ip": {
"description": "list of MQTT IP address and TLS port separated by a colon",
"items": {
"description": "MQTT IP address and TLS port (classically 8883) separated by a colon",
"examples": [
"84.188.43.159:8883",
"172.116.82.124:18883"
],
"type": "string"
},
"type": "array"
},
"ntp_servers": {
"description": "list of Network Time Protocol server",
"items": {
"description": "Network Time Protocol server",
"examples": [
"ntp-sop.inria.fr",
"0.debian.pool.ntp.org",
"1.pool.ntp.org"
],
"type": "string"
},
"type": "array"
},
"public_ip_address": {
"description": "list of public IP address",
"examples": [
"161.05.21.166",
"190.14.19.50",
"127.0.0.1"
],
"items": {
"description": "public IP address",
"type": "string"
},
"type": "array"
},
"running": {
"default": false,
"description": "state of the server: true id running, false else.",
"type": "boolean"
},
"service_area": {
"description": "handled service area of the server",
"properties": {
"coordinates": {
"description": "coordinates of the point",
"items": {
"description": "coordinate of the point",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"quadkeys": {
"description": "list of quadkey of the tiles",
"items": {
"description": "quadkey",
"examples": [
"12020322313211",
"12020322313213",
"1203"
],
"type": "string"
},
"type": "array"
},
"radius": {
"default": 0,
"description": "radius of the point",
"type": "integer"
},
"type": {
"description": "type of service area",
"enum": [
"point",
"polygon",
"tiles"
],
"type": "string"
},
"vertices": {
"description": "vertices (corners) of the polygon",
"items": {
"coordinates": {
"description": "coordinates for a vertex (corner) of the polygon",
"items": {
"description": "coordinate",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"minItems": 3,
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"timestamp": {
"description": "generation timestamp of the information, millisecond since epoch (1970/01/01)",
"type": "integer"
},
"type": {
"description": "type of server",
"enum": [
"broker"
],
"type": "string"
},
"udp_loggers": {
"description": "list of User Datagram Protocol server and port separated by a colon",
"items": {
"description": "User Datagram Protocol server and port (classically 2202) separated by a colon",
"examples": [
"90.11.41.133:2202",
"81.169.166.64:12202"
],
"type": "string"
},
"type": "array"
},
"validity_duration": {
"description": "validity period of the information relatively to the timestamp in seconds",
"type": "integer"
},
"version": {
"const": "1.1.0",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"version",
"instance_id",
"instance_type",
"running",
"timestamp",
"validity_duration"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/cpm_schema_1-1-3.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$defs": {
"area_circular": {
"description": "a circular area. The circle is centred about the reference point or about the nodeCenterPoint (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset"
},
"radius": {
"description": "Unit: 0.1 meter. The radius of the circular area. zeroPointZeroOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"radius"
],
"type": "object"
},
"area_ellipse": {
"description": "An elliptical area. The ellipse is centred about the reference point or about the node center point (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset",
"description": "Offset point about which the ellipse is centred with respect to the reference position."
},
"semi_height": {
"description": "Unit: 0.1 meter. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_length": {
"description": "Unit: 0.1 meter. Major radius of the ellipse. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_orientation": {
"description": "Unit: 0.1 degrees. Orientation of the semi major range length of the ellipse in the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_range_length": {
"description": "Unit: 0.1 meter. Minor radius of the ellipse. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_range_length",
"semi_minor_range_length",
"semi_major_range_orientation"
],
"type": "object"
},
"area_polygon": {
"description": "Polygonal area constructed by connecting the offset points in the sequence provided. The last point shall be connected with the first point to close the polygon.",
"items": {
"$ref": "#/$defs/offset"
},
"maxItems": 16,
"minItems": 3,
"type": "array"
},
"area_rectangle": {
"description": "A rectangular area. The rectangle is centred about the reference point or about the node center point (if provided).",
"properties": {
"node_center_point": {
"$ref": "#/$defs/offset",
"description": "Offset point about which the rectangle is centred with respect to the reference position."
},
"semi_height": {
"description": "Unit: 0.1 meter. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_length": {
"description": "Unit: 0.1 meter. Half length of the rectangle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"semi_major_range_orientation": {
"description": "Unit: 0.1 degrees.Orientation of the semi major range length of the rectangle in the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_range_length": {
"description": "Unit: 0.1 meter. Half width of the rectangle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_range_length",
"semi_minor_range_length",
"semi_major_range_orientation"
],
"type": "object"
},
"offset": {
"additionalProperties": false,
"description": "Offset JSon schema. Describes an offset position in a two- or three-dimensional plane.",
"properties": {
"x": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"y": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"z": {
"description": "node is within 327.67m of last node",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}
},
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cpm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "CPM JSon schema",
"properties": {
"message": {
"properties": {
"free_space_addendum_container": {
"description": "List of information for individual perceived object",
"items": {
"description": "This container shall only be added if the confidence indication needs to be altered with respect to the isotropic @see FreeSpace Confidence confidence level indication provided in the Sensor Information.",
"properties": {
"free_space_area": {
"description": "free space area for which the free space confidence of this addendum container is valid. The described area that is considered as not occupied by any traffic participant or obstacle.",
"oneOf": [
{
"required": [
"free_space_polygon"
]
},
{
"required": [
"free_space_circular"
]
},
{
"required": [
"free_space_ellipse"
]
},
{
"required": [
"free_space_rectangle"
]
}
],
"properties": {
"free_space_circular": {
"$ref": "#/$defs/area_circular"
},
"free_space_ellipse": {
"$ref": "#/$defs/area_ellipse"
},
"free_space_polygon": {
"$ref": "#/$defs/area_polygon"
},
"free_space_rectangle": {
"$ref": "#/$defs/area_rectangle"
}
},
"type": "object"
},
"free_space_confidence": {
"description": "Isotropic free space confidence that applies to the entire area as defined in the free space area of a particular free space addendum container. Confidence indicating that an area is not occupied by a traffic participant or obstacle. unknown(0) if the free space confidence is unknown for the described area, onePercent(1), oneHundredPercent(100), unavailable(101) if the confidence could not be computed and does not apply.",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"sensor_id_list": {
"description": "list of pseudonym sensor id which performed the measurement to indicate the free space.",
"items": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"shadowing_applies": {
"default": true,
"description": "if simple shadowing mechanism applies within the area described by the free space area.",
"type": "boolean"
}
},
"requires": [
"free_space_area",
"free_space_confidence"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"generation_delta_time": {
"description": "time of the reference position in the CAM, considered as time of the CAM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z. oneMilliSec(1).",
"examples": [
1,
1245
],
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"management_container": {
"properties": {
"confidence": {
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable).",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable).",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable).",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable).",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"required": [
"semi_major_confidence",
"semi_minor_confidence",
"semi_major_orientation"
],
"type": "object"
}
},
"required": [
"position_confidence_ellipse",
"altitude"
],
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001).",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeNorth(10), oneMicrodegreeSouth(-10), unavailable(900000001).",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0.1 microdegree. oneMicrodegreeEast(10), oneMicrodegreeWest(-10), unavailable(1800000001).",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown).",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15).",
"maximum": 254,
"minimum": 0,
"type": "integer"
}
},
"required": [
"station_type",
"reference_position",
"confidence"
],
"type": "object"
},
"perceived_object_container": {
"confidence": {
"longitudinal_lane_position": {
"description": "Unit: 0.01 m. Absolute accuracy of longitudinal lane position measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101) shall be set if the accuracy is out of range, unavailable(102) shall be set if the accuracy data is unavailable",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"object": {
"description": "The confidence associated to the object. The computation of the object confidence is based on a sensor's or, fusion system's specific detection confidence, the binary detection success that is, if an object has been successfully detected by the last measurement and the object age. A single-value indication about the overall information quality of a perceived object. Its computation is based on several scaling factors and moving averages. noConfidence(0) no confidence in detected object, e.g. for ghost-objects or if confidence could not be computed, fullConfidence(15) full confidence in detected object",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"pitch_acceleration": {
"description": "Pitch acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0,01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0,1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"pitch_angle": {
"description": "Pitch angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"pitch_rate": {
"description": "Pitch rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0,01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0,1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_1": {
"description": "Unit: 0.01 m. Accuracy of first provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_2": {
"description": "Unit: 0.01 m. Accuracy of second provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"required": [
"x_distance",
"y_distance",
"x_speed",
"y_speed",
"object_age"
],
"roll_acceleration": {
"description": "Roll acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0,01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0,1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"roll_angle": {
"description": "Roll angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"roll_rate": {
"description": "Roll rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0,01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0,1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"vertical_object_dimension": {
"description": "Unit: 0.01 m. Accuracy of vertical provided dimension value with a predefined confidence level (e.g. 95%). zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"x_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in x-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"x_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in x-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"x_speed": {
"description": "Speed confidence of detected object from the reference point in x-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"y_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in y-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in y-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"y_speed": {
"description": "Speed confidence of detected object from the reference point in y-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"yaw_acceleration": {
"description": "Yaw acceleration confidence.The absolute accuracy of a reported angular acceleration value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSecSquared-000-01(0) if the accuracy is equal to or less than 0,01 degree/second^2, degSecSquared-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second^2, degSecSquared-000-10(2) if the accuracy is equal to or less than 0,1 degree/second^2, degSecSquared-001-00(3) if the accuracy is equal to or less than 1 degree/second^2, degSecSquared-005-00(4) if the accuracy is equal to or less than 5 degrees/second^2, degSecSquared-010-00(5) if the accuracy is equal to or less than 10 degrees/second^2, degSecSquared-100-00(6) if the accuracy is equal to or less than 100 degrees/second^2, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second^2, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"yaw_angle": {
"description": "Yaw angle confidence. The absolute accuracy of a reported angle value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. zeroPointOneDegree(1), oneDegree(10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"yaw_rate": {
"description": "Yaw rate confidence. The absolute accuracy of a reported angular speed value for a predefined confidence level (e.g. 95 %). The required confidence level is defined by the corresponding standards. For correlation computation, maximum interval levels shall be assumed. degSec-000-01(0) if the accuracy is equal to or less than 0,01 degree/second, degSec-000-05(1) if the accuracy is equal to or less than 0,05 degrees/second, degSec-000-10(2) if the accuracy is equal to or less than 0,1 degree/second, degSec-001-00(3) if the accuracy is equal to or less than 1 degree/second, degSec-005-00(4) if the accuracy is equal to or less than 5 degrees/second, degSec-010-00(5) if the accuracy is equal to or less than 10 degrees/second, degSec-100-00(6) if the accuracy is equal to or less than 100 degrees/second, outOfRange(7) if the accuracy is out of range, i.e. greater than 100 degrees/second, unavailable(8) if the accuracy information is unavailable",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"z_acceleration": {
"description": "Acceleration confidence of detected object from the reference point in z-direction at the time of measurement. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"z_distance": {
"description": "Unit: 0.01 meter. Distance confidence to detected object from the reference point in z-direction at the time of measurement. Absolute accuracy of measurement to a confidence level of 95%. zeroPointZeroOneMeter(1), oneMeter(100), outOfRange(4094), unavailable(4095).",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"z_speed": {
"description": "Speed confidence of detected object from the reference point in z-direction at the time of measurement. unavailable(0) Not Equipped or unavailable, prec100ms(1) 100 meters / sec, prec10ms(2) 10 meters / sec, prec5ms(3) 5 meters / sec, prec1ms(4) 1 meters / sec, prec0-1ms(5) 0.1 meters / sec, prec0-05ms(6) 0.05 meters / sec, prec0-01ms(7) 0.01 meters / sec",
"maximum": 7,
"minimum": 0,
"type": "integer"
}
},
"description": "List of information for individual perceived object. The total number of detected objects by the station at the time of generating the message. Due to the dynamic message generation rules, this number does not have to reflect the number of objects included in this message but states the number of objects known to the sender at the time of generating the message.",
"items": {
"properties": {
"classification": {
"description": "Provides the classification of the described object. Multi-dimensional classification may be provided.",
"items": {
"confidence": {
"description": "Describes the confidence value for the type of a detected object. unknown(0) in case the confidence value is unknown but the reported classification is still valid, onePercent(1), oneHundredPercent(100), unavailable(101) in case the class confidence value computation is not available for this object, indicates that the class assignment is invalid",
"maximum": 101,
"minimum": 0,
"type": "integer"
},
"properties": {
"object_class": {
"description": "The class that best describes the detected object. The object can be classified into one of three main categories: vehicle, VRU and other.",
"oneOf": [
{
"required": [
"vehicle"
]
},
{
"required": [
"single_vru"
]
},
{
"required": [
"vru_group"
]
},
{
"required": [
"other"
]
}
],
"properties": {
"single_vru": {
"oneOf": [
{
"required": [
"pedestrian"
]
},
{
"required": [
"bicyclist"
]
},
{
"required": [
"motorcylist"
]
},
{
"required": [
"animal"
]
}
],
"other": {
"description": "Detected object for class other. unknown(0), roadSideUnit(1).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"properties": {
"animal": {
"description": "unavailable(0), wild-animal(1), farm-animal(2), service-animal(3), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"bicyclist": {
"description": "unavailable(0), bicyclist(1), wheelchair-user(2), horse-and-rider(3), rollerskater(4), e-scooter(5), personal-transporter(6), pedelec(7), speed-pedelec(8), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"motorcylist": {
"description": "unavailable(0), moped(1), motorcycle(2), motorcycle-and-sidecar-right(3), motorcycle-and-sidecar-left(4), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"pedestrian": {
"description": "unavailable(0), ordinary-pedestrian(1), road-worker(2), first-responder(3), max(15).",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"vru_group": {
"description": "group of VRUs",
"properties": {
"cluster_id": {
"description": "If the group is associated to a VRU cluster, this element indicates the ID of the associated cluster. The ClusterId can only be assigned if a VRU cluster which is transmitting VAMs has been detected.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"group_type": {
"group_size": {
"description": "Indicates an estimation of the number of VRUs in the group. unavailable(0), onlyLeader(1).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"properties": {
"animal": {
"type": "boolean"
},
"bicyclist": {
"type": "boolean"
},
"motorcyclist": {
"type": "boolean"
},
"pedestrian": {
"type": "boolean"
}
},
"required": [
"pedestrian",
"bicyclist",
"motorcyclist",
"animal"
],
"type": "object"
}
},
"required": [
"group_type",
"group_size"
],
"type": "object"
}
},
"vehicle": {
"description": "Describes the subclass of a detected object for class vehicle. unknown(0) the type of vehicle is unknown, passengerCar(1) the detected object is a small passenger car, bus(2) the detected object is a large passenger vehicle, lightTruck(3) the detected object is a light goods vehicle, heavyTruck(4) the detected object is a heavy goods vehicle, trailer(5) the detected object is an unpowered vehicle that is intended to be towed by a powered vehicle, specialVehicles(6) the detected object is a vehicle which has a special purpose other than the above (e.g. moving road works vehicle), tram(7) the detected object is a vehicle running on tracks along public streets, emergencyVehicle(8) the detected object is a vehicle used in an emergency situation, such as an ambulance, police car or fire engine, agricultural(9) the detected object is a vehicle used for agricultural purposes.",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"object_class",
"confidence"
],
"type": "object"
},
"maxItems": 8,
"minItems": 1,
"type": "array"
},
"dynamic_status": {
"description": "Indicated the dynamic capabilities of a detected object. Indication whether the detected object is classified as a dynamic (i.e. moving) object. This value indicates whether an object has the general capability to move, i.e. change its position. dynamic(0) the object is moving, hasBeenDynamic(1) indicates whether an object has been dynamic before, e.g., a car stopping at a traffic light, static(2) shall be used in case an object is identified to be not moving throughout any previous observation",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"lower_triangular_correlation_matrix_columns": {
"description": "Provides the columns of a lower triangular positive semi definite correlation matrix for the kinematic state and attitude space provided for this object. The order of the columns and rows of the correlation matrix is as follows: x_distance , y_distance , z_distance , x_speed , y_speed , z_speed , x_acceleration , y_acceleration , z_acceleration , roll_angle , pitch_angle , yaw_angle , roll_rate , pitch_rate , yaw_rate , roll_acceleration , pitch_acceleration , yaw_acceleration The number of lower_triangular_correlation_matrix_columns to be included k is thereby the number of provided values n of the kinematic state and attitude space minus 1: k = n-1. Each column i of the lower_triangular_correlation_matrix_columns contains k-(i-1) values. In case certain values of the kinematic state and attitude space are not provided, they are omitted from the lower_triangular_correlation_matrix_columns. A general data frame to express the elements of a lower triangular positive semi-definite matrix, not including the main diagonal elements of the matrix. Given a matrix A of size n x n, the number of columns to be included in the lower triangular matrix is k=n-1.",
"items": {
"description": "The column of the lower triangular positive semi-definite matrix consists of correlation row values. Given a matrix A of size n x n, the number of columns to be included in the lower triangular matrix is k=n-1. Each column i of the lower triangular then contains k-(i-1) values, where i refers to the column number count starting at 1 from the left.",
"items": {
"description": "The Bravais-Pearson correlation value for each cell of the lower triangular correlation matrix. Scaled by 100. full-negative-correlation(-100) full negative correlation, no-correlation(0) if not correlated or unavailable, point-one(10), full-positive-correlation(100) full positive correlation",
"maximum": 100,
"minimum": -100,
"type": "integer"
},
"maxItems": 17,
"minItems": 1,
"type": "array"
},
"maxItems": 17,
"minItems": 1,
"type": "array"
},
"matched_position": {
"description": "Unit: . The map-matched position of an object. This requires that a MAP-message is provided. Conveys an assigned index that is unique within the intersection.",
"properties": {
"lane_id": {
"description": "Conveys an assigned index that is unique within the intersection.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"longitudinal_lane_position": {
"description": "Unit: 0.1 meter. Indicates the longitudinal offset of the map-matched position of a particular object along the matched lane, beginning from the lane\u2019s starting point. zeroPointOneMeter(1).",
"maximum": 32767,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"object_age": {
"description": "Unit: 1 ms. Provides the age of the detected and described object. Age of object in milliseconds, i.e. for how long the object has been observed by the disseminating station. oneMiliSec(1), moreThan1Point5Second(1500).",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"object_id": {
"description": "Identifier assigned to a detected object which remains constant as long as the object is perceived. Numbers are assigned in an increasing round-robin fashion. When the last identifier in the allowed range has been used, the first counter for the identifier starts from the beginning of the range again.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"object_ref_point": {
"default": 0,
"description": "The reference point on the perceived object. The kinematic attitude and state data provided for this object are valid for this reference point of the object. In case no object reference point can be determined, it is assumed to be the center point of the detected object. {mid(0), bottomLeft(1), midLeft(2), topLeft(3), bottomMid(4), topMid(5), bottomRight(6), midRight(7), topRight(8).",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"pitch_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Pitch acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"pitch_angle": {
"description": "Unit: 0.1 degrees. Pitch angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the y-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"pitch_rate": {
"description": "Unit: 0.01 degrees/s. Pitch rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"planar_object_dimension_1": {
"description": "Unit: 0.1 m. First dimension of object as provided by the sensor or environment model. This dimension is always contained in the plane which is oriented perpendicular to the direction of the angle indicated by the yawAngle and which contains the object's reference point. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"planar_object_dimension_2": {
"description": "Unit: 0.1 m. Second dimension of the object as provided by the sensor environment model. This dimension is contained in the plane oriented in the direction of the angle indicated by the yawAngle and the object's reference point. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"roll_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Roll acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"roll_angle": {
"description": "Unit: 0.1 degrees. Roll angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"roll_rate": {
"description": "Unit: 0.01 degrees/s. Roll rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"sensor_id_list": {
"description": "List of sensor-IDs which provided the measurement data.",
"items": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"time_of_measurement": {
"description": "Unit: 1 millisecond. Time difference from the message\u2019s generation delta time to the time of the measurement of the object.",
"maximum": 1500,
"minimum": -1500,
"type": "integer"
},
"vertical_object_dimension": {
"description": "Unit: 0.1 m. Vertical dimension of object as provided by the sensor or object model. A dimension for an object. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 1023,
"minimum": 0,
"type": "integer"
},
"x_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in x-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"x_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in x-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"x_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in x-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"y_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in y-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"y_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in y-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"y_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in y-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
},
"yaw_acceleration": {
"description": "Unit: 0.01 degrees/s^2 (degrees per second squared). Yaw acceleration of object from the reference point. For a vehicle, the angular acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular acceleration is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular acceleration value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noAcceleration(0), oneDegreePerSecondSquaredAntiClockwise(100), oneDegreePerSecondSquaredClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"yaw_angle": {
"description": "Unit: 0.1 degrees. Yaw angle of object from the reference point. For a vehicle, the angle is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angle is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angle is measured with positive values considering the object orientation turning counter-clockwise around the z-axis. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"description": "Unit: 0.01 degrees/s. Yaw rate of object from the reference point. For a vehicle, the angular rate is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the angular rate is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z- axis to the vertical direction. The angular rate is measured with positive values considering the object orientation turning counter-clockwise around the x-axis. An angular speed value described in a local Cartesian coordinate system, counted positive in a right-hand local coordinate system from the abscissa. noSpeed(0), oneDegreePerSecondAntiClockwise(100), oneDegreePerSecondClockwise(-100).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
},
"z_acceleration": {
"description": "Unit: 0.1 m/s2. Acceleration of the detected object from the reference point in z-direction for the time of measurement. For a vehicle, the acceleration is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the acceleration is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direct. pointOneMeterPerSecSquared(1), minusPointOneMeterPerSecSquared(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"z_distance": {
"description": "Unit: 0.01 meter. Distance to detected object from the reference point in z-direction for the time of measurement. For a vehicle, the distance is reported in a body-fixed coordinate system as provided by ISO 8855. For a RSU, the distance is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 132767,
"minimum": -132768,
"type": "integer"
},
"z_speed": {
"description": "Unit: 0.01 m/s. Speed of the detected object in the detecting reference system in z-direction for the time of measurement (i.e. speed of the object relative to the origin of the station\u2019s reference system). For a vehicle, the speed is reported in a body-fixed coordinate system as provided by ISO 8855 originating at the station\u2019s reference point. For a RSU, the speed is reported in a coordinate system in which the y-axis corresponds to the North direction, the x-axis to the East direction, and the z-axis to the vertical direction. negativeSpeedMaximum(-16383), standstill(0), oneCentimeterPerSec(1), speedMaximum(16382), unavailable(16383).",
"maximum": 16383,
"minimum": -16383,
"type": "integer"
}
},
"required": [
"object_id",
"time_of_measurement",
"x_distance",
"y_distance",
"x_speed",
"y_speed",
"object_age",
"confidence"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"protocol_version": {
"description": "version of the message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sensor_information_container": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside.",
"items": {
"properties": {
"detection_area": {
"properties": {
"stationary_sensor_circular": {
"$ref": "#/$defs/area_circular"
},
"stationary_sensor_ellipse": {
"$ref": "#/$defs/area_ellipse"
},
"stationary_sensor_polygon": {
"$ref": "#/$defs/area_polygon"
},
"stationary_sensor_radial": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. The orientation indicating the end of the stationary sensor\u2019s horizontal opening angle in positive angular direction with respect to the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable (3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. The orientation indicating the start of the stationary sensor\u2019s horizontal opening angle in positive angular direction with respect to the WGS84 coordinate system. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable (3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. The radial range of the sensor from the reference point or sensor point offset. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sensor_position_offset": {
"$ref": "#/$defs/offset",
"description": "The offset of the mounting point of this sensor from the station's reference position."
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. The orientation indicating the end of the stationary sensor\u2019s vertical opening angle in positive angular direction of a Cartesian coordinate system with its x-axis located in the north-east plane of the WGS84 coordinate system. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. The orientation indicating the start of the stationary sensor\u2019s vertical opening angle in positive angular direction of a Cartesian coordinate system with its x-axis located in the north-east plane of the WGS84 coordinate system. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"stationary_sensor_rectangle": {
"$ref": "#/$defs/area_rectangle"
},
"vehicle_sensor": {
"properties": {
"ref_point_id": {
"default": 0,
"description": "Increasing counter of the trailer reference point (corresponding to the hitch point).",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"vehicle_sensor_property_list": {
"description": "List of information for individual sensor(s) which are mounted to a a vehicle or roadside.",
"items": {
"properties": {
"horizontal_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's horizontal opening angle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontal opening angle start to horizontal opening angle end in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"horizontal_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's horizontal opening angle extension relative to the body of the vehicle. The value is provided with respect to a body-fixed coordinate system according to the ISO 8855 [i.2] specification with angles counted positive in the counter-clockwise direction starting from the X-axis. The opening angle always extends from the horizontal opening angle start to horizontal opening angle end in counter-clockwise direction. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"range": {
"description": "Unit: 0.1 meter. Range of sensor within the indicated azimuth angle defined by the start and end opening angle. zeroPointOneMeter(1), oneMeter(10).",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_end": {
"description": "Unit: 0.1 degrees. End of the sensor's vertical opening angle extension. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The X-axis of the sensor's coordinate system points in the direction of half of the horizontal opening angle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"vertical_opening_angle_start": {
"description": "Unit: 0.1 degrees. Start of the sensor's vertical opening angle extension. The angle refers to a rotation about the y-axis of a sensor-specific coordinate system with its origin located at the location defined by the offset. The x-axis of the sensor's coordinate system points in the direction of half of the horizontal opening angle. zeroPointOneDegree(1), oneDegree(10), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
}
},
"required": [
"range",
"horizontal_opening_angle_start",
"horizontal_opening_angle_end"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"x_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in negative x-direction from Reference Point indicated by the ref point id. negativeZeroPointZeroOneMeter(-1), negativeOneMeter(-100), negativeOutOfRange(-3094), positiveOneMeter(100),positiveOutOfRange(1001).",
"maximum": 1001,
"minimum": -3094,
"type": "integer"
},
"y_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in y-direction from Reference Point indicated by the ref point id. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"z_sensor_offset": {
"description": "Unit: 0.01 meter. Mounting position of sensor in z-direction from Reference Point indicated by the ref point id. zeroPointZeroOneMeter(1), oneMeter(100).",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"x_sensor_offset",
"y_sensor_offset",
"vehicle_sensor_property_list"
],
"type": "object"
}
},
"type": "object"
},
"sensor_id": {
"description": "Sensor identifier",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of attached sensor. undefined(0), radar(1), lidar(2), monovideo(3), stereovision(4), nightvision(5), ultrasonic(6), pmd(7), fusion(8), inductionloop(9), sphericalCamera(10), itssaggregation(11).",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"sensor_id",
"type",
"detection_area"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"station_data_container": {
"oneOf": [
{
"required": [
"originating_vehicle_container"
]
},
{
"required": [
"originating_rsu_container"
]
}
],
"properties": {
"originating_rsu_container": {
"properties": {
"intersection_reference_id": {
"description": "Intersection id. Unique within that region.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"region": {
"description": "Road regulator id. When is present the intersection or road segment reference id is guaranteed to be globally unique.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"road_segment_reference_id": {
"description": "Road segment id. Unique within that region.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"originating_vehicle_container": {
"properties": {
"confidence": {
"properties": {
"heading": {
"description": "Unit: 0.1 degree. Heading accuracy of the vehicle movement with regards to the true north. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Speed accuracy. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127).",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4).",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102).",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8).",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"required": [
"heading",
"speed"
],
"type": "object"
},
"drive_direction": {
"default": 2,
"description": "forward (0), backward (1), unavailable (2).",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"description": "Unit: 0.1 degree. Heading of the vehicle movement with regards to the true north; wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601).",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"description": "Unit: 0.01 m/s. Driving speed. standstill(0), oneCentimeterPerSec(1), unavailable(16383).",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023).",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62).",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161).",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767).",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"required": [
"heading",
"speed",
"confidence"
],
"type": "object"
}
},
"type": "object"
},
"station_id": {
"description": "identifier",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"generation_delta_time",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "identifier",
"examples": [
"ora_car_42"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01).",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cpm",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.3",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 7772612b80acbc25c329c66f3a10b2ddd2c9d896 | 2022-11-22T14:07:14 | schema/denm_schema_1-1-0.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://tigroo31.github.io/its-client/schema/denm",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "DENM JSon schema",
"properties": {
"message": {
"properties": {
"alacarte_container": {
"properties": {
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"positioning_solution": {
"description": "noPositioningSolution(0), sGNSS(1), dGNSS(2), sGNSSplusDR(3), dGNSSplusDR(4), dR(5)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"location_container": {
"properties": {
"confidence": {
"properties": {
"event_position_heading": {
"description": "Unit: 0,1 degree. equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"event_speed": {
"description": "Unit: 0.01 m/s. equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"event_position_heading": {
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"event_speed": {
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"road_type": {
"description": "Type of a road segment. urban-NoStructuralSeparationToOppositeLanes(0), urban-WithStructuralSeparationToOppositeLanes(1), nonUrban-NoStructuralSeparationToOppositeLanes(2), nonUrban-WithStructuralSeparationToOppositeLanes(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"traces": {
"description": "the traces, 1 or more path history",
"items": {
"properties": {
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (reference_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (event_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
}
},
"required": [
"path_history"
],
"type": "object"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
}
},
"required": [
"traces"
],
"type": "object"
},
"management_container": {
"properties": {
"action_id": {
"properties": {
"originating_station_id": {
"description": "identifier of an its station",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sequence_number": {
"description": "The sequence number is set each time a new DENM is created. It is used to differentiate from events detected by the same ITS-S.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"originating_station_id",
"sequence_number"
],
"type": "object"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"detection_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which the event is detected by the originating ITS-S. For the DENM repetition, this DE shall remain unchanged. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"event_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"reference_time": {
"description": "Unit: millisecond since ETSI epoch (2004/01/01, so 1072915200000). Time at which a new DENM, an update DENM or a cancellation DENM is generated. utcStartOf2004(0), oneMillisecAfterUTCStartOf2004(1)",
"maximum": 4398046511103,
"minimum": 0,
"type": "integer"
},
"relevance_distance": {
"description": "lessThan50m(0), lessThan100m(1), lessThan200m(2), lessThan500m(3), lessThan1000m(4), lessThan5km(5), lessThan10km(6), over10km(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"relevance_traffic_direction": {
"description": "allTrafficDirections(0), upstreamTraffic(1), downstreamTraffic(2), oppositeTraffic(3)",
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"termination": {
"description": "isCancellation(0), isNegation (1)",
"maximum": 1,
"minimum": 0,
"type": "integer"
},
"transmission_interval": {
"description": "Unit: millisecond. oneMilliSecond(1), tenSeconds(10000)",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"validity_duration": {
"default": 600,
"description": "Unit: second. timeOfDetection(0), oneSecondAfterDetection(1)",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"required": [
"action_id",
"detection_time",
"reference_time",
"event_position"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"situation_container": {
"properties": {
"event_type": {
"properties": {
"cause": {
"description": "reserved (0),trafficCondition (1),accident (2),roadworks (3),adverseWeatherCondition-Adhesion (6),hazardousLocation-SurfaceCondition (9),hazardousLocation-ObstacleOnTheRoad (10),hazardousLocation-AnimalOnTheRoad (11),humanPresenceOnTheRoad (12),wrongWayDriving (14),rescueAndRecoveryWorkInProgress (15),adverseWeatherCondition-ExtremeWeatherCondition (17),adverseWeatherCondition-Visibility (18),adverseWeatherCondition-Precipitation (19),slowVehicle (26),dangerousEndOfQueue (27),vehicleBreakdown (91),postCrash (92),humanProblem (93),stationaryVehicle (94),emergencyVehicleApproaching (95),hazardousLocation-DangerousCurve (96),collisionRisk (97),signalViolation (98),dangerousSituation (99)",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "trafficCondition: unavailable(0), increasedVolumeOfTraffic(1), trafficJamSlowlyIncreasing(2), trafficJamIncreasing(3), trafficJamStronglyIncreasing(4), trafficStationary(5), trafficJamSlightlyDecreasing(6), trafficJamDecreasing(7), trafficJamStronglyDecreasing(8). accident: unavailable(0), multiVehicleAccident(1), heavyAccident(2), accidentInvolvingLorry(3), accidentInvolvingBus(4), accidentInvolvingHazardousMaterials(5), accidentOnOppositeLane(6), unsecuredAccident(7), assistanceRequested(8). roadworks: unavailable(0), majorRoadworks(1), roadMarkingWork(2), slowMovingRoadMaintenance(3), shortTermStationaryRoadworks(4), streetCleaning(5), winterService(6). humanPresenceOnTheRoad: unavailable(0), childrenOnRoadway(1), cyclistOnRoadway(2), motorcyclistOnRoadway(3). wrongWayDriving: unavailable(0), wrongLane(1), wrongDirection(2). adverseWeatherCondition-ExtremeWeatherCondition: unavailable(0), strongWinds(1), damagingHail(2), hurricane(3), thunderstorm(4), tornado(5), blizzard(6). adverseWeatherCondition-Adhesion: unavailable(0), heavyFrostOnRoad(1), fuelOnRoad(2), mudOnRoad(3), snowOnRoad(4), iceOnRoad(5), blackIceOnRoad(6), oilOnRoad(7), looseChippings(8), instantBlackIce(9), roadsSalted(10). adverseWeatherCondition-Visibility: unavailable(0), fog(1), smoke(2), heavySnowfall(3), heavyRain(4), heavyHail(5), lowSunGlare(6), sandstorms(7), swarmsOfInsects(8). adverseWeatherCondition-Precipitation: unavailable(0), heavyRain(1), heavySnowfall(2), softHail(3). slowVehicle: unavailable(0), maintenanceVehicle(1), vehiclesSlowingToLookAtAccident(2), abnormalLoad(3), abnormalWideLoad(4), convoy(5), snowplough(6), deicing(7), saltingVehicles(8). stationaryVehicle: unavailable(0), humanProblem(1), vehicleBreakdown(2), postCrash(3), publicTransportStop(4), carryingDangerousGoods(5). humanProblem: unavailable(0), glycemiaProblem(1), heartProblem(2). emergencyVehicleApproaching: unavailable(0), emergencyVehicleApproaching(1), prioritizedVehicleApproaching(2). hazardousLocation-DangerousCurve: unavailable(0), dangerousLeftTurnCurve(1), dangerousRightTurnCurve(2), multipleCurvesStartingWithUnknownTurningDirection(3), multipleCurvesStartingWithLeftTurn(4), multipleCurvesStartingWithRightTurn(5). hazardousLocation-SurfaceCondition: unavailable(0), rockfalls(1), earthquakeDamage(2), sewerCollapse(3), subsidence(4), snowDrifts(5), stormDamage(6), burstPipe(7), volcanoEruption(8), fallingIce(9). hazardousLocation-ObstacleOnTheRoad: unavailable(0), shedLoad(1), partsOfVehicles(2), partsOfTyres(3), bigObjects(4), fallenTrees(5), hubCaps(6), waitingVehicles(7). HazardousLocation-AnimalOnTheRoad: unavailable(0), wildAnimals(1), herdOfAnimals(2), smallAnimals(3), largeAnimals(4). CollisionRisk: unavailable(0), longitudinalCollisionRisk(1), crossingCollisionRisk(2), lateralCollisionRisk(3), vulnerableRoadUser(4). SignalViolation: unavailable(0), stopSignViolation(1), trafficLightViolation(2), turningRegulationViolation(3). RescueAndRecoveryWorkInProgress: unavailable(0), emergencyVehicles(1), rescueHelicopterLanding(2), policeActivityOngoing(3), medicalEmergencyOngoing(4), childAbductionInProgress(5). DangerousEndOfQueue: unavailable(0), suddenEndOfQueue(1), queueOverHill(2), queueAroundBend(3), queueInTunnel(4). DangerousSituation: unavailable(0), emergencyElectronicBrakeEngaged(1), preCrashSystemEngaged(2), espEngaged(3), absEngaged(4), aebEngaged(5), brakeWarningEngaged(6), collisionRiskWarningEngaged(7). VehicleBreakdown: unavailable(0), lackOfFuel (1), lackOfBatteryPower (2), engineProblem(3), transmissionProblem(4), engineCoolingProblem(5), brakingSystemProblem(6), steeringProblem(7), tyrePuncture(8). PostCrash: unavailable(0), accidentWithoutECallTriggered (1), accidentWithECallManuallyTriggered (2), accidentWithECallAutomaticallyTriggered (3), accidentWithECallTriggeredWithoutAccessToCellularNetwork(4)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
},
"information_quality": {
"$comment": "if not provided, 'information_quality' = 0 (unavailable)",
"default": 0,
"description": "unavailable(0), lowest(1), highest(7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"linked_cause": {
"properties": {
"cause": {
"description": "see the event type cause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"subcause": {
"$comment": "if not provided, 'subcause' = 0 (unavailable)",
"default": 0,
"description": "see the event type subcause description",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"cause"
],
"type": "object"
}
},
"required": [
"event_type"
],
"type": "object"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"management_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"examples": [
"UNKNOWN",
"CCU6",
"MEC2"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"enum": [
"denm"
]
},
"version": {
"default": "1.1.0",
"description": "json message format version",
"examples": [
"0.1.0",
"0.2.0",
"1.0.0"
],
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Orange-OpenSource/its-client | 626a01781178097ea42109b7ff0c8b51e679f2e4 | 2022-08-16T12:35:36 | schema/cam_schema_1-1-1.json | 7 | 2024-05-27T03:23:41.646252Z | {
"$id": "https://Orange-OpenSource.github.io/its-client/schema/cam",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "CAM JSon schema",
"properties": {
"message": {
"properties": {
"basic_container": {
"properties": {
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"altitude": {
"$comment": "if not provided, 'altitude' = 15 (unavailable)",
"default": 15,
"description": "alt-000-01 (0), alt-000-02 (1), alt-000-05 (2), alt-000-10 (3), alt-000-20 (4), alt-000-50 (5), alt-001-00 (6), alt-002-00 (7), alt-005-00 (8), alt-010-00 (9), alt-020-00 (10), alt-050-00 (11), alt-100-00 (12), alt-200-00 (13), outOfRange (14), unavailable (15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"position_confidence_ellipse": {
"$comment": "mandatory on ETSI specification, FIXME?",
"properties": {
"semi_major_confidence": {
"$comment": "if not provided, 'semi_major_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
},
"semi_major_orientation": {
"$comment": "if not provided, 'semi_major_orientation' = 3601 (unavailable)",
"default": 3601,
"description": "wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"semi_minor_confidence": {
"$comment": "if not provided, 'semi_minor_confidence' = 4095 (unavailable)",
"default": 4095,
"description": "oneCentimeter(1), outOfRange(4094), unavailable(4095)",
"maximum": 4095,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"reference_position": {
"properties": {
"altitude": {
"default": 800001,
"description": "Unit: 0.01 meter. referenceEllipsoidSurface(0), oneCentimeter(1), unavailable(800001)",
"maximum": 800001,
"minimum": -100000,
"type": "integer"
},
"latitude": {
"default": 900000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10), unavailable(900000001)",
"maximum": 900000001,
"minimum": -900000000,
"type": "integer"
},
"longitude": {
"default": 1800000001,
"description": "Unit: 0,1 microdegree. oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(1800000001)",
"maximum": 1800000001,
"minimum": -1800000000,
"type": "integer"
}
},
"required": [
"latitude",
"longitude",
"altitude"
],
"type": "object"
},
"station_type": {
"$comment": "if not provided, 'station_type' = 0 (unknown)",
"default": 0,
"description": "unknown(0), pedestrian(1), cyclist(2), moped(3), motorcycle(4), passengerCar(5), bus(6), lightTruck(7), heavyTruck(8), trailer(9), specialVehicles(10), tram(11), roadSideUnit(15)",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"reference_position"
],
"type": "object"
},
"generation_delta_time": {
"description": "time of the reference position in the CAM, considered as time of the CAM generation. TimestampIts mod 65 536. TimestampIts represents an integer value in milliseconds since 2004-01-01T00:00:00:000Z. oneMilliSec(1)",
"examples": [
1,
1245
],
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"high_frequency_container": {
"description": "The basic vehicle container high frequency",
"properties": {
"acceleration_control": {
"description": "Current controlling mechanism for longitudinal movement of the vehicle. Represented as a bit string: brakePedalEngaged (0), gasPedalEngaged (1), emergencyBrakeEngaged (2), collisionWarningEngaged(3), accEngaged(4), cruiseControlEngaged(5), speedLimiterEngaged(6)",
"example": [
"0000000",
"1000000",
"0000011"
],
"maxLength": 7,
"minLength": 7,
"type": "string"
},
"confidence": {
"$comment": "mandatory on ETSI specification, FIXME?",
"description": "the high frequency container confidence fields. Note that no vehicle_width is defined",
"properties": {
"curvature": {
"description": "onePerMeter-0-00002 (0), onePerMeter-0-0001 (1), onePerMeter-0-0005 (2), onePerMeter-0-002 (3), onePerMeter-0-01 (4), onePerMeter-0-1 (5), outOfRange (6), unavailable (7)",
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinZeroPointOneDegree (1), equalOrWithinOneDegree (10), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"longitudinal_acceleration": {
"description": "pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 127 (unavailable)",
"default": 127,
"description": "equalOrWithinOneCentimeterPerSec(1), equalOrWithinOneMeterPerSec(100), outOfRange(126), unavailable(127)",
"maximum": 127,
"minimum": 1,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 4 (unavailable)",
"default": 4,
"description": "noTrailerPresent(0), trailerPresentWithKnownLength(1), trailerPresentWithUnknownLength(2), trailerPresenceIsUnknown(3), unavailable(4)",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0,1 m/s2. pointOneMeterPerSecSquared(1), outOfRange(101), unavailable(102)",
"maximum": 102,
"minimum": 0,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 8 (unavailable)",
"default": 8,
"description": "degSec-000-01 (0), degSec-000-05 (1), degSec-000-10 (2), degSec-001-00 (3), degSec-005-00 (4), degSec-010-00 (5), degSec-100-00 (6), outOfRange (7), unavailable (8)",
"maximum": 8,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"curvature": {
"$comment": "if not provided, 'curvature' = 30001 (unavailable)",
"default": 1023,
"description": "straight(0), unavailable(1023)",
"maximum": 1023,
"minimum": -1023,
"type": "integer"
},
"curvature_calculation_mode": {
"$comment": "if not provided, 'curvature_calculation_mode' = 2 (unavailable)",
"default": 2,
"description": "It describes whether the yaw rate is used to calculate the curvature: yawRateUsed(0), yawRateNotUsed(1), unavailable(2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"drive_direction": {
"$comment": "if not provided, 'drive_direction' = 2 (unavailable)",
"default": 2,
"description": "forward (0), backward (1), unavailable (2)",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"heading": {
"$comment": "if not provided, 'heading' = 3601 (unavailable)",
"default": 3601,
"description": "Unit: 0,1 degree. wgs84North(0), wgs84East(900), wgs84South(1800), wgs84West(2700), unavailable(3601)",
"maximum": 3601,
"minimum": 0,
"type": "integer"
},
"lane_position": {
"description": "offTheRoad(-1), innerHardShoulder(0), innermostDrivingLane(1), secondLaneFromInside(2), outterHardShoulder(14)",
"maximum": 14,
"minimum": -1,
"type": "integer"
},
"lateral_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredToRight(-1), pointOneMeterPerSecSquaredToLeft(1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"longitudinal_acceleration": {
"$comment": "if not provided, 'longitudinal_acceleration' = 161 (unavailable)",
"default": 161,
"description": "unit: 0,1 m/s2. pointOneMeterPerSecSquaredForward(1), pointOneMeterPerSecSquaredBackward(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"speed": {
"$comment": "if not provided, 'speed' = 16383 (unavailable)",
"default": 16383,
"description": "Unit 0,01 m/s. standstill(0), oneCentimeterPerSec(1), unavailable(16383)",
"maximum": 16383,
"minimum": 0,
"type": "integer"
},
"vehicle_length": {
"$comment": "if not provided, 'vehicle_length' = 1023 (unavailable)",
"default": 1023,
"description": "tenCentimeters(1), outOfRange(1022), unavailable(1023)",
"maximum": 1023,
"minimum": 1,
"type": "integer"
},
"vehicle_width": {
"$comment": "if not provided, 'vehicle_width' = 62(unavailable)",
"default": 62,
"description": "tenCentimeters(1), outOfRange(61), unavailable(62)",
"maximum": 62,
"minimum": 1,
"type": "integer"
},
"vertical_acceleration": {
"description": "Unit: 0.1 m/s2. pointOneMeterPerSecSquaredUp(1), pointOneMeterPerSecSquaredDown(-1), unavailable(161)",
"maximum": 161,
"minimum": -160,
"type": "integer"
},
"yaw_rate": {
"$comment": "if not provided, 'yaw_rate' = 32767 (unavailable)",
"default": 32767,
"description": "Unit: 0,01 degree/s: straight(0), degSec-000-01ToRight(-1), degSec-000-01ToLeft(1), unavailable(32767)",
"maximum": 32767,
"minimum": -32766,
"type": "integer"
}
},
"type": "object"
},
"low_frequency_container": {
"description": "The basic vehicle container low frequency",
"properties": {
"exterior_lights": {
"description": "Status of the exterior light switches represented as a bit string: lowBeamHeadlightsOn (0), highBeamHeadlightsOn (1), leftTurnSignalOn (2), rightTurnSignalOn (3), daytimeRunningLightsOn (4), reverseLightOn (5), fogLightOn (6), parkingLightsOn (7)",
"example": [
"00000000",
"10011010",
"00000110"
],
"maxLength": 8,
"minLength": 8,
"type": "string"
},
"path_history": {
"description": "the path history, a path with a set of path points",
"items": {
"properties": {
"path_delta_time": {
"description": "time travelled by the detecting ITS-S since the previous detected event point (generation_delta_time). tenMilliSecondsInPast(1)",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"path_position": {
"description": "offset position of a detected event point with regards to the previous detected event point (reference_position).",
"properties": {
"delta_altitude": {
"$comment": "if not provided, 'delta_altitude' = 12800 (unavailable)",
"default": 12800,
"description": "oneCentimeterUp (1), oneCentimeterDown (-1), unavailable(12800)",
"maximum": 12800,
"minimum": -12700,
"type": "integer"
},
"delta_latitude": {
"$comment": "if not provided, 'delta_latitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeNorth (10), oneMicrodegreeSouth (-10) , unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
},
"delta_longitude": {
"$comment": "if not provided, 'delta_longitude' = 131072 (unavailable)",
"default": 131072,
"description": "oneMicrodegreeEast (10), oneMicrodegreeWest (-10), unavailable(131072)",
"maximum": 131072,
"minimum": -131071,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"path_position"
],
"type": "object"
},
"maxItems": 40,
"type": "array"
},
"vehicle_role": {
"$comment": "if not provided, 'vehicle_role' = 0 (default)",
"default": 0,
"description": "default(0), publicTransport(1), specialTransport(2), dangerousGoods(3), roadWork(4), rescue(5), emergency(6), safetyCar(7), agriculture(8),commercial(9),military(10),roadOperator(11),taxi(12), reserved1(13), reserved2(14), reserved3(15)",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"exterior_lights",
"path_history"
],
"type": "object"
},
"protocol_version": {
"description": "version of the ITS message and/or communication protocol",
"examples": [
1
],
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"station_id": {
"description": "identifier for an ITS-S",
"examples": [
1,
42
],
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"protocol_version",
"station_id",
"generation_delta_time",
"basic_container",
"high_frequency_container"
],
"type": "object"
},
"origin": {
"description": "the entity responsible for this message",
"enum": [
"self",
"global_application",
"mec_application",
"on_board_application"
],
"type": "string"
},
"source_uuid": {
"description": "identifier",
"examples": [
"UNKNOWN",
"42"
],
"type": "string"
},
"timestamp": {
"description": "Unit: millisecond. The timestamp when the message was generated since Unix Epoch (1970/01/01)",
"examples": [
1574778515424
],
"maximum": 1830297600000,
"minimum": 1514764800000,
"type": "integer"
},
"type": {
"const": "cam",
"description": "message type",
"type": "string"
},
"version": {
"const": "1.1.1",
"description": "json message format version",
"type": "string"
}
},
"required": [
"type",
"origin",
"version",
"source_uuid",
"timestamp",
"message"
],
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.