OpenVibe.Watch API
Generated at from
openvibe-contracts v0.112.0 and
openvibe-sdk v0.35.0.
Server https://openvibe.watch. 10 routes performing 4 capabilities. OpenAPI 3.1 document.
GET /api/v1/watches
PLANNED (plan T18; OpenVibe.Watch is not built yet): List and read the acting person's or project's watches: GET /api/v1/watches and GET /api/v1/watches/:id.
- Capabilities
- watch.watch.read
- Visibility
- first-party
- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.read</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): List and read the acting person's or project's watches: GET /api/v1/watches and GET /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>POST /api/v1/watches
PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/wat
- Capabilities
- watch.watch.manage
- Visibility
- first-party
- Request body
application/jsonwatch.watch-request@1- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.manage</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/watches/:id/resume and DELETE /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>GET /api/v1/watches/{id}
PLANNED (plan T18; OpenVibe.Watch is not built yet): List and read the acting person's or project's watches: GET /api/v1/watches and GET /api/v1/watches/:id.
- Capabilities
- watch.watch.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.read</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): List and read the acting person's or project's watches: GET /api/v1/watches and GET /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>PATCH /api/v1/watches/{id}
PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/wat
- Capabilities
- watch.watch.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwatch.watch-request@1- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.manage</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/watches/:id/resume and DELETE /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>DELETE /api/v1/watches/{id}
PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/wat
- Capabilities
- watch.watch.manage
- Visibility
- first-party
- Parameters
id(path, required)name(query)labels(query)source(query)cadence(query)extraction(query)comparison(query)condition(query)action(query)budget(query)retention(query)status(query)
- Input
- watch.watch-request@1
- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.manage</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/watches/:id/resume and DELETE /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>POST /api/v1/watches/{id}/check
PLANNED (plan T18; OpenVibe.Watch is not built yet): Run one check of a watch now, outside its cadence: POST /api/v1/watches/:id/check (409 watch.busy when one is already running).
- Capabilities
- watch.check.run
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwatch.check-run@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.check.run</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Run one check of a watch now, outside its cadence: POST /api/v1/watches/:id/check (409 watch.busy when one is already running). It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the route.</p>GET /api/v1/watches/{id}/checks
PLANNED (plan T18; OpenVibe.Watch is not built yet): Read a watch's observations and check runs: GET /api/v1/watches/:id/observations and GET /api/v1/watches/:id/checks.
- Capabilities
- watch.observation.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwatch.observation@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.observation.read</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Read a watch's observations and check runs: GET /api/v1/watches/:id/observations and GET /api/v1/watches/:id/checks. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>GET /api/v1/watches/{id}/observations
PLANNED (plan T18; OpenVibe.Watch is not built yet): Read a watch's observations and check runs: GET /api/v1/watches/:id/observations and GET /api/v1/watches/:id/checks.
- Capabilities
- watch.observation.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonwatch.observation@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.observation.read</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Read a watch's observations and check runs: GET /api/v1/watches/:id/observations and GET /api/v1/watches/:id/checks. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>POST /api/v1/watches/{id}/pause
PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/wat
- Capabilities
- watch.watch.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwatch.watch-request@1- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>watch.watch.manage</strong> (first-party): PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/watches/:id/resume and DELETE /api/v1/watches/:id. It becomes active, and enters generated/openapi/watch.json, when OpenVibe.Watch implements the routes.</p>POST /api/v1/watches/{id}/resume
PLANNED (plan T18; OpenVibe.Watch is not built yet): Create, change, pause, resume and delete a watch: POST /api/v1/watches, PATCH /api/v1/watches/:id, POST /api/v1/watches/:id/pause, POST /api/v1/wat
- Capabilities
- watch.watch.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonwatch.watch-request@1- Response
application/jsonwatch.watch-result@1- Errors
- errors.problem@1 (application/problem+json)