Knowledge schemas
A Knowledge Schema is a published, versioned set of types a graph accepts: entity types with a JSON Schema each, and relation types.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
A Knowledge Schema is a published, versioned set of types a graph accepts: entity types with a JSON Schema each, and relation types. A type pack (the customer pack) is a schema, not code. The core schema is built in.
Service Sylphx Knowledge · Resource type knowledge.sylphx.com/KnowledgeSchema · Name pattern orgs/{org}/projects/{project}/envs/{env}/knowledge_schemas/{knowledge_schema} · Shape spec_status
Not available yet. Sylphx Knowledge is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/knowledge_schemas/{knowledge_schema}. |
uid | string | ksch_<26 base32>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | KnowledgeSchemaSpec | Desired state. Required. |
status | KnowledgeSchemaStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a knowledge schema. |
GET | list | Lists knowledge schemas. |
POST | create | Creates a knowledge schema. |
PATCH | update | Updates a knowledge schema. An accepted update publishes a new revision; a change that would invalidate existing records is refused with INVALID_FIELD. |
DELETE | delete | Deletes a knowledge schema. A schema a space still accepts is refused with RESOURCE_IN_USE. |
get
Gets a knowledge schema.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · scope knowledge:read · effect read · not available yet · Request, response and examples
list
Lists knowledge schemas.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas · scope knowledge:read · effect read · not available yet · paginated · Request, response and examples
create
Creates a knowledge schema.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas · scope knowledge:write · effect write · not available yet · Request, response and examples
update
Updates a knowledge schema. An accepted update publishes a new revision; a change that would invalidate existing records is refused with INVALID_FIELD.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · scope knowledge:write · effect write · not available yet · Request, response and examples
delete
Deletes a knowledge schema. A schema a space still accepts is refused with RESOURCE_IN_USE.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/knowledge_schemas/knowledge-schema · scope knowledge:write · effect destructive · not available yet · Request, response and examples