OpenVibe.Reviews API

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Server https://openvibe.reviews. 29 routes performing 8 capabilities. OpenAPI 3.1 document.

GET /api/v1/corrections

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Input
reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

PATCH /api/v1/corrections/{id}

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • id (path, required)
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

GET /api/v1/entities

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/entities

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

GET /api/v1/entities/{ref}

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • ref (path, required)
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

PATCH /api/v1/entities/{ref}

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

DELETE /api/v1/entities/{ref}

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • ref (path, required)
Input
reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

GET /api/v1/entities/{ref}/aggregate

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • ref (path, required)
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/entities/{ref}/aliases

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

DELETE /api/v1/entities/{ref}/aliases/{id}

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • ref (path, required)
  • id (path, required)
Input
reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

POST /api/v1/entities/{ref}/corrections

Send a correction (about an entity, alias, signal, summary or aggregate, with an optional evidence URL) to the editors' queue on behalf of the person named in X-OV-Subject.

Capabilities
reviews.correction.submit
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.correction-submit-request@1
Response
application/json reviews.correction-submit-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.correction.submit</strong> (first-party): Send a correction (about an entity, alias, signal, summary or aggregate, with an optional evidence URL) to the editors&#39; queue on behalf of the person named in X-OV-Subject. Corrections are read by editors and not published.</p>

GET /api/v1/entities/{ref}/history

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • ref (path, required)
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/entities/{ref}/links

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>

POST /api/v1/entities/{ref}/merge

Merge one entity into another, decided by the editor named in X-OV-Subject (never a service on its own).

Capabilities
reviews.entity.merge
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.entity-merge-request@1
Response
application/json reviews.entity-merge-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.merge</strong> (first-party): Merge one entity into another, decided by the editor named in X-OV-Subject (never a service on its own). Nothing is rewritten: the merged entity keeps its aliases and its signals keep their attribution; an audited merged_into link records who, when and why, and the target&#39;s aggregate is recomputed over both. Reversible with reviews.entity.split.</p>

POST /api/v1/entities/{ref}/split

Undo a merge, decided by the editor named in X-OV-Subject: ends the merged_into link (audited) and restores the pre-merge attribution exactly; both aggregates are recomputed and a summary that cited t

Capabilities
reviews.entity.split
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.entity-split-request@1
Response
application/json reviews.entity-split-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.split</strong> (first-party): Undo a merge, decided by the editor named in X-OV-Subject: ends the merged_into link (audited) and restores the pre-merge attribution exactly; both aggregates are recomputed and a summary that cited the split-off signals is flagged with a pending revision.</p>

POST /api/v1/entities/{ref}/summary/proposals

The OpenVibe.AI seam (workflow reviews.summarize_entity): propose a summary revision whose every pro and con cites signals of the entity.

Capabilities
reviews.summary.propose
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.summary-propose-request@1
Response
application/json reviews.summary-propose-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.summary.propose</strong> (first-party): The OpenVibe.AI seam (workflow reviews.summarize_entity): propose a summary revision whose every pro and con cites signals of the entity. It is stored with ai authorship (workflow and run id, stub-provider flag), is never published by this call, stays out of pages, feeds and Search until a person approves it, and can never carry a rating (rating fields and rating text are refused).</p>

POST /api/v1/entities/{ref}/summary/publish

Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject.

Capabilities
reviews.summary.publish
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.summary-publish-request@1
Response
application/json reviews.summary-publish-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.summary.publish</strong> (first-party): Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject. Publishing refuses AI or system-prepared revisions without a person&#39;s approval and any revision with a point that cites no live signal of the entity.</p>

POST /api/v1/entities/{ref}/summary/revisions

Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject.

Capabilities
reviews.summary.publish
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.summary-publish-request@1
Response
application/json reviews.summary-publish-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.summary.publish</strong> (first-party): Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject. Publishing refuses AI or system-prepared revisions without a person&#39;s approval and any revision with a point that cites no live signal of the entity.</p>

GET /api/v1/entities/{ref}/summary/revisions/{n}

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • ref (path, required)
  • n (path, required)
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/entities/{ref}/summary/revisions/{n}/review

Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject.

Capabilities
reviews.summary.publish
Visibility
first-party
Parameters
  • ref (path, required)
  • n (path, required)
Request body
application/json reviews.summary-publish-request@1
Response
application/json reviews.summary-publish-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.summary.publish</strong> (first-party): Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject. Publishing refuses AI or system-prepared revisions without a person&#39;s approval and any revision with a point that cites no live signal of the entity.</p>

POST /api/v1/entities/{ref}/summary/unpublish

Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject.

Capabilities
reviews.summary.publish
Visibility
first-party
Parameters
  • ref (path, required)
Request body
application/json reviews.summary-publish-request@1
Response
application/json reviews.summary-publish-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.summary.publish</strong> (first-party): Write, review (approve or reject), publish and unpublish summary revisions as the editor named in X-OV-Subject. Publishing refuses AI or system-prepared revisions without a person&#39;s approval and any revision with a point that cites no live signal of the entity.</p>

GET /api/v1/items

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

GET /api/v1/items/{id}

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • id (path, required)
Input
reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/items/{id}/resolution

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Parameters
  • id (path, required)
Request body
application/json reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/resolve

Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, si

Capabilities
reviews.entity.resolve
Visibility
first-party
Request body
application/json reviews.entity-resolve-request@1
Response
application/json reviews.entity-resolve-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.resolve</strong> (first-party): Resolve a name, URL, GTIN/SKU/MPN, source binding or external id to an entity (deterministic rules; a name alone yields candidates, never a match), read entity pages as JSON (aggregate with inputs, signals with provenance, summary), their history and summary revisions, and — for an editor named in X-OV-Subject — read the resolution queue and confirm or ignore an ambiguous source item.</p>

POST /api/v1/signals/import

Import review signals from OpenVibe.Sources: one item by id, or the next pages of category-reviews items in change order.

Capabilities
reviews.signal.import
Visibility
first-party
Request body
application/json reviews.signal-import-request@1
Response
application/json reviews.signal-import-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.signal.import</strong> (first-party): Import review signals from OpenVibe.Sources: one item by id, or the next pages of category-reviews items in change order. Reviews fetches the item itself (sources.item.read), keeps its provenance (source, item revision, retrieval time, licence note) and only the signal fields, never review text. Removed or revised items withdraw or replace their signal; the next aggregate revision reflects it.</p>

POST /api/v1/sources/sync

Import review signals from OpenVibe.Sources: one item by id, or the next pages of category-reviews items in change order.

Capabilities
reviews.signal.import
Visibility
first-party
Request body
application/json reviews.signal-import-request@1
Response
application/json reviews.signal-import-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.signal.import</strong> (first-party): Import review signals from OpenVibe.Sources: one item by id, or the next pages of category-reviews items in change order. Reviews fetches the item itself (sources.item.read), keeps its provenance (source, item revision, retrieval time, licence note) and only the signal fields, never review text. Removed or revised items withdraw or replace their signal; the next aggregate revision reflects it.</p>

POST /api/v1/trust

Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another

Capabilities
reviews.entity.manage
Visibility
first-party
Request body
application/json reviews.entity-manage-request@1
Response
application/json reviews.entity-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>reviews.entity.manage</strong> (first-party): Editorial management of entities for the editor named in X-OV-Subject: create, edit, rename (old slugs redirect) and delete entities, add and remove aliases, typed links between entities or to another service&#39;s EntityRef, trust metadata (exclude a source or signal from aggregates with a visible reason, limitation and verification notes), and the correction queue.</p>