OpenVibe.Wiki API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://openvibe.wiki. 25 routes performing 8 capabilities. OpenAPI 3.1 document.
GET /api/v1/pages/{id}
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>PATCH /api/v1/pages/{id}
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>DELETE /api/v1/pages/{id}
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- wiki.page-write-request@1
- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>GET /api/v1/pages/{id}/diff
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>POST /api/v1/pages/{id}/media
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>POST /api/v1/pages/{id}/media/verify
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>POST /api/v1/pages/{id}/publish
Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of
- Capabilities
- wiki.revision.publish
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.publish-request@1- Response
application/jsonwiki.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.publish</strong> (first-party): Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of the editor named in X-OV-Subject. AI-generated revisions cannot be published without an approving review by a person.</p>POST /api/v1/pages/{id}/revert
Revert a page to an earlier revision by adding a new revision that copies its text, infobox and citations (history is never rewritten), on behalf of the editor named in X-OV-Subject.
- Capabilities
- wiki.revision.revert
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.revert-request@1- Response
application/jsonwiki.revert-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.revert</strong> (first-party): Revert a page to an earlier revision by adding a new revision that copies its text, infobox and citations (history is never rewritten), on behalf of the editor named in X-OV-Subject. A revert of a published page is published.</p>GET /api/v1/pages/{id}/revisions
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>POST /api/v1/pages/{id}/revisions
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>GET /api/v1/pages/{id}/revisions/{n}
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)n(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>GET /api/v1/pages/{id}/revisions/{n}/citations
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)n(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>POST /api/v1/pages/{id}/revisions/{n}/citations
Attach citations (an OpenVibe.Sources item id, whose URL, title, retrieval time and license come from the item's provenance, or an http(s) URL with its retrieval time) to the newest, unpublished revis
- Capabilities
- wiki.citation.attach
- Visibility
- first-party
- Parameters
id(path, required)n(path, required)
- Request body
application/jsonwiki.citation-attach-request@1- Response
application/jsonwiki.citation-attach-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.citation.attach</strong> (first-party): Attach citations (an OpenVibe.Sources item id, whose URL, title, retrieval time and license come from the item's provenance, or an http(s) URL with its retrieval time) to the newest, unpublished revision of a page. Citations are append-only and stay with the revision that used them.</p>POST /api/v1/pages/{id}/revisions/{n}/review
Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of
- Capabilities
- wiki.revision.publish
- Visibility
- first-party
- Parameters
id(path, required)n(path, required)
- Request body
application/jsonwiki.publish-request@1- Response
application/jsonwiki.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.publish</strong> (first-party): Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of the editor named in X-OV-Subject. AI-generated revisions cannot be published without an approving review by a person.</p>POST /api/v1/pages/{id}/schedule
Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of
- Capabilities
- wiki.revision.publish
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.publish-request@1- Response
application/jsonwiki.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.publish</strong> (first-party): Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of the editor named in X-OV-Subject. AI-generated revisions cannot be published without an approving review by a person.</p>POST /api/v1/pages/{id}/unpublish
Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of
- Capabilities
- wiki.revision.publish
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.publish-request@1- Response
application/jsonwiki.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.publish</strong> (first-party): Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of the editor named in X-OV-Subject. AI-generated revisions cannot be published without an approving review by a person.</p>POST /api/v1/proposals
Propose a revision (or a new page) as the output of an OpenVibe.AI workflow run.
- Capabilities
- wiki.revision.propose
- Visibility
- first-party
- Request body
application/jsonwiki.proposal-request@1- Response
application/jsonwiki.proposal-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.propose</strong> (first-party): Propose a revision (or a new page) as the output of an OpenVibe.AI workflow run. The proposal becomes an immutable revision with ai authorship (workflow id and run id, stub-provider flag) and a pending proposal; it is never published until a person with the editor role approves it.</p>GET /api/v1/proposals/{id}
Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only).
- Capabilities
- wiki.page.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwiki.page-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.read</strong> (first-party): Read pages, revisions, diffs, citations and AI proposals as the person named in X-OV-Subject sees them (without a subject: public, published content only). Members-only and private pages follow the space's roles; drafts and history of unpublished pages need the editor role.</p>POST /api/v1/proposals/{id}/review
Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of
- Capabilities
- wiki.revision.publish
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwiki.publish-request@1- Response
application/jsonwiki.publish-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.revision.publish</strong> (first-party): Publish a revision now or at a scheduled time (idempotent), unpublish a page, and record a person's review (approved or rejected) of an AI proposal or of an existing AI-assisted revision, on behalf of the editor named in X-OV-Subject. AI-generated revisions cannot be published without an approving review by a person.</p>GET /api/v1/search
Search published pages by title and text, returning only pages the person named in X-OV-Subject may read (without a subject: public pages only).
- Capabilities
- wiki.search.query
- Visibility
- first-party
- Response
application/jsonwiki.search-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.search.query</strong> (first-party): Search published pages by title and text, returning only pages the person named in X-OV-Subject may read (without a subject: public pages only). Network-wide discovery goes through OpenVibe.Search, which Wiki feeds with wiki.index_document.* events.</p>POST /api/v1/spaces
Create a wiki space and change a space's settings and roles.
- Capabilities
- wiki.space.create
- Visibility
- first-party
- Request body
application/jsonwiki.space-write-request@1- Response
application/jsonwiki.space-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.space.create</strong> (first-party): Create a wiki space and change a space's settings and roles. People create user spaces they own; official (editorial) spaces are created by staff or by a service acting as itself. Settings and role changes need the owner role of the space (for a service: the X-OV-Subject person).</p>PATCH /api/v1/spaces/{space}
Create a wiki space and change a space's settings and roles.
- Capabilities
- wiki.space.create
- Visibility
- first-party
- Parameters
space(path, required)
- Request body
application/jsonwiki.space-write-request@1- Response
application/jsonwiki.space-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.space.create</strong> (first-party): Create a wiki space and change a space's settings and roles. People create user spaces they own; official (editorial) spaces are created by staff or by a service acting as itself. Settings and role changes need the owner role of the space (for a service: the X-OV-Subject person).</p>POST /api/v1/spaces/{space}/import
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
space(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>POST /api/v1/spaces/{space}/pages
Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and
- Capabilities
- wiki.page.create
- Visibility
- first-party
- Parameters
space(path, required)
- Request body
application/jsonwiki.page-write-request@1- Response
application/jsonwiki.page-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>wiki.page.create</strong> (first-party): Create pages and write human-authored revisions (text, typed infobox values, citations), move or rename pages (old addresses answer 301), attach OpenVibe.Media objects the person can read in Media and check them, on behalf of the person named in X-OV-Subject, who must be an editor of the space. Deleting pages, changing page visibility and importing a bundle of pages into the space need the owner role.</p>PUT /api/v1/spaces/{space}/roles/{subject}
Create a wiki space and change a space's settings and roles.
- Capabilities
- wiki.space.create
- Visibility
- first-party
- Parameters
space(path, required)subject(path, required)
- Request body
application/jsonwiki.space-write-request@1- Response
application/jsonwiki.space-write-result@1- Errors
- errors.problem@1 (application/problem+json)