-
Notifications
You must be signed in to change notification settings - Fork 19
FireboltSchema
LaCivita, Jeremy edited this page May 26, 2022
·
7 revisions
Version The Firebolt JS Manage SDK [Alpha 4]
This document was generated from a JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.
For the full schema, see the link below.
Schema |
---|
firebolt.json |
- Schemas
type FireboltSpecification = {
version: string
capabilities: Capability[]
methods?: MethodInfo[]
}
Examples
type SemanticVersion = string
Examples
type Capability = {
id: string
level: 'must' | 'should' | 'could' // Whether this capabilty is a compliance requirement, a compliance recommendation, or optional.
use: RolePolicy // An access policy for a particular role of a capability.
manage: RolePolicy // An access policy for a particular role of a capability.
provide: RolePolicy // An access policy for a particular role of a capability.
delegable?: boolean // Whether this capability may be provided by applications.
}
Examples
A Firebolt Capability that must, should, or could be implemented by a particular Firebolt implementation.
type RolePolicy = {
public?: boolean // May this capability & role be assigned to applications by distributors.
negotiable: boolean // May this policy be overridden by Firebolt distributors.
}
Examples
An access policy for a particular role of a capability.
type CapabilityKey = string
Examples
type UserGrantKey = string
Examples
type MethodInfo = {
method: string
type: 'firebolt' | 'w3c'
uses?: string[]
provides?: string[]
manages?: string[]
}