feat: Update the LiveObjects Rest Documentation

[kaschula]

Description

This PR does the following:

• Deprecate the old Live Objects APIS
• Add Open API specifications for the three new endpoints
• Update the Usage documentation to reflect the new endpoints

Checklist

• [ ] Commits have been rebased.
• [ ] Linting has been run against the changed file(s).
• [ ] The PR adheres to the writing style guide and contribution guide.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch pub-2563-update-live-objects-rest-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[kaschula]

Hi @mschristensen Do you mind having a look at OpenAPI specification for the new endpoints. One thing I wanted to get your thoughts on was the examples for /channels/{channelId}/object/{objectId} endpoint. They currently are the same as the /channels/{channelId}/object endpoint. The difference between these endpoints is a bit nuanced and hard to get across using examples as the endpoints are pretty much the same. I thought maybe I would use the usage docs to describe the difference.

I could write slightly different examples with different data just to make it more interesting to read.

Also I have used the deprecated flag provided by the OpenAPI spec which strikes out the previous endpoints in the menu.

[kaschula]

Hi @mschristensen, I have pushed up the usage docs changes as well

[mschristensen]

Approved - please remember to squash the fixups before merging :)