readme updates#1230
Conversation
will merge after api release
davidzhao
added
the
internal
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
|
|
||
| The official server API crate for [LiveKit](https://livekit.com). | ||
|
|
||
| Use this crate to generate access tokens and invoke LiveKit server APIs for agent dispatch, ingress, egress, SIP, and more. | ||
| Use this crate to generate access tokens and invoke LiveKit server APIs for rooms, egress, ingress, SIP, agent dispatch, and more. |
There was a problem hiding this comment.
🟡 Missing changeset file required by repository rules
No changeset file was added for this PR (livekit-api/README.md change), violating the repository's mandatory changeset requirement.
Impact: The PR cannot be properly tracked for release notes and version bumping.
Changeset requirement from AGENTS.md
AGENTS.md states: "Every PR needs a changeset" and "Changeset must list any crates which need to be bumped stemming from the change." Since the README is referenced in livekit-api/Cargo.toml:8 via readme = "README.md", it is part of the published crate and a changeset documenting at least a patch bump for livekit-api should be included. Changesets are created via knope document-change or manually in /.changeset.
(Refers to lines 1-5)
Was this helpful? React with 👍 or 👎 to provide feedback.
| .create_sip_participant( | ||
| "ST_trunk".to_owned(), | ||
| "+15105550100".to_owned(), | ||
| "my-room".to_owned(), | ||
| CreateSIPParticipantOptions { | ||
| wait_until_answered: Some(true), | ||
| ..Default::default() | ||
| }, | ||
| None, | ||
| ) | ||
| .await; |
There was a problem hiding this comment.
🔍 SIP example function takes owned String parameters rather than &str
The create_sip_participant example at livekit-api/README.md:95-104 passes .to_owned() strings because the actual function signature at livekit-api/src/services/sip.rs:650-656 takes String parameters (not &str). AGENTS.md recommends "Functions should generally accept &str/&[T] rather than String/Vec<T>". This is a pre-existing API design concern (not introduced by this README PR), but worth noting if the SIP client API is ever revised — switching to &str / impl Into<String> would make the API more ergonomic and consistent with other service methods like RoomClient::create_room and RoomClient::delete_room which already accept &str.
Was this helpful? React with 👍 or 👎 to provide feedback.
2 participants
will merge after api release