OpenVibe.Sources API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://sources.openvibe.network. 13 routes performing 3 capabilities. OpenAPI 3.1 document.
GET /api/v1/health
List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary.
- Capabilities
- sources.source.read
- Visibility
- first-party
- Response
application/jsonsources.source-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.read</strong> (first-party): List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary. Credential values are never part of any response; only the variable name is.</p>GET /api/v1/items
Read source items with provenance (source, canonical URL, retrieval time, content and raw-body hashes, parser version, terms) in change order, and one item with its revisions.
- Capabilities
- sources.item.read
- Visibility
- first-party
- Response
application/jsonsources.item-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.item.read</strong> (first-party): Read source items with provenance (source, canonical URL, retrieval time, content and raw-body hashes, parser version, terms) in change order, and one item with its revisions. Each page states the staleness of the sources it contains.</p>GET /api/v1/items/{id}
Read source items with provenance (source, canonical URL, retrieval time, content and raw-body hashes, parser version, terms) in change order, and one item with its revisions.
- Capabilities
- sources.item.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonsources.item-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.item.read</strong> (first-party): Read source items with provenance (source, canonical URL, retrieval time, content and raw-body hashes, parser version, terms) in change order, and one item with its revisions. Each page states the staleness of the sources it contains.</p>DELETE /api/v1/items/{id}
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- sources.source-write-request@1
- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>GET /api/v1/runs
List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary.
- Capabilities
- sources.source.read
- Visibility
- first-party
- Response
application/jsonsources.source-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.read</strong> (first-party): List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary. Credential values are never part of any response; only the variable name is.</p>GET /api/v1/sources
List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary.
- Capabilities
- sources.source.read
- Visibility
- first-party
- Response
application/jsonsources.source-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.read</strong> (first-party): List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary. Credential values are never part of any response; only the variable name is.</p>POST /api/v1/sources
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Request body
application/jsonsources.source-write-request@1- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>GET /api/v1/sources/{key}
List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary.
- Capabilities
- sources.source.read
- Visibility
- first-party
- Parameters
key(path, required)
- Response
application/jsonsources.source-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.read</strong> (first-party): List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary. Credential values are never part of any response; only the variable name is.</p>PATCH /api/v1/sources/{key}
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Parameters
key(path, required)
- Request body
application/jsonsources.source-write-request@1- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>DELETE /api/v1/sources/{key}
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Parameters
key(path, required)
- Input
- sources.source-write-request@1
- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>POST /api/v1/sources/{key}/fetch
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Parameters
key(path, required)
- Request body
application/jsonsources.source-write-request@1- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>POST /api/v1/sources/{key}/items
Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky).
- Capabilities
- sources.source.manage
- Visibility
- first-party
- Parameters
key(path, required)
- Request body
application/jsonsources.source-write-request@1- Response
application/jsonsources.source-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>sources.source.manage</strong> (first-party): Create, change, enable or disable and delete (only while it has no items) sources; trigger a fetch; add items to manual sources with an evidence URL; remove an item with a reason (sticky). Enabling needs a terms note, and a robots note for fetched sources.</p>GET /api/v1/sources/{key}/runs
List registered sources with health and staleness, their fetch runs (every attempt with an explicit state) and the health summary.
- Capabilities
- sources.source.read
- Visibility
- first-party
- Parameters
key(path, required)
- Response
application/jsonsources.source-read-result@1- Errors
- errors.problem@1 (application/problem+json)