Skip to content

Commit

Permalink
fix: Schema links
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinshahfws committed Aug 12, 2024
1 parent 53263a5 commit b373043
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion apis/0.8.1/core/Advertising/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ type AdPolicy = {

See also:

- [SkipRestriction](../schemas/advertising#skiprestriction)
- [SkipRestriction](../Advertising/schemas/#skiprestriction)

---

Expand Down
24 changes: 12 additions & 12 deletions apis/0.8.1/core/Device/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ Promise resolution:

| Type | Description |
| ---- | ----------- |
| [`BooleanMap`](../schemas/types#/definitions/booleanmap) | the supported HDCP profiles |
| [`BooleanMap`](../Types/schemas/#booleanmap) | the supported HDCP profiles |


**Examples**
Expand Down Expand Up @@ -426,7 +426,7 @@ Callback parameters:

| Param | Type | Required | Summary |
| ---------------------- | -------------------- | ------------------------ | ----------------------- |
| `supportedHdcpProfiles` | [`BooleanMap`](../schemas/types#/definitions/booleanmap) | Yes | the supported HDCP profiles |
| `supportedHdcpProfiles` | [`BooleanMap`](../Types/schemas/#booleanmap) | Yes | the supported HDCP profiles |

**Examples**

Expand Down Expand Up @@ -518,7 +518,7 @@ Promise resolution:

| Type | Description |
| ---- | ----------- |
| [`BooleanMap`](../schemas/types#/definitions/booleanmap) | the supported HDR profiles |
| [`BooleanMap`](../Types/schemas/#booleanmap) | the supported HDR profiles |


**Examples**
Expand Down Expand Up @@ -608,7 +608,7 @@ Callback parameters:

| Param | Type | Required | Summary |
| ---------------------- | -------------------- | ------------------------ | ----------------------- |
| `supportedHdrProfiles` | [`BooleanMap`](../schemas/types#/definitions/booleanmap) | Yes | the supported HDR profiles |
| `supportedHdrProfiles` | [`BooleanMap`](../Types/schemas/#booleanmap) | Yes | the supported HDR profiles |

**Examples**

Expand Down Expand Up @@ -1875,10 +1875,10 @@ the versions

| Field | Type | Description |
| ----- | ---- | ----------- |
| `sdk` | [`SemanticVersion`](../schemas/types#/definitions/semanticversion) | The Firebolt SDK version |
| `api` | [`SemanticVersion`](../schemas/types#/definitions/semanticversion) | The lateset Firebolt API vresion supported by the curent device. |
| `firmware` | [`SemanticVersion`](../schemas/types#/definitions/semanticversion) | The device firmware version. |
| `os` | [`SemanticVersion`](../schemas/types#/definitions/semanticversion) | **Deprecated** |
| `sdk` | [`SemanticVersion`](../Types/schemas/#semanticversion) | The Firebolt SDK version |
| `api` | [`SemanticVersion`](../Types/schemas/#semanticversion) | The lateset Firebolt API vresion supported by the curent device. |
| `firmware` | [`SemanticVersion`](../Types/schemas/#semanticversion) | The device firmware version. |
| `os` | [`SemanticVersion`](../Types/schemas/#semanticversion) | **Deprecated** |
| `debug` | `string` | Detail version as a string, for debugging purposes |


Expand Down Expand Up @@ -2248,8 +2248,8 @@ For more information, follow the links under the "Documentation" column.

| JavaScript | RPC | Payload | Documentation |
|------------|-----|---------|---------------|
| hdcpChanged | onHdcpChanged | [BooleanMap](../schemas/types#/definitions/booleanmap) | [hdcp](#hdcp) |
| hdrChanged | onHdrChanged | [BooleanMap](../schemas/types#/definitions/booleanmap) | [hdr](#hdr) |
| hdcpChanged | onHdcpChanged | [BooleanMap](../Types/schemas/#booleanmap) | [hdcp](#hdcp) |
| hdrChanged | onHdrChanged | [BooleanMap](../Types/schemas/#booleanmap) | [hdr](#hdr) |
| audioChanged | onAudioChanged | [AudioProfiles](#audioprofiles) | [audio](#audio) |
| screenResolutionChanged | onScreenResolutionChanged | [number, number] | [screenResolution](#screenresolution) |
| videoResolutionChanged | onVideoResolutionChanged | [number, number] | [videoResolution](#videoresolution) |
Expand Down Expand Up @@ -2317,8 +2317,8 @@ type AudioProfiles = {

See also:

- [BooleanMap](../schemas/types#booleanmap)
- [AudioProfile](../schemas/types#audioprofile)
- [BooleanMap](../Types/schemas/#booleanmap)
- [AudioProfile](../Types/schemas/#audioprofile)

---

Expand Down
16 changes: 8 additions & 8 deletions apis/0.8.1/core/Discovery/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1400,7 +1400,7 @@ Parameters:
| Param | Type | Required | Summary |
| ---------------------- | -------------------- | ------------------------ | ----------------------- |
| `appId` | `string` | true | The durable app Id of the app to launch |
| `intent` | [`NavigationIntent`](../schemas/intents#/definitions/navigationintent) | false | An optional `NavigationIntent` with details about what part of the app to show first, and context around how/why it was launched |
| `intent` | [`NavigationIntent`](../Intents/schemas/#navigationintent) | false | An optional `NavigationIntent` with details about what part of the app to show first, and context around how/why it was launched |


Promise resolution:
Expand Down Expand Up @@ -2997,7 +2997,7 @@ Parameters:

| Param | Type | Required | Summary |
| ---------------------- | -------------------- | ------------------------ | ----------------------- |
| `title` | [`LocalizedString`](../schemas/types#/definitions/localizedstring) | false | The title of this call to action |
| `title` | [`LocalizedString`](../Types/schemas/#localizedstring) | false | The title of this call to action |
| `identifiers` | [`ContentIdentifiers`](#contentidentifiers) | false | 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 <br/>format: date-time |
| `images` | `object` | false | A set of images for this call to action |
Expand Down Expand Up @@ -3107,7 +3107,7 @@ Event value:

| Type | Description |
| ---- | ----------- |
| [`NavigationIntent`](../schemas/intents#/definitions/navigationintent) | A Firebolt compliant representation of a user intention to navigate to a specific place in an app. |
| [`NavigationIntent`](../Intents/schemas/#navigationintent) | A Firebolt compliant representation of a user intention to navigate to a specific place in an app. |


**Examples**
Expand Down Expand Up @@ -3250,7 +3250,7 @@ type EntityInfo = {

See also:

- [ProgramType](../schemas/entertainment#programtype)
- [ProgramType](../Entertainment/schemas/#programtype)

---

Expand Down Expand Up @@ -3312,8 +3312,8 @@ type WayToWatch = {

See also:

- [OfferingType](../schemas/entertainment#offeringtype)
- [AudioProfile](../schemas/types#audioprofile)
- [OfferingType](../Entertainment/schemas/#offeringtype)
- [AudioProfile](../Types/schemas/#audioprofile)

---

Expand Down Expand Up @@ -3506,8 +3506,8 @@ type PurchasedContentParameters = {

See also:

- [OfferingType](../schemas/entertainment#offeringtype)
- [ProgramType](../schemas/entertainment#programtype)
- [OfferingType](../Entertainment/schemas/#offeringtype)
- [ProgramType](../Entertainment/schemas/#programtype)

---

Expand Down
4 changes: 2 additions & 2 deletions apis/0.8.1/core/Discovery/schemas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type PurchasedContentResult = {
See also:
- [EntityInfo](../../schemas/entertainment#entityinfo)
- [EntityInfo](../Entertainment/schemas/#entityinfo)
<details>
Expand Down Expand Up @@ -68,7 +68,7 @@ type EntityInfoResult = {
See also:
- [EntityInfo](../../schemas/entertainment#entityinfo)
- [EntityInfo](../Entertainment/schemas/#entityinfo)
<details>
Expand Down
6 changes: 3 additions & 3 deletions apis/0.8.1/core/Entertainment/schemas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ type EntityInfo = {
See also:
- [ProgramType](../../schemas/entertainment#programtype)
- [ProgramType](../Entertainment/schemas/#programtype)
<details>
Expand Down Expand Up @@ -184,8 +184,8 @@ type WayToWatch = {
See also:
- [OfferingType](../../schemas/entertainment#offeringtype)
- [AudioProfile](../../schemas/types#audioprofile)
- [OfferingType](../Entertainment/schemas/#offeringtype)
- [AudioProfile](../Types/schemas/#audioprofile)
<details>
Expand Down
2 changes: 1 addition & 1 deletion apis/0.8.1/core/Intents/schemas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ type ProgramEntity = {
See also:
- [ProgramType](../../schemas/entertainment#programtype)
- [ProgramType](../Entertainment/schemas/#programtype)
<details>
Expand Down
6 changes: 3 additions & 3 deletions apis/0.8.1/core/Lifecycle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Parameters:

| Param | Type | Required | Summary |
| ---------------------- | -------------------- | ------------------------ | ----------------------- |
| `reason` | [`CloseReason`](../schemas/lifecycle#/definitions/closereason) | true | The reason the app is requesting to be closed |
| `reason` | [`CloseReason`](../Lifecycle/schemas/#closereason) | true | The reason the app is requesting to be closed |


Promise resolution:
Expand Down Expand Up @@ -449,7 +449,7 @@ Promise resolution:

| Type | Description |
| ---- | ----------- |
| [`LifecycleState`](../schemas/lifecycle#/definitions/lifecyclestate) | The application lifecycle state |
| [`LifecycleState`](../Lifecycle/schemas/#lifecyclestate) | The application lifecycle state |


**Examples**
Expand Down Expand Up @@ -946,7 +946,7 @@ type LifecycleEvent = {

See also:

- [LifecycleState](../schemas/lifecycle#lifecyclestate)
- [LifecycleState](../Lifecycle/schemas/#lifecyclestate)

---

Expand Down
4 changes: 2 additions & 2 deletions apis/0.8.1/core/Metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ Parameters:
| `category` | `'user' | 'app'` | true | The category of action being logged. Must be 'user' for user-initated actions or 'app' for all other actions |
| `type` | `string` | true | A short, indexible identifier for the action, e.g. 'SignIn Prompt Displayed' <br/>maxLength: 256
maxLength: 256 |
| `parameters` | [`FlatMap`](../schemas/types#/definitions/flatmap) | false | |
| `parameters` | [`FlatMap`](../Types/schemas/#flatmap) | false | |


Promise resolution:
Expand Down Expand Up @@ -527,7 +527,7 @@ Parameters:
| `code` | `string` | true | an app-specific error code |
| `description` | `string` | true | A short description of the error |
| `visible` | `boolean` | true | Whether or not this error was visible to the user. |
| `parameters` | [`FlatMap`](../schemas/types#/definitions/flatmap) | false | Optional additional parameters to be logged with the error |
| `parameters` | [`FlatMap`](../Types/schemas/#flatmap) | false | Optional additional parameters to be logged with the error |


Promise resolution:
Expand Down
4 changes: 2 additions & 2 deletions apis/0.8.1/core/Parameters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ type AppInitialization = {

See also:

- [NavigationIntent](../schemas/intents#navigationintent)
- [SecondScreenEvent](../schemas/secondscreen#secondscreenevent)
- [NavigationIntent](../Intents/schemas/#navigationintent)
- [SecondScreenEvent](../SecondScreen/schemas/#secondscreenevent)

---

Expand Down
2 changes: 1 addition & 1 deletion apis/0.8.1/core/Profile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Promise resolution:

| Type | Description |
| ---- | ----------- |
| [`FlatMap`](../schemas/types#/definitions/flatmap) | The profile flags. |
| [`FlatMap`](../Types/schemas/#flatmap) | The profile flags. |


**Examples**
Expand Down
6 changes: 3 additions & 3 deletions apis/0.8.1/core/SecondScreen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ Promise resolution:

| Type | Description |
| ---- | ----------- |
| [`BooleanMap`](../schemas/types#/definitions/booleanmap) | the supported protocols |
| [`BooleanMap`](../Types/schemas/#booleanmap) | the supported protocols |


**Examples**
Expand Down Expand Up @@ -501,7 +501,7 @@ Event value:

| Type | Description |
| ---- | ----------- |
| [`SecondScreenEvent`](../schemas/secondscreen#/definitions/secondscreenevent) | An a message notification from a second screen device |
| [`SecondScreenEvent`](../SecondScreen/schemas/#secondscreenevent) | An a message notification from a second screen device |


**Examples**
Expand Down Expand Up @@ -572,7 +572,7 @@ Event value:

| Type | Description |
| ---- | ----------- |
| [`SecondScreenEvent`](../schemas/secondscreen#/definitions/secondscreenevent) | An a message notification from a second screen device |
| [`SecondScreenEvent`](../SecondScreen/schemas/#secondscreenevent) | An a message notification from a second screen device |


**Examples**
Expand Down

0 comments on commit b373043

Please sign in to comment.