OpenVibe.Quest API
Generated at from
openvibe-contracts v0.193.1 and
openvibe-sdk v0.48.0.
Server https://openvibe.quest. 3 routes performing 1 capabilities. OpenAPI 3.1 document.
GET /api/v1/app-quests
Define your app's own quests on OpenVibe.Quest (the SDK's moddable quests): PUT /api/v1/app-quests/:slug with quest.app-quest-request@1 creates or replaces one (at most 20 per project), GET /api/v1/ap
- Capabilities
- quest.app_quest.manage
- Visibility
- public
- Parameters
title(query, required)why(query)steps(query, required)badge(query, required)url(query) — Where a person does the steps: the app's own page.status(query) — retired: kept with its completions and badges, no longer counted or listed. Default active.
- Input
- quest.app-quest-request@1
- Response
application/jsonquest.app-quest@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>quest.app_quest.manage</strong> (public): Define your app's own quests on OpenVibe.Quest (the SDK's moddable quests): PUT /api/v1/app-quests/:slug with quest.app-quest-request@1 creates or replaces one (at most 20 per project), GET /api/v1/app-quests lists your project's, DELETE /api/v1/app-quests/:slug retires one (its completions and badges stay). Steps count the project's own events app.<project_key>.<name> at OpenVibe.Events whose actor is a person; only production events count. The reward is a badge named for your app; app quests never pay OpenCoins.</p>PUT /api/v1/app-quests/{slug}
Define your app's own quests on OpenVibe.Quest (the SDK's moddable quests): PUT /api/v1/app-quests/:slug with quest.app-quest-request@1 creates or replaces one (at most 20 per project), GET /api/v1/ap
- Capabilities
- quest.app_quest.manage
- Visibility
- public
- Parameters
slug(path, required)
- Request body
application/jsonquest.app-quest-request@1- Response
application/jsonquest.app-quest@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>quest.app_quest.manage</strong> (public): Define your app's own quests on OpenVibe.Quest (the SDK's moddable quests): PUT /api/v1/app-quests/:slug with quest.app-quest-request@1 creates or replaces one (at most 20 per project), GET /api/v1/app-quests lists your project's, DELETE /api/v1/app-quests/:slug retires one (its completions and badges stay). Steps count the project's own events app.<project_key>.<name> at OpenVibe.Events whose actor is a person; only production events count. The reward is a badge named for your app; app quests never pay OpenCoins.</p>DELETE /api/v1/app-quests/{slug}
Define your app's own quests on OpenVibe.Quest (the SDK's moddable quests): PUT /api/v1/app-quests/:slug with quest.app-quest-request@1 creates or replaces one (at most 20 per project), GET /api/v1/ap
- Capabilities
- quest.app_quest.manage
- Visibility
- public
- Parameters
slug(path, required)title(query, required)why(query)steps(query, required)badge(query, required)url(query) — Where a person does the steps: the app's own page.status(query) — retired: kept with its completions and badges, no longer counted or listed. Default active.
- Input
- quest.app-quest-request@1
- Response
application/jsonquest.app-quest@1- Errors
- errors.problem@1 (application/problem+json)