Update README and Add Bruno Collection for REST APIs #1988
Conversation
zubeydecivelek
commented
Dec 3, 2024
zubeydecivelek
commented
- Added Table of Contents to the README for better navigation.
- Included the new Publish Video through REST API section in the README with detailed steps.
- Added the exported Bruno REST API collection to the repository.
| - body | ||
| - Language of the video. | ||
| - Optional | ||
| * - **featured** |
There was a problem hiding this comment.
Is this available for anyone or only for admins? If for admins, then we should either remove this from here or specify that it's only open for the admins.
There was a problem hiding this comment.
Yes, you're right it's for admins, I'm removing. Thank you!
There was a problem hiding this comment.
This might be useful for the admins as well. It's ok to keep it, but specify that the access to the action is restricted 😉
There was a problem hiding this comment.
@zubeydecivelek this is restricted to the egroups specified here
| - file | ||
| - body | ||
| - The file to be uploaded. | ||
|
|
There was a problem hiding this comment.
I think we should differentiate the Body parameters and the Queary parameters. So that it's more understandable that in some requests users don't need to provide a body and the query is enough
There was a problem hiding this comment.
They're differentiated using the Location column in the table
There was a problem hiding this comment.
Ok, I see. Thank you for explaining! Then this is fine by me, I don't know maybe @jrcastro2 has some other opinion (reviewed together)
| "params": [], | ||
| "body": { | ||
| "mode": "json", | ||
| "json": "{\n \"_access\": {\n \"update\": [\n \"[email protected]\",\n \"[email protected]\" //Update the access according to category\n ],\n // If you want to restrict the video, update access read\n \"read\": [\n \"[email protected]\"\n ]\n\n }\n}\n\n", |
There was a problem hiding this comment.
maybe add here dummy egroups instead?
README.rst
Outdated
| * - **featured** | ||
| - boolean | ||
| - body | ||
| - Whether the video is featured. (Only available for admins.) |
zubeydecivelek
force-pushed
the
main
branch
3 times, most recently
from
6f913c6 to
cd54808
Compare
