OpenVibe.Search API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://search.openvibe.network. 8 routes performing 3 capabilities. OpenAPI 3.1 document.
GET /api/v1/documents/{owner}/{type}/{id}
Query the index on behalf of a person: X-OV-Subject (usr_/gst_) plus the X-OV-Groups and X-OV-Entitlements the calling first-party service has just resolved for that person.
- Capabilities
- search.query.delegate, search.query.run
- Visibility
- first-party, public
- Parameters
owner(path, required)type(path, required)id(path, required)q(query) — Words to match (FTS5; empty lists by recency).lang(query) — BCP 47 language.facets(query) — Comma-separated facet keys to count over what the caller can see.limit(query)cursor(query) — next_cursor of the previous page.
- Input
- search.query@1
- Response
application/jsonsearch.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.query.delegate</strong> (first-party): Query the index on behalf of a person: X-OV-Subject (usr_/gst_) plus the X-OV-Groups and X-OV-Entitlements the calling first-party service has just resolved for that person. Without X-OV-Subject the service sees public documents only. Drafts, unpublished and deleted documents are never returned to anyone.</p> <p><strong>search.query.run</strong> (public): Query the network index as anyone (roadmap §30.2 search.query, search.suggest, search.facets.read): anonymous callers get public, published documents only, and a signed-in person's Network token adds the documents whose access list names them or their role. Covers title suggestions, facet counts (facets=, facet.<key>=) and reading one document; a document the caller may not see is the same 404 as a missing one. Served publicly at search.openvibe.network. A first-party service asking for a person uses search.query.delegate (today Search requires that id for any service token).</p>PUT /api/v1/documents/{owner}/{type}/{id}
Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation.
- Capabilities
- search.document.write
- Visibility
- first-party
- Parameters
owner(path, required)type(path, required)id(path, required)
- Request body
application/jsonsearch.document-write-request@1- Response
application/jsonsearch.owner-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.document.write</strong> (first-party): Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation. The owner in the path must be the principal's service slug (svc:wiki writes owner wiki only). Revision-ordered: an older revision never overwrites a newer one, and at equal revision a deletion wins.</p>DELETE /api/v1/documents/{owner}/{type}/{id}
Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation.
- Capabilities
- search.document.write
- Visibility
- first-party
- Parameters
owner(path, required)type(path, required)id(path, required)
- Input
- search.document-write-request@1
- Response
application/jsonsearch.owner-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.document.write</strong> (first-party): Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation. The owner in the path must be the principal's service slug (svc:wiki writes owner wiki only). Revision-ordered: an older revision never overwrites a newer one, and at equal revision a deletion wins.</p>GET /api/v1/owners/{owner}/documents
Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation.
- Capabilities
- search.document.write
- Visibility
- first-party
- Parameters
owner(path, required)
- Input
- search.document-write-request@1
- Response
application/jsonsearch.owner-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.document.write</strong> (first-party): Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation. The owner in the path must be the principal's service slug (svc:wiki writes owner wiki only). Revision-ordered: an older revision never overwrites a newer one, and at equal revision a deletion wins.</p>GET /api/v1/owners/{owner}/documents/{type}/{id}
Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation.
- Capabilities
- search.document.write
- Visibility
- first-party
- Parameters
owner(path, required)type(path, required)id(path, required)
- Input
- search.document-write-request@1
- Response
application/jsonsearch.owner-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.document.write</strong> (first-party): Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation. The owner in the path must be the principal's service slug (svc:wiki writes owner wiki only). Revision-ordered: an older revision never overwrites a newer one, and at equal revision a deletion wins.</p>GET /api/v1/owners/{owner}/rejections
Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation.
- Capabilities
- search.document.write
- Visibility
- first-party
- Parameters
owner(path, required)
- Input
- search.document-write-request@1
- Response
application/jsonsearch.owner-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.document.write</strong> (first-party): Index, replace or tombstone the calling service's own documents (search.index-document@1) and read its own inventory for reconciliation. The owner in the path must be the principal's service slug (svc:wiki writes owner wiki only). Revision-ordered: an older revision never overwrites a newer one, and at equal revision a deletion wins.</p>GET /api/v1/search
Query the index on behalf of a person: X-OV-Subject (usr_/gst_) plus the X-OV-Groups and X-OV-Entitlements the calling first-party service has just resolved for that person.
- Capabilities
- search.query.delegate, search.query.run
- Visibility
- first-party, public
- Parameters
q(query) — Words to match (FTS5; empty lists by recency).owner(query) — One owner service (live, community, wiki, …).type(query) — One document type within the owner (channel, vod, thread, …).lang(query) — BCP 47 language.facets(query) — Comma-separated facet keys to count over what the caller can see.limit(query)cursor(query) — next_cursor of the previous page.
- Input
- search.query@1
- Response
application/jsonsearch.read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>search.query.delegate</strong> (first-party): Query the index on behalf of a person: X-OV-Subject (usr_/gst_) plus the X-OV-Groups and X-OV-Entitlements the calling first-party service has just resolved for that person. Without X-OV-Subject the service sees public documents only. Drafts, unpublished and deleted documents are never returned to anyone.</p> <p><strong>search.query.run</strong> (public): Query the network index as anyone (roadmap §30.2 search.query, search.suggest, search.facets.read): anonymous callers get public, published documents only, and a signed-in person's Network token adds the documents whose access list names them or their role. Covers title suggestions, facet counts (facets=, facet.<key>=) and reading one document; a document the caller may not see is the same 404 as a missing one. Served publicly at search.openvibe.network. A first-party service asking for a person uses search.query.delegate (today Search requires that id for any service token).</p>GET /api/v1/suggest
Query the index on behalf of a person: X-OV-Subject (usr_/gst_) plus the X-OV-Groups and X-OV-Entitlements the calling first-party service has just resolved for that person.
- Capabilities
- search.query.delegate, search.query.run
- Visibility
- first-party, public
- Parameters
q(query) — Words to match (FTS5; empty lists by recency).owner(query) — One owner service (live, community, wiki, …).type(query) — One document type within the owner (channel, vod, thread, …).lang(query) — BCP 47 language.facets(query) — Comma-separated facet keys to count over what the caller can see.limit(query)cursor(query) — next_cursor of the previous page.
- Input
- search.query@1
- Response
application/jsonsearch.read-result@1- Errors
- errors.problem@1 (application/problem+json)