Skip to content

docs: add keywords param to Lightning ASR WS API#45

Closed
abhishekmishragithub wants to merge 1 commit intomainfrom
docs/add-keywords-lightning-asr-ws
Closed

docs: add keywords param to Lightning ASR WS API#45
abhishekmishragithub wants to merge 1 commit intomainfrom
docs/add-keywords-lightning-asr-ws

Conversation

@abhishekmishragithub
Copy link
Copy Markdown
Collaborator

Summary

  • Add keywords query parameter to Lightning ASR WebSocket AsyncAPI spec and API reference pages
  • Param was supported by the API (verified via live WebSocket test) and documented in waves-docs, but missing from fern

Files changed

  • fern/apis/waves/asyncapi/lightning-asr-ws.yaml — base AsyncAPI spec
  • fern/products/waves/pages/v4.0.0/api-references/lightning-asr-ws.mdx — API ref page
  • fern/products/waves/versions/v4.0.0/api-references/lightning-asr-ws.mdx — versioned copy

Test plan

  • Verified keywords param accepted on live Lightning ASR WS endpoint (wss://api.smallest.ai/waves/v1/lightning/get_text)
  • Preview docs render correctly

The keywords param was supported by the API (verified via live test)
and documented in waves-docs but missing from the fern AsyncAPI spec
and API reference pages.
@entelligence-ai-pr-reviews
Copy link
Copy Markdown

entelligence-ai-pr-reviews bot commented Apr 10, 2026

EntelligenceAI PR Summary

This PR adds keywords query parameter support to the Lightning ASR WebSocket API for keyword boosting across the AsyncAPI spec and documentation.

  • Added keywords query parameter to fern/apis/waves/asyncapi/lightning-asr-ws.yaml with comma-separated keyword format and optional intensity multipliers
  • Documented the parameter in both fern/products/waves/pages/v4.0.0/api-references/lightning-asr-ws.mdx and fern/products/waves/versions/v4.0.0/api-references/lightning-asr-ws.mdx
  • Default intensifier value is 1.0; maximum of 100 keywords supported per session
  • Documentation includes usage examples (e.g., NVIDIA:5,Jensen) and links to the Keyword Boosting feature documentation

Confidence Score: 5/5 - Safe to Merge

Safe to merge — this PR makes purely additive documentation changes by introducing the keywords query parameter to the Lightning ASR WebSocket API specification and its corresponding documentation pages. No logic, runtime code, or validation paths are affected; the changes touch only lightning-asr-ws.yaml (AsyncAPI spec) and two .mdx documentation files. The additions accurately describe keyword boosting with comma-separated format and optional intensity multipliers, which is a straightforward documentation enhancement with no risk of regression.

Key Findings:

  • Changes are confined to documentation and API spec files (lightning-asr-ws.yaml, two lightning-asr-ws.mdx files), meaning there is zero runtime impact regardless of any minor inaccuracies.
  • The keywords parameter addition is purely additive — no existing parameters, bindings, or examples are modified, so there is no risk of breaking existing integrations or consumers of the spec.
  • No automated review comments were generated and no pre-existing unresolved concerns exist for this PR, indicating a clean diff with no detectable inconsistencies.
  • Documentation PRs of this nature (AsyncAPI spec + paired MDX pages) follow the established pattern in the repository and maintain internal consistency across both versioned doc paths.
Files requiring special attention
  • fern/apis/waves/asyncapi/lightning-asr-ws.yaml
  • fern/products/waves/pages/v4.0.0/api-references/lightning-asr-ws.mdx
  • fern/products/waves/versions/v4.0.0/api-references/lightning-asr-ws.mdx

@github-actions
Copy link
Copy Markdown

@abhishekmishragithub abhishekmishragithub deleted the docs/add-keywords-lightning-asr-ws branch April 10, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant