docs: add actorPermissionLevel to OpenAPI spec
#2135
Conversation
stepskop
added
the
t-core-services
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
| enum: | ||
| - LIMITED_PERMISSIONS | ||
| - FULL_PERMISSIONS |
There was a problem hiding this comment.
This could probably be made into a reusable component, but not really worth it, I guess
There was a problem hiding this comment.
I think if we start autogenerating clients one day, it will be really helpful to have as much as possible in reusable components, so that we can link them e.g. to TypeScript constants easily.
barjin
left a comment
barjin
left a comment
There was a problem hiding this comment.
Please resolve my comments and feel free to merge (approving now to make things faster)
| actorPermissionLevel: | ||
| type: string | ||
| enum: | ||
| - LIMITED_PERMISSIONS | ||
| - FULL_PERMISSIONS | ||
| example: LIMITED_PERMISSIONS |
There was a problem hiding this comment.
the indentation doesn't match the rest of the document
| example: false | ||
| actorPermissionLevel: | ||
| type: string | ||
| nullable: true |
There was a problem hiding this comment.
Can we add a description field with a simple text description (to both locations)? A few words and a link to docs would suffice really :)
fnesveda
left a comment
fnesveda
left a comment
There was a problem hiding this comment.
Looks good, nothing to add to Jindra's and Honza's comments 🙂
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Extracted it to a component. Added description with the link to Actor permissions docs. |
Adds missing
actorPermissionLevelto the Actor's OpenAPI spec.Note
Adds
actorPermissionLevelenum field toActorandUpdateActorRequestschemas and includes it in Update Actor request/response examples.components/schemas/actors/Actor.yaml: AddactorPermissionLevel(LIMITED_PERMISSIONS|FULL_PERMISSIONS, nullable) with example.components/schemas/actors/UpdateActorRequest.yaml: AddactorPermissionLevel(same enum/nullable) with example.paths/actors/acts@{actorId}.yaml(PUT Update Actor): IncludeactorPermissionLevelin request body example and response example.Written by Cursor Bugbot for commit bb08633. Configure here.