OpenVibe.Codes API

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

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

GET /api/v1/apps/{app}/releases

Read public release metadata: an app's published, deprecated and revoked releases with their manifests, compatibility ranges and the app's trust tier (metadata only; it never grants anything).

Capabilities
codes.release.read
Visibility
public
Parameters
  • app (path, required)
Response
application/json codes.release-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.read</strong> (public): Read public release metadata: an app&#39;s published, deprecated and revoked releases with their manifests, compatibility ranges and the app&#39;s trust tier (metadata only; it never grants anything). Drafts are never returned. Public; no token needed.</p>

POST /api/v1/apps/{app}/releases

An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replac

Capabilities
codes.release.manage
Visibility
public
Parameters
  • app (path, required)
Request body
application/json codes.release-manage-request@1
Response
application/json codes.release-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.manage</strong> (public): An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replacement) and revoke it. The token&#39;s sub must be app:&lt;the app in the path&gt;; people manage releases in the portal with their project role instead. Trust tiers are not part of this capability (staff metadata only).</p>

GET /api/v1/apps/{app}/trust

Read public release metadata: an app's published, deprecated and revoked releases with their manifests, compatibility ranges and the app's trust tier (metadata only; it never grants anything).

Capabilities
codes.release.read
Visibility
public
Parameters
  • app (path, required)
Response
application/json codes.release-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.read</strong> (public): Read public release metadata: an app&#39;s published, deprecated and revoked releases with their manifests, compatibility ranges and the app&#39;s trust tier (metadata only; it never grants anything). Drafts are never returned. Public; no token needed.</p>

GET /api/v1/releases/{id}

Read public release metadata: an app's published, deprecated and revoked releases with their manifests, compatibility ranges and the app's trust tier (metadata only; it never grants anything).

Capabilities
codes.release.read
Visibility
public
Parameters
  • id (path, required)
Response
application/json codes.release-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.read</strong> (public): Read public release metadata: an app&#39;s published, deprecated and revoked releases with their manifests, compatibility ranges and the app&#39;s trust tier (metadata only; it never grants anything). Drafts are never returned. Public; no token needed.</p>

POST /api/v1/releases/{id}/deprecate

An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replac

Capabilities
codes.release.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json codes.release-manage-request@1
Response
application/json codes.release-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.manage</strong> (public): An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replacement) and revoke it. The token&#39;s sub must be app:&lt;the app in the path&gt;; people manage releases in the portal with their project role instead. Trust tiers are not part of this capability (staff metadata only).</p>

POST /api/v1/releases/{id}/publish

An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replac

Capabilities
codes.release.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json codes.release-manage-request@1
Response
application/json codes.release-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.manage</strong> (public): An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replacement) and revoke it. The token&#39;s sub must be app:&lt;the app in the path&gt;; people manage releases in the portal with their project role instead. Trust tiers are not part of this capability (staff metadata only).</p>

POST /api/v1/releases/{id}/revoke

An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replac

Capabilities
codes.release.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json codes.release-manage-request@1
Response
application/json codes.release-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>codes.release.manage</strong> (public): An app manages release metadata for ITSELF with its own token (audience openvibe.codes): create a release from a validated app or mod manifest, publish, deprecate (with a reason and an optional replacement) and revoke it. The token&#39;s sub must be app:&lt;the app in the path&gt;; people manage releases in the portal with their project role instead. Trust tiers are not part of this capability (staff metadata only).</p>