OpenVibe.Codes API

Generated at from openvibe-contracts v0.177.0 and openvibe-sdk v0.44.0.

Server https://openvibe.codes. 3 routes performing 3 capabilities. OpenAPI 3.1 document.

POST /api/v1/tasks

Start a coding task for a person on their own machine: POST /api/v1/tasks on OpenVibe.Codes, as a first-party service naming the person in X-OV-Subject (OpenVibe.Actor routes coding work here, plan T1

Capabilities
codes.task.start
Visibility
first-party
Request body
application/json codes.task-start-request@1
Response
application/json codes.task-start-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.task.start</strong> (first-party): Start a coding task for a person on their own machine: POST /api/v1/tasks on OpenVibe.Codes, as a first-party service naming the person in X-OV-Subject (OpenVibe.Actor routes coding work here, plan T17). Codes submits it to OpenVibe.Run as that person, in the project of their latest openvibe.codes/run task, and Run places it only on a machine of theirs (platform.resource-offer@1 owner). The person pays nothing to OpenVibe for it: the model use is on their own machine&#39;s keys.</p>

GET /api/v1/tasks/{id}

Read a coding task started through codes.task.start: GET /api/v1/tasks/:id on OpenVibe.Codes, as the service that started it, naming the same person in X-OV-Subject.

Capabilities
codes.task.read
Visibility
first-party
Parameters
  • id (path, required)
Response
application/json codes.task@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.task.read</strong> (first-party): Read a coding task started through codes.task.start: GET /api/v1/tasks/:id on OpenVibe.Codes, as the service that started it, naming the same person in X-OV-Subject. Another service&#39;s task, or another person&#39;s, is 404.</p>

POST /api/v1/tasks/{id}/cancel

Cancel a coding task started through codes.task.start that has not ended: POST /api/v1/tasks/:id/cancel on OpenVibe.Codes, as the service that started it, naming the same person in X-OV-Subject.

Capabilities
codes.task.cancel
Visibility
first-party
Parameters
  • id (path, required)
Response
application/json codes.task@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.task.cancel</strong> (first-party): Cancel a coding task started through codes.task.start that has not ended: POST /api/v1/tasks/:id/cancel on OpenVibe.Codes, as the service that started it, naming the same person in X-OV-Subject. Codes cancels the Run job; the task ends cancelled (an ended one is answered as it is).</p>