Firebolt Schema


Version 0.7.0

JSON-Schema

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

Table of Contents

Schemas

FireboltSpecification

type FireboltSpecification = {
  version: string
  capabilities: Capability[]
  methods?: MethodInfo[]
}
Examples

SemanticVersion

type SemanticVersion = string
Examples

Capability

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

Details

A Firebolt Capability that must, should, or could be implemented by a particular Firebolt implementation.


RolePolicy

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

Details

An access policy for a particular role of a capability.


CapabilityKey

type CapabilityKey = string
Examples

UserGrantKey

type UserGrantKey = string
Examples

MethodInfo

type MethodInfo = {
  method: string
  type: 'firebolt' | 'w3c'
  uses?: string[]
  provides?: string[]
  manages?: string[]
}
Examples

Go To Top