Skills
About 253 wordsLess than 1 minute
Generated from
docs/.vuepress/openapi.json. Refresh withnpm run gen:api. Back to overview.
GET /api/v1/skills — Index Skill
Tags: Skills
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
principal_id | integer | no | Narrow the listing to one principal the caller controls. An id outside the caller’s visible set is discarded rather than rejected, and the caller’s full visible set is returned instead — the SPA sends this per editor mode so a group admin’s personal skills do not appear in a group’s picker. Shipped skills are principal-independent and appear either way. |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
GET /api/v1/skills/{slug} — Show Skill
Tags: Skills
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
slug | string | yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
principal_id | integer | no | Narrow the lookup to one principal the caller controls, under the same discard-not-reject rule as the listing. A name the caller cannot see answers 404, not 403. |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
GET /api/v1/skills/{slug}/files/{path} — File Skill
Tags: Skills
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
slug | string | yes | |
path | string | yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
principal_id | integer | no | Narrow the lookup to one principal the caller controls, under the same discard-not-reject rule as the listing. A skill the caller cannot see answers 404, not 403. |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |