Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Spec and Doc fixes for Release 1.3.1 #302

Merged
merged 8 commits into from
Aug 19, 2024
Merged

fix: Spec and Doc fixes for Release 1.3.1 #302

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
143f863
fix: Spec and Doc fixes for Release 1.3.1
kevinshahfws Aug 14, 2024
09a309b
fix: Addressed review comments
kevinshahfws Aug 14, 2024
bc82d26
fix: Addressed review comments
kevinshahfws Aug 14, 2024
4815927
fix: Removed deprecation notes
kevinshahfws Aug 14, 2024
bc0f82d
fix: Few more description changes
kevinshahfws Aug 14, 2024
efc596e
fix: Description fix
kevinshahfws Aug 15, 2024
16673cd
fix: Changed schema component name for HDCP and HDR
kevinshahfws Aug 19, 2024
ba5826a
fix: Component description change
kevinshahfws Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions src/json/firebolt-specification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,6 @@
"negotiable": false
}
},
"xrn:firebolt:capability:privacy:advertising": {
"level": "could"
},
"xrn:firebolt:capability:metrics:distributor": {
"level": "could"
},
Expand Down
24 changes: 14 additions & 10 deletions src/openrpc/_internal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,7 @@
"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
"$ref": "#/components/schemas/InitializeResult"
}
},
"examples": [
Expand Down Expand Up @@ -76,7 +68,19 @@
}
],
"components": {
"schemas": {
"schemas": {
"InitializeResult": {
"title": "InitializeResult",
"type": "object",
"required": ["version"],
"properties": {
"version": {
"$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion",
"description": "The semantic version of the FEE."
}
},
"additionalProperties": false
}
}
}
}
44 changes: 25 additions & 19 deletions src/openrpc/advertising.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@
{
"name": "capabilities",
"x-uses": [
"xrn:firebolt:capability:privacy:advertising",
"xrn:firebolt:capability:advertising:configuration"
"xrn:firebolt:capability:advertising:policy"
]
}
],
Expand Down Expand Up @@ -157,7 +156,7 @@
]
}
],
"summary": "Get the advertising ID",
"summary": "Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings.",
"params": [
{
"name": "options",
Expand All @@ -172,21 +171,7 @@
"name": "advertisingId",
"summary": "the advertising ID",
"schema": {
"type": "object",
"properties": {
"ifa": {
"type": "string"
},
"ifa_type": {
"type": "string"
},
"lmt": {
"type": "string"
}
},
"required": [
"ifa"
]
"$ref": "#/components/schemas/AdvertisingIdResult"
}
},
"examples": [
Expand Down Expand Up @@ -303,7 +288,7 @@
"params": [],
"result": {
"name": "Default Result",
"value": "operator.app"
"value": "app.operator"
}
}
]
Expand Down Expand Up @@ -404,6 +389,27 @@
}
}
}
},
"AdvertisingIdResult": {
"title": "AdvertisingIdResult",
"type": "object",
"properties": {
"ifa": {
"type": "string",
"description": "UUID conforming to IAB standard"
},
"ifa_type": {
"type": "string",
"description": "source of the IFA as defined by IAB"
},
"lmt": {
kevinshahfws marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled"
}
},
"required": [
"ifa"
]
}
}
}
Expand Down
36 changes: 20 additions & 16 deletions src/openrpc/authentication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,7 @@
"name": "token",
"summary": "the token value, type, and expiration",
"schema": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"expires": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
}
},
"required": [
"value"
]
"$ref": "#/components/schemas/AuthenticationTokenResult"
}
},
"examples": [
Expand Down Expand Up @@ -233,6 +218,25 @@
"device",
"distributor"
]
},
"AuthenticationTokenResult": {
"title": "AuthenticationTokenResult",
"type": "object",
"properties": {
"value": {
"type": "string"
},
"expires": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
}
},
"required": [
"value"
]
}
}
}
Expand Down
Loading
Loading