diff --git a/apis/pr-app-passthrough-additions/core/Accessibility/index.md b/apis/pr-app-passthrough-additions/core/Accessibility/index.md index 97dfe325d..5fb77f06d 100644 --- a/apis/pr-app-passthrough-additions/core/Accessibility/index.md +++ b/apis/pr-app-passthrough-additions/core/Accessibility/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Accessibility 1.2.1-app-passthrough-additions.0 +Version Accessibility 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Account/index.md b/apis/pr-app-passthrough-additions/core/Account/index.md index d67fc8212..93fc9f764 100644 --- a/apis/pr-app-passthrough-additions/core/Account/index.md +++ b/apis/pr-app-passthrough-additions/core/Account/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Account 1.2.1-app-passthrough-additions.0 +Version Account 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Advertising/index.md b/apis/pr-app-passthrough-additions/core/Advertising/index.md index 1549c7a4a..6dfac11c0 100644 --- a/apis/pr-app-passthrough-additions/core/Advertising/index.md +++ b/apis/pr-app-passthrough-additions/core/Advertising/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Advertising 1.2.1-app-passthrough-additions.0 +Version Advertising 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Authentication/index.md b/apis/pr-app-passthrough-additions/core/Authentication/index.md index a34a66a59..15359e0e9 100644 --- a/apis/pr-app-passthrough-additions/core/Authentication/index.md +++ b/apis/pr-app-passthrough-additions/core/Authentication/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Authentication 1.2.1-app-passthrough-additions.0 +Version Authentication 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Capabilities/index.md b/apis/pr-app-passthrough-additions/core/Capabilities/index.md index 684d00299..63b1c5774 100644 --- a/apis/pr-app-passthrough-additions/core/Capabilities/index.md +++ b/apis/pr-app-passthrough-additions/core/Capabilities/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Capabilities 1.2.1-app-passthrough-additions.0 +Version Capabilities 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Device/index.md b/apis/pr-app-passthrough-additions/core/Device/index.md index 6ffb2ca1a..003ea9491 100644 --- a/apis/pr-app-passthrough-additions/core/Device/index.md +++ b/apis/pr-app-passthrough-additions/core/Device/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Device 1.2.1-app-passthrough-additions.0 +Version Device 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Discovery/index.md b/apis/pr-app-passthrough-additions/core/Discovery/index.md index 56bbd08c8..28291ab8c 100644 --- a/apis/pr-app-passthrough-additions/core/Discovery/index.md +++ b/apis/pr-app-passthrough-additions/core/Discovery/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Discovery 1.2.1-app-passthrough-additions.0 +Version Discovery 1.3.0-app-passthrough-additions.0 ## Table of Contents @@ -3650,7 +3650,7 @@ Suggest a call-to-action for this app on the platform home screen ```typescript function watchNext( title: LocalizedString, - identifiers: Entity, + identifiers: ContentIdentifiers, expires: string, images: object, ): Promise @@ -3658,12 +3658,12 @@ function watchNext( Parameters: -| Param | Type | Required | Description | -| ------------- | ------------------------------------------------------ | -------- | -------------------------------------------------------------------------------------- | -| `title` | [`LocalizedString`](../Types/schemas/#LocalizedString) | true | The title of this call to action | -| `identifiers` | [`Entity`](../Entity/schemas/#Entity) | true | A set of content identifiers for this call to action | -| `expires` | `string` | false | When this call to action should no longer be presented to users
format: date-time | -| `images` | `object` | false | A set of images for this call to action | +| Param | Type | Required | Description | +| ------------- | -------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | +| `title` | [`LocalizedString`](../Types/schemas/#LocalizedString) | true | The title of this call to action | +| `identifiers` | [`ContentIdentifiers`](../Entertainment/schemas/#ContentIdentifiers) | true | A set of content identifiers for this call to action | +| `expires` | `string` | false | When this call to action should no longer be presented to users
format: date-time | +| `images` | `object` | false | A set of images for this call to action | Promise resolution: diff --git a/apis/pr-app-passthrough-additions/core/Internal/index.md b/apis/pr-app-passthrough-additions/core/Internal/index.md index 03e072ffb..3b95b9376 100644 --- a/apis/pr-app-passthrough-additions/core/Internal/index.md +++ b/apis/pr-app-passthrough-additions/core/Internal/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Internal 1.2.1-app-passthrough-additions.0 +Version Internal 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Keyboard/index.md b/apis/pr-app-passthrough-additions/core/Keyboard/index.md index fc814e7e1..560bc6194 100644 --- a/apis/pr-app-passthrough-additions/core/Keyboard/index.md +++ b/apis/pr-app-passthrough-additions/core/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Keyboard 1.2.1-app-passthrough-additions.0 +Version Keyboard 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Lifecycle/index.md b/apis/pr-app-passthrough-additions/core/Lifecycle/index.md index dcff1aeed..c1b475671 100644 --- a/apis/pr-app-passthrough-additions/core/Lifecycle/index.md +++ b/apis/pr-app-passthrough-additions/core/Lifecycle/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Lifecycle 1.2.1-app-passthrough-additions.0 +Version Lifecycle 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Localization/index.md b/apis/pr-app-passthrough-additions/core/Localization/index.md index 26a993201..03d62eb3c 100644 --- a/apis/pr-app-passthrough-additions/core/Localization/index.md +++ b/apis/pr-app-passthrough-additions/core/Localization/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Localization 1.2.1-app-passthrough-additions.0 +Version Localization 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Metrics/index.md b/apis/pr-app-passthrough-additions/core/Metrics/index.md index fea21a9a9..dc3c44e67 100644 --- a/apis/pr-app-passthrough-additions/core/Metrics/index.md +++ b/apis/pr-app-passthrough-additions/core/Metrics/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Metrics 1.2.1-app-passthrough-additions.0 +Version Metrics 1.3.0-app-passthrough-additions.0 ## Table of Contents @@ -19,6 +19,7 @@ Version Metrics 1.2.1-app-passthrough-additions.0 - [Overview](#overview) - [Methods](#methods) - [action](#action) + - [appInfo](#appinfo) - [error](#error) - [mediaEnded](#mediaended) - [mediaLoadStart](#medialoadstart) @@ -132,6 +133,76 @@ Response: --- +### appInfo + +Inform the platform about an app's build info. + +```typescript +function appInfo(build: string): Promise +``` + +Parameters: + +| Param | Type | Required | Description | +| ------- | -------- | -------- | -------------------------------- | +| `build` | `string` | true | The build / version of this app. | + +Promise resolution: + +Capabilities: + +| Role | Capability | +| ---- | --------------------------------------- | +| uses | xrn:firebolt:capability:metrics:general | + +#### Examples + +Send appInfo metric + +JavaScript: + +```javascript +import { Metrics } from '@firebolt-js/sdk' + +let result = await Metrics.appInfo('1.2.2') +console.log(result) +``` + +Value of `result`: + +```javascript +null +``` + +
+JSON-RPC: +Request: + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "method": "Metrics.appInfo", + "params": { + "build": "1.2.2" + } +} +``` + +Response: + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "result": null +} +``` + +
+ +--- + ### error Inform the platform of an error that has occured in your app. diff --git a/apis/pr-app-passthrough-additions/core/Parameters/index.md b/apis/pr-app-passthrough-additions/core/Parameters/index.md index 4f21a5f27..85d542092 100644 --- a/apis/pr-app-passthrough-additions/core/Parameters/index.md +++ b/apis/pr-app-passthrough-additions/core/Parameters/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Parameters 1.2.1-app-passthrough-additions.0 +Version Parameters 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/Profile/index.md b/apis/pr-app-passthrough-additions/core/Profile/index.md index 0cafd6c4a..3a6168e6c 100644 --- a/apis/pr-app-passthrough-additions/core/Profile/index.md +++ b/apis/pr-app-passthrough-additions/core/Profile/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Profile 1.2.1-app-passthrough-additions.0 +Version Profile 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/SecondScreen/index.md b/apis/pr-app-passthrough-additions/core/SecondScreen/index.md index eb0fd4b52..b64d0b48e 100644 --- a/apis/pr-app-passthrough-additions/core/SecondScreen/index.md +++ b/apis/pr-app-passthrough-additions/core/SecondScreen/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecondScreen 1.2.1-app-passthrough-additions.0 +Version SecondScreen 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/core/SecureStorage/index.md b/apis/pr-app-passthrough-additions/core/SecureStorage/index.md index 09f1e9da9..bb8951edb 100644 --- a/apis/pr-app-passthrough-additions/core/SecureStorage/index.md +++ b/apis/pr-app-passthrough-additions/core/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecureStorage 1.2.1-app-passthrough-additions.0 +Version SecureStorage 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/discovery/Content/index.md b/apis/pr-app-passthrough-additions/discovery/Content/index.md index 8deb9cd42..f6a7d4556 100644 --- a/apis/pr-app-passthrough-additions/discovery/Content/index.md +++ b/apis/pr-app-passthrough-additions/discovery/Content/index.md @@ -10,7 +10,7 @@ sdk: discovery --- -Version Content 1.2.1-app-passthrough-additions.0 +Version Content 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/index.md b/apis/pr-app-passthrough-additions/index.md index a2b60771c..1bfaf77c1 100644 --- a/apis/pr-app-passthrough-additions/index.md +++ b/apis/pr-app-passthrough-additions/index.md @@ -449,7 +449,7 @@ The schemas are used to generate SDK and Documentation artifacts. | Uses | | ---- | -| [Metrics.ready](./core/Metrics/#ready)
[Metrics.signIn](./core/Metrics/#signin)
[Metrics.signOut](./core/Metrics/#signout)
[Metrics.startContent](./core/Metrics/#startcontent)
[Metrics.stopContent](./core/Metrics/#stopcontent)
[Metrics.page](./core/Metrics/#page)
[Metrics.action](./core/Metrics/#action)
[Metrics.error](./core/Metrics/#error) | +| [Metrics.ready](./core/Metrics/#ready)
[Metrics.signIn](./core/Metrics/#signin)
[Metrics.signOut](./core/Metrics/#signout)
[Metrics.startContent](./core/Metrics/#startcontent)
[Metrics.stopContent](./core/Metrics/#stopcontent)
[Metrics.page](./core/Metrics/#page)
[Metrics.action](./core/Metrics/#action)
[Metrics.error](./core/Metrics/#error)
[Metrics.appInfo](./core/Metrics/#appinfo) | ### `xrn:firebolt:capability:metrics:media` diff --git a/apis/pr-app-passthrough-additions/manage/Account/index.md b/apis/pr-app-passthrough-additions/manage/Account/index.md index ddd768058..d72668daf 100644 --- a/apis/pr-app-passthrough-additions/manage/Account/index.md +++ b/apis/pr-app-passthrough-additions/manage/Account/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Account 1.2.1-app-passthrough-additions.0 +Version Account 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md b/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md index 6e97d467d..eda99c167 100644 --- a/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md +++ b/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AcknowledgeChallenge 1.2.1-app-passthrough-additions.0 +Version AcknowledgeChallenge 1.3.0-app-passthrough-additions.0 ## Table of Contents @@ -348,12 +348,7 @@ Response: The provider interface for the `xrn:firebolt:capability:usergrant:acknowledgechallenge` capability. ```typescript -interface ChallengeProvider { - challenge( - parameters: object, - session: FocusableProviderSession, - ): Promise -} + ``` Usage: @@ -371,7 +366,9 @@ import { AcknowledgeChallenge } from '@firebolt-js/manage-sdk' class MyChallengeProvider { async challenge(parameters, session) { - return null + return { + granted: true, + } } } @@ -440,7 +437,9 @@ Request: "method": "AcknowledgeChallenge.challengeResponse", "params": { "correlationId": undefined, - "result": null + "result": { + "granted": true + } } } ``` diff --git a/apis/pr-app-passthrough-additions/manage/Advertising/index.md b/apis/pr-app-passthrough-additions/manage/Advertising/index.md index a1fdd2e36..eb42fd797 100644 --- a/apis/pr-app-passthrough-additions/manage/Advertising/index.md +++ b/apis/pr-app-passthrough-additions/manage/Advertising/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Advertising 1.2.1-app-passthrough-additions.0 +Version Advertising 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md b/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md index 4dce71494..e59b8764b 100644 --- a/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md +++ b/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AudioDescriptions 1.2.1-app-passthrough-additions.0 +Version AudioDescriptions 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md b/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md index eb613aac8..090667d6c 100644 --- a/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md +++ b/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version ClosedCaptions 1.2.1-app-passthrough-additions.0 +Version ClosedCaptions 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/Device/index.md b/apis/pr-app-passthrough-additions/manage/Device/index.md index 368d75451..1d14d77dd 100644 --- a/apis/pr-app-passthrough-additions/manage/Device/index.md +++ b/apis/pr-app-passthrough-additions/manage/Device/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Device 1.2.1-app-passthrough-additions.0 +Version Device 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/Discovery/index.md b/apis/pr-app-passthrough-additions/manage/Discovery/index.md index f8b4189b7..753124cb6 100644 --- a/apis/pr-app-passthrough-additions/manage/Discovery/index.md +++ b/apis/pr-app-passthrough-additions/manage/Discovery/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Discovery 1.2.1-app-passthrough-additions.0 +Version Discovery 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md b/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md index a3bbe75c8..8e934338a 100644 --- a/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md +++ b/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version HDMIInput 1.2.1-app-passthrough-additions.0 +Version HDMIInput 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/Keyboard/index.md b/apis/pr-app-passthrough-additions/manage/Keyboard/index.md index 027f5dd3f..d7a25b1d2 100644 --- a/apis/pr-app-passthrough-additions/manage/Keyboard/index.md +++ b/apis/pr-app-passthrough-additions/manage/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Keyboard 1.2.1-app-passthrough-additions.0 +Version Keyboard 1.3.0-app-passthrough-additions.0 ## Table of Contents @@ -708,20 +708,7 @@ Response: The provider interface for the `xrn:firebolt:capability:input:keyboard` capability. ```typescript -interface KeyboardInputProvider { - standard( - parameters: KeyboardParameters, - session: FocusableProviderSession, - ): Promise - password( - parameters: KeyboardParameters, - session: FocusableProviderSession, - ): Promise - email( - parameters: KeyboardParameters, - session: FocusableProviderSession, - ): Promise -} + ``` Usage: diff --git a/apis/pr-app-passthrough-additions/manage/Localization/index.md b/apis/pr-app-passthrough-additions/manage/Localization/index.md index dd08c74b7..3f6069af0 100644 --- a/apis/pr-app-passthrough-additions/manage/Localization/index.md +++ b/apis/pr-app-passthrough-additions/manage/Localization/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Localization 1.2.1-app-passthrough-additions.0 +Version Localization 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/Metrics/index.md b/apis/pr-app-passthrough-additions/manage/Metrics/index.md index bfcf70464..ce7b77a65 100644 --- a/apis/pr-app-passthrough-additions/manage/Metrics/index.md +++ b/apis/pr-app-passthrough-additions/manage/Metrics/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Metrics 1.2.1-app-passthrough-additions.0 +Version Metrics 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/PinChallenge/index.md b/apis/pr-app-passthrough-additions/manage/PinChallenge/index.md index 5b61fca41..e2d2c95e7 100644 --- a/apis/pr-app-passthrough-additions/manage/PinChallenge/index.md +++ b/apis/pr-app-passthrough-additions/manage/PinChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version PinChallenge 1.2.1-app-passthrough-additions.0 +Version PinChallenge 1.3.0-app-passthrough-additions.0 ## Table of Contents @@ -353,12 +353,7 @@ Response: The provider interface for the `xrn:firebolt:capability:usergrant:pinchallenge` capability. ```typescript -interface ChallengeProvider { - challenge( - parameters: object, - session: FocusableProviderSession, - ): Promise -} + ``` Usage: diff --git a/apis/pr-app-passthrough-additions/manage/Privacy/index.md b/apis/pr-app-passthrough-additions/manage/Privacy/index.md index db33adff8..b6fcafe95 100644 --- a/apis/pr-app-passthrough-additions/manage/Privacy/index.md +++ b/apis/pr-app-passthrough-additions/manage/Privacy/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Privacy 1.2.1-app-passthrough-additions.0 +Version Privacy 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/SecureStorage/index.md b/apis/pr-app-passthrough-additions/manage/SecureStorage/index.md index 73d5985b2..99abd8c9f 100644 --- a/apis/pr-app-passthrough-additions/manage/SecureStorage/index.md +++ b/apis/pr-app-passthrough-additions/manage/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version SecureStorage 1.2.1-app-passthrough-additions.0 +Version SecureStorage 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/UserGrants/index.md b/apis/pr-app-passthrough-additions/manage/UserGrants/index.md index 79b92fe0b..ef74a2cb7 100644 --- a/apis/pr-app-passthrough-additions/manage/UserGrants/index.md +++ b/apis/pr-app-passthrough-additions/manage/UserGrants/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version UserGrants 1.2.1-app-passthrough-additions.0 +Version UserGrants 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/VoiceGuidance/index.md b/apis/pr-app-passthrough-additions/manage/VoiceGuidance/index.md index be9c7a08f..908617157 100644 --- a/apis/pr-app-passthrough-additions/manage/VoiceGuidance/index.md +++ b/apis/pr-app-passthrough-additions/manage/VoiceGuidance/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version VoiceGuidance 1.2.1-app-passthrough-additions.0 +Version VoiceGuidance 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/apis/pr-app-passthrough-additions/manage/Wifi/index.md b/apis/pr-app-passthrough-additions/manage/Wifi/index.md index 9f4515326..e800e8df3 100644 --- a/apis/pr-app-passthrough-additions/manage/Wifi/index.md +++ b/apis/pr-app-passthrough-additions/manage/Wifi/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Wifi 1.2.1-app-passthrough-additions.0 +Version Wifi 1.3.0-app-passthrough-additions.0 ## Table of Contents diff --git a/requirements/pr-app-passthrough-additions/specifications/firebolt-open-rpc.json b/requirements/pr-app-passthrough-additions/specifications/firebolt-open-rpc.json index 0662f421d..7a02715a8 100644 --- a/requirements/pr-app-passthrough-additions/specifications/firebolt-open-rpc.json +++ b/requirements/pr-app-passthrough-additions/specifications/firebolt-open-rpc.json @@ -2,7 +2,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.2.1-app-passthrough-additions.0", + "version": "1.3.0-app-passthrough-additions.0", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -7706,7 +7706,7 @@ "name": "identifiers", "summary": "A set of content identifiers for this call to action", "schema": { - "$ref": "#/x-schemas/Entity/Entity" + "$ref": "#/x-schemas/Entertainment/ContentIdentifiers" }, "required": true }, @@ -13988,6 +13988,49 @@ } ] }, + { + "name": "Metrics.appInfo", + "tags": [ + { + "name": "capabilities", + "x-uses": [ + "xrn:firebolt:capability:metrics:general" + ] + } + ], + "summary": "Inform the platform about an app's build info.", + "params": [ + { + "name": "build", + "summary": "The build / version of this app.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "result": { + "name": "result", + "schema": { + "type": "null" + } + }, + "examples": [ + { + "name": "Send appInfo metric", + "params": [ + { + "name": "build", + "value": "1.2.2" + } + ], + "result": { + "name": "result", + "value": null + } + } + ] + }, { "name": "Parameters.initialization", "tags": [ diff --git a/requirements/pr-app-passthrough-additions/specifications/firebolt-specification.json b/requirements/pr-app-passthrough-additions/specifications/firebolt-specification.json index bc7945b68..f6531c4fe 100644 --- a/requirements/pr-app-passthrough-additions/specifications/firebolt-specification.json +++ b/requirements/pr-app-passthrough-additions/specifications/firebolt-specification.json @@ -927,7 +927,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.2.1-app-passthrough-additions.0", + "version": "1.3.0-app-passthrough-additions.0", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -8631,7 +8631,7 @@ "name": "identifiers", "summary": "A set of content identifiers for this call to action", "schema": { - "$ref": "#/x-schemas/Entity/Entity" + "$ref": "#/x-schemas/Entertainment/ContentIdentifiers" }, "required": true }, @@ -14913,6 +14913,49 @@ } ] }, + { + "name": "Metrics.appInfo", + "tags": [ + { + "name": "capabilities", + "x-uses": [ + "xrn:firebolt:capability:metrics:general" + ] + } + ], + "summary": "Inform the platform about an app's build info.", + "params": [ + { + "name": "build", + "summary": "The build / version of this app.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "result": { + "name": "result", + "schema": { + "type": "null" + } + }, + "examples": [ + { + "name": "Send appInfo metric", + "params": [ + { + "name": "build", + "value": "1.2.2" + } + ], + "result": { + "name": "result", + "value": null + } + } + ] + }, { "name": "Parameters.initialization", "tags": [ diff --git a/requirements/pr-app-passthrough-additions/specifications/openrpc-extensions/app-passthrough-apis/index.md b/requirements/pr-app-passthrough-additions/specifications/openrpc-extensions/app-passthrough-apis/index.md index 792a0a50b..37aac8610 100644 --- a/requirements/pr-app-passthrough-additions/specifications/openrpc-extensions/app-passthrough-apis/index.md +++ b/requirements/pr-app-passthrough-additions/specifications/openrpc-extensions/app-passthrough-apis/index.md @@ -116,7 +116,7 @@ The platform method result schema **MUST** either: > Match the `x-response` schema on the provider method so that the result can be passed through. > > or -> +> > Have a property that matches the `x-response-name` string and `x-response` schema on the > provider method so that the result can be composed and passed through. @@ -259,7 +259,7 @@ If the provider method is a "composite request" with `appId` `string` property a ### 7.2 Application Context Setting -When a platform method is invoked, the gateway will find the provider using the `Provider Candidate` rules as described above. However, some Firebolt APIs allow selecting the provider that should be used. If a platform method request schema is a "composite request" with `appId` `string` property at the top level but the provider method request schema is not a composite request, then the given appId shall be used to select the provider. +When a platform method is invoked, the gateway will find the provider using the `Provider Candidate` rules as described above. However, some Firebolt APIs allow selecting the provider that should be used. If a platform method request schema is a "composite request" with `appId` `string` parameter but the provider method request schema is not a composite request, then the given appId shall be used to select the provider. If "appId" is a required parameter in the platform method request schema, then it must be supplied. If it is not, then the request should fail with invalid parameters. If it is an optional parameter and it is not supplied, then the gateway should use rules in "Provider Candidate" section for selecting the candidate. ## 8. API Gateway @@ -473,7 +473,7 @@ Platform Method: "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/EntityDetails" } } - + } } }