Skip to content
This repository has been archived by the owner on Mar 22, 2023. It is now read-only.

Standalone Recording API Docs #411

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

paultrudel
Copy link
Contributor

@paultrudel paultrudel commented Jul 15, 2022

Updates the recording API documentation to reflect the changes to the API that have occurred since it has been moved out of BBB-Web and into its own application.

  • Changes context path to /bigbluebutton/api/v1
  • Adds page and size parameters to getRecordings and getTextTracks requests
  • Adds pagination data to getRecordings and getTextTracks responses
  • Adds new endpoint getMeetingSummary

@paultrudel paultrudel changed the title Recording API Updates Standalone Recording API Docs Jul 25, 2022
<response>
<returncode>SUCCESS</returncode>
<meetingSummary>
contents of events.xml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be the JSON output (in CDATA) from the bbb_events Gem?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be done like that. I simple took the json that is returned from the bbb_events Gem and converted it into xml so that there isn't a mix of both.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the conversion automatic (via a built-in function so there is no maintenance needed as the JSON content expands) and is a one-to-one mapping?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the conversion happens automatically. The events data is stored as raw json in the DB and when it is retrieved it gets converted into xml.

@paultrudel paultrudel marked this pull request as draft January 17, 2023 16:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants