Proposes a schema/mapping change for a subtype you’ve already registered.
PATCH
/
v1
/
schemas
/
{subtype}
import olira
olira.init(api_key="YOUR_API_KEY")
edited = olira.edit_schema(
subtype="widget_ping",
schema={
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}},
},
mapping={
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]},
],
},
)
print(edited.target_version)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var edited = OliraModule.EditSchema(
subtype: "widget_ping",
schema: new Dictionary<string, object?>
{
["type"] = "object",
["required"] = new List<object?> { "value" },
["properties"] = new Dictionary<string, object?>
{
["value"] = new Dictionary<string, object?> { ["type"] = "number" },
},
},
mapping: new Dictionary<string, object?>
{
["targets"] = new List<object?>
{
new Dictionary<string, object?>
{
["target_subtype"] = "heart_rate_data",
["field_mappings"] = new List<object?>
{
new Dictionary<string, object?>
{
["target"] = "avg_bpm",
["source"] = "value",
},
},
},
},
});
Console.WriteLine(edited.TargetVersion);
PATCH /v1/schemas/widget_ping
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"payload_schema": {
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}}
},
"mapping": {
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]}
]
}
}
SchemaRegistrationResult(
registration_id="6a5523da0d094fdeed36f56b",
subtype="widget_ping",
target_version=2,
submission_mode="full_spec",
status="pending_review",
self_check=None,
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
olira.edit_schema(
subtype: str,
description: str | None = None,
input_examples: list[dict] | None = None,
schema: dict | None = None,
mapping: dict | None = None,
) -> SchemaRegistrationResult
OliraModule.EditSchema(
string subtype,
string? description = null,
IReadOnlyList<dict>? inputExamples = null,
dict? schema = null,
dict? mapping = null,
) // -> SchemaRegistrationResult
api:org-config
Always opens a new pending request targeting the next version — never mutates an active version in place. Editing an already-active subtype defaults any field you omit to what’s currently active, so the reviewer sees a complete proposed spec even from a partial edit.
Parameters
str
required
Subtype to propose a change for.
str | None
default:"None"
New description, if changing it.
list[dict] | None
default:"None"
Replacement sample payloads.
dict | None
default:"None"
New JSON Schema, if changing it.
dict | None
default:"None"
New mapping spec, if changing it.
Returns
SchemaRegistrationResult
str
Id of the (possibly reused) registration.
str
The edited subtype.
int
Version this edit proposes.
str
“full_spec” once both a schema and a mapping are known (yours, or inherited from the active version), else “assisted”.
str
“pending_review”.
dict | None
Dry-run result, populated when submission_mode is full_spec and examples are present.
Raises
| Exception | When |
|---|---|
AuthError | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint. |
ValidationError | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt). |
ServerError | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable. |
RateLimitError | HTTP 429 — rate limited; check retry_after (seconds). |
NetworkError | Connection timeout, DNS failure, or read error after retries. |
import olira
olira.init(api_key="YOUR_API_KEY")
edited = olira.edit_schema(
subtype="widget_ping",
schema={
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}},
},
mapping={
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]},
],
},
)
print(edited.target_version)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var edited = OliraModule.EditSchema(
subtype: "widget_ping",
schema: new Dictionary<string, object?>
{
["type"] = "object",
["required"] = new List<object?> { "value" },
["properties"] = new Dictionary<string, object?>
{
["value"] = new Dictionary<string, object?> { ["type"] = "number" },
},
},
mapping: new Dictionary<string, object?>
{
["targets"] = new List<object?>
{
new Dictionary<string, object?>
{
["target_subtype"] = "heart_rate_data",
["field_mappings"] = new List<object?>
{
new Dictionary<string, object?>
{
["target"] = "avg_bpm",
["source"] = "value",
},
},
},
},
});
Console.WriteLine(edited.TargetVersion);
PATCH /v1/schemas/widget_ping
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"payload_schema": {
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}}
},
"mapping": {
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]}
]
}
}
SchemaRegistrationResult(
registration_id="6a5523da0d094fdeed36f56b",
subtype="widget_ping",
target_version=2,
submission_mode="full_spec",
status="pending_review",
self_check=None,
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
⌘I
import olira
olira.init(api_key="YOUR_API_KEY")
edited = olira.edit_schema(
subtype="widget_ping",
schema={
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}},
},
mapping={
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]},
],
},
)
print(edited.target_version)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var edited = OliraModule.EditSchema(
subtype: "widget_ping",
schema: new Dictionary<string, object?>
{
["type"] = "object",
["required"] = new List<object?> { "value" },
["properties"] = new Dictionary<string, object?>
{
["value"] = new Dictionary<string, object?> { ["type"] = "number" },
},
},
mapping: new Dictionary<string, object?>
{
["targets"] = new List<object?>
{
new Dictionary<string, object?>
{
["target_subtype"] = "heart_rate_data",
["field_mappings"] = new List<object?>
{
new Dictionary<string, object?>
{
["target"] = "avg_bpm",
["source"] = "value",
},
},
},
},
});
Console.WriteLine(edited.TargetVersion);
PATCH /v1/schemas/widget_ping
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"payload_schema": {
"type": "object",
"required": ["value"],
"properties": {"value": {"type": "number"}}
},
"mapping": {
"targets": [
{"target_subtype": "heart_rate_data", "field_mappings": [{"target": "avg_bpm", "source": "value"}]}
]
}
}
SchemaRegistrationResult(
registration_id="6a5523da0d094fdeed36f56b",
subtype="widget_ping",
target_version=2,
submission_mode="full_spec",
status="pending_review",
self_check=None,
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}