Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22399194.2 KB
Config Schemas

Create

Create a new config schema.

post/config_schemas

Query parameters

expandConfigSchemaExpansion[]

Fields to expand on the config schema resource.

[
  "documents"
]

Request body

instance_filepathstring

The absolute file system path config instances for this schema are written to.

language'jsonschema' | 'cue' required
format'json' | 'yaml' | 'cue' required

Example request

{
  "config_type_ref": {
    "id": "cfg_123",
    "slug": "my-config-type"
  },
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
  "language": "jsonschema",
  "documents": [
    {
      "name": "motion-control.json"
    }
  ],
  "git_commit": {
    "commit_ref": {
      "id": "git_cmt_123",
      "sha": "1a2b3c4d..."
    },
    "schema_filepaths": [
      "path/to/config/schema/robot1.cue",
      "path/to/config/schema/robot2.cue"
    ]
  }
}

Response

Successfully created the config schema.

object'config_schema' required

The object type, which is always config_schema.

idstring required

ID of the config schema.

digeststring required

The digest of the config schema.

config_type_namestring required

The name of the config type.

instance_filepathstring required

The absolute file system path where config instances for this schema are written.

created_atstring date-time required

Timestamp of when the config schema was created.

updated_atstring date-time required

Timestamp of when the config schema was last updated.

config_type_idstring required

ID of the config type.

language'jsonschema' | 'cue' required
format'json' | 'yaml' | 'cue' required

Example response

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "config_type_name": "Motion Control",
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "config_type_id": "cfg_typ_123",
  "language": "jsonschema",
  "format": "json"
}