Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@firebolt-js/openrpc
Advanced tools
Tools to enable consistent Firebolt SDK and document generation.
Version 2.0 of firebolt-openrpc
has two major changes.
The openrpc
task takes a single OpenRPC document and "Fireboltizes" it, i.e. Interprets Firebolt method tags and inserts external Markdown descriptions via JSON-Schema $ref.
This task continues to support a directory of modules and will merge and Fireboltize them into a single file.
To support outputting multipel SDK's, there is a new slice
task. This task takes a single OpenRPC document and slices it into separate OpenRPC documents based on a provided sdk.config.json
, e.g.:
{
"info": {
"title": "Firebolt Core SDK",
},
"methods": [
{
"module": "Lifecycle",
"use": [
"xrn:firebolt:capability:lifecycle:ready"
"xrn:firebolt:capability:lifecycle:ready"
],
"manage": [],
"provide": [
"xrn:firebolt:capability:discovery:entityInfo",
"xrn:firebolt:capability:discovery:purchases"
]
}
]
}
The info.title
attribute is copied to the output, and each entry in the methods
array is used to query methods from the input using module names and capabilities.
Any info.x-
extension attributes will also be copied from the sdk.config.json into the output OpenRPC document.
Generally, this task is run using the output of the openrpc
task as input, however, it's not required.
Wildcards are supported in module
as well as use
, manage
, and provide
.
These tasks all take a single OpenRPC document and generate their respective artifacts.
They all have the same arguments and are all implemented using shared code for more consistency.
--input: The input OpenRPC document --output: The output location --template: An optional template directory for adding to and overriding the built in templates
Module.listen('eventName')
Indicated by --task validate
. Reads and validates a corpus of individual OpenRPC documents and validates the result of assembling them together into a single OpenRPC document.
FAQs
The Firebolt SDK Code & Doc Generator
We found that @firebolt-js/openrpc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.