docs: Add OpenRPC specs for implemented APIs #23
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull request overview
This pull request adds OpenRPC specification files for various implemented APIs to the repository. The changes include new API specifications, schema definitions, templates, and updates to build configuration and CI/CD workflows.
Changes:
- Added OpenRPC specifications for 9 APIs (Accessibility, Advertising, Device, Display, Lifecycle2, Localization, Presentation, Stats, and Internal)
- Added schema definitions for types, localization, and accessibility
- Updated existing spec files with new version strings and parameter flattening tags
- Added template files for OpenRPC generation
- Updated CI/CD workflows to reference new file paths
Reviewed changes
Copilot reviewed 18 out of 20 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/openrpc/the-spec/firebolt-open-rpc.json | Updated version to empty string, added x-notifier-params-flattening tags |
| docs/openrpc/the-spec/firebolt-app-open-rpc.json | Updated version to empty string, added x-notifier-params-flattening tags |
| docs/openrpc/template/openrpc/template.json | New template for OpenRPC generation with rpc.discover method |
| docs/openrpc/template/declarations/template.d.ts | New TypeScript declarations template for SDK generation |
| docs/openrpc/schemas/types.json | New schema definitions for common types (SemanticVersion, AudioProfile, etc.) |
| docs/openrpc/schemas/localization.json | New schema for localization types (CountryCode, ISO639_2Language, Locale) |
| docs/openrpc/schemas/accessibility.json | New schema for accessibility types (ClosedCaptionsStyles, VoiceGuidanceSettings) |
| docs/openrpc/package.json | New build configuration for OpenRPC compilation |
| docs/openrpc/package-lock.json | NPM dependencies lock file (1922 lines) |
| docs/openrpc/openrpc/stats.json | New Stats API specification for memory usage |
| docs/openrpc/openrpc/presentation.json | New Presentation API for focus state |
| docs/openrpc/openrpc/localization.json | New Localization API for country, language preferences |
| docs/openrpc/openrpc/lifecycle2.json | New Lifecycle2 API for app lifecycle management |
| docs/openrpc/openrpc/display.json | New Display API for display size and resolution |
| docs/openrpc/openrpc/device.json | New Device API for device information |
| docs/openrpc/openrpc/advertising.json | New Advertising API for advertising ID |
| docs/openrpc/openrpc/accessibility.json | New Accessibility API for accessibility settings |
| docs/openrpc/openrpc/_internal.json | New Internal API for SDK/FEE initialization |
| docs/openrpc/descriptions/modules/discovery/EntityInfo.md | New documentation for EntityInfo objects |
| .github/workflows/ci.yml | Updated paths to reference new spec file locations |
Files not reviewed (1)
- docs/openrpc/package-lock.json: Language not supported
Comments suppressed due to low confidence (3)
docs/openrpc/the-spec/firebolt-app-open-rpc.json:5
- The version field is set to an empty string. This should either be a valid semantic version (e.g., "1.0.0") or if it's intentionally a placeholder, consider using a more explicit placeholder like "0.0.0" or adding a comment explaining why it's empty.
docs/openrpc/the-spec/firebolt-open-rpc.json:5 - The version field is set to an empty string. This should either be a valid semantic version (e.g., "1.0.0") or if it's intentionally a placeholder, consider using a more explicit placeholder like "0.0.0" or adding a comment explaining why it's empty.
docs/openrpc/the-spec/firebolt-open-rpc.json:8 - The description contains two spelling errors: "o" should be "to" and "seprate" should be "separate".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
vladimir-rangelov
previously approved these changes
Jan 20, 2026
Contributor
|
b'## WARNING: A Blackduck scan failure has been waived A prior failure has been upvoted
|
tomasz-blasz
force-pushed
the
topic/schema-definitions
branch
from
af60570 to
604fe29
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 17 out of 19 changed files in this pull request and generated 1 comment.
Files not reviewed (1)
- docs/openrpc/package-lock.json: Language not supported
Comments suppressed due to low confidence (3)
docs/openrpc/the-spec/firebolt-open-rpc.json:5
- The version field is set to an empty string. An empty version string is not a valid semantic version. Consider using a valid version like "0.0.0" or "1.0.0".
docs/openrpc/the-spec/firebolt-app-open-rpc.json:5 - The version field is set to an empty string. An empty version string is not a valid semantic version. Consider using a valid version like "0.0.0" or "1.0.0".
docs/openrpc/the-spec/firebolt-open-rpc.json:7 - There are multiple spelling errors in this description:
- "o respect" should be "to respect"
- "seprate" should be "separate"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tomasz-blasz
force-pushed
the
topic/schema-definitions
branch
from
604fe29 to
58cad01
Compare
vladimir-rangelov
approved these changes
Jan 21, 2026
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.