-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BREAKING CHANGE: First pass at Lifecycle 2.0 API schemas & tests
- Loading branch information
Showing
62 changed files
with
15,468 additions
and
11,982 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,82 +1,83 @@ | ||
{ | ||
"openrpc": "1.2.4", | ||
"info": { | ||
"title": "Internal", | ||
"description": "Internal methods for SDK / FEE integration", | ||
"version": "0.0.0" | ||
}, | ||
"methods": [ | ||
{ | ||
"name": "initialize", | ||
"tags": [ | ||
{ | ||
"name": "rpc-only" | ||
}, | ||
{ | ||
"name": "capabilities", | ||
"x-uses": [ | ||
"xrn:firebolt:capability:lifecycle:initialize" | ||
] | ||
} | ||
], | ||
"summary": "Initialize the SDK / FEE session.", | ||
"description": "A single version of the Firebolt SDK is compiled into each app. When an app starts up, the SDK **MUST** call this method as soon as possible and **before** any other JSON-RPC methods are sent.", | ||
"params": [ | ||
{ | ||
"name": "version", | ||
"required": true, | ||
"schema": { | ||
"$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion" | ||
}, | ||
"summary": "The semantic version of the SDK." | ||
} | ||
], | ||
"result": { | ||
"name": "session", | ||
"summary": "Info about the SDK/FEE session", | ||
"schema": { | ||
"type": "object", | ||
"required": ["version"], | ||
"properties": { | ||
"version": { | ||
"$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", | ||
"description": "The semantic version of the FEE." | ||
} | ||
}, | ||
"additionalProperties": false | ||
} | ||
}, | ||
"examples": [ | ||
{ | ||
"name": "Default Example", | ||
"params": [ | ||
{ | ||
"name": "version", | ||
"value": { | ||
"major": 1, | ||
"minor": 0, | ||
"patch": 0, | ||
"readable": "Firebolt SDK 1.0.0" | ||
} | ||
} | ||
], | ||
"result": { | ||
"name": "Default Result", | ||
"value": { | ||
"version": { | ||
"major": 1, | ||
"minor": 0, | ||
"patch": 0, | ||
"readable": "Firebolt FEE 1.0.0" | ||
} | ||
} | ||
} | ||
} | ||
] | ||
} | ||
], | ||
"components": { | ||
"schemas": { | ||
} | ||
} | ||
"openrpc": "1.2.4", | ||
"info": { | ||
"title": "Internal", | ||
"description": "Internal methods for SDK / FEE integration", | ||
"version": "0.0.0" | ||
}, | ||
"methods": [ | ||
{ | ||
"name": "initialize", | ||
"tags": [ | ||
{ | ||
"name": "rpc-only" | ||
}, | ||
{ | ||
"name": "capabilities", | ||
"x-uses": [ | ||
"xrn:firebolt:capability:lifecycle:initialize" | ||
] | ||
} | ||
], | ||
"summary": "Initialize the SDK / FEE session.", | ||
"description": "A single version of the Firebolt SDK is compiled into each app. When an app starts up, the SDK **MUST** call this method as soon as possible and **before** any other JSON-RPC methods are sent.", | ||
"params": [ | ||
{ | ||
"name": "version", | ||
"required": true, | ||
"schema": { | ||
"$ref": "https://meta.rdkcentral.com/firebolt/schemas/types#/definitions/SemanticVersion" | ||
}, | ||
"summary": "The semantic version of the SDK." | ||
} | ||
], | ||
"result": { | ||
"name": "session", | ||
"summary": "Info about the SDK/FEE session", | ||
"schema": { | ||
"type": "object", | ||
"required": [ | ||
"version" | ||
], | ||
"properties": { | ||
"version": { | ||
"$ref": "https://meta.rdkcentral.com/firebolt/schemas/types#/definitions/SemanticVersion", | ||
"description": "The semantic version of the FEE." | ||
} | ||
}, | ||
"additionalProperties": false | ||
} | ||
}, | ||
"examples": [ | ||
{ | ||
"name": "Default Example", | ||
"params": [ | ||
{ | ||
"name": "version", | ||
"value": { | ||
"major": 1, | ||
"minor": 0, | ||
"patch": 0, | ||
"readable": "Firebolt SDK 1.0.0" | ||
} | ||
} | ||
], | ||
"result": { | ||
"name": "Default Result", | ||
"value": { | ||
"version": { | ||
"major": 1, | ||
"minor": 0, | ||
"patch": 0, | ||
"readable": "Firebolt FEE 1.0.0" | ||
} | ||
} | ||
} | ||
} | ||
] | ||
} | ||
], | ||
"components": { | ||
"schemas": {} | ||
} | ||
} |
Oops, something went wrong.