Repository navigation
docs: update swaggo/swag v1.8.9 - #5590
Conversation
| | Name | Type | Required | Restrictions | Description | | ||
| | -------- | ------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | `action` | string | false | | | | ||
| | `object` | [codersdk.AuthorizationObject](#codersdkauthorizationobject) | false | | Object can represent a "set" of objects, such as: - All workspaces in an organization - All workspaces owned by me - All workspaces across the entire product When defining an object, use the most specific language when possible to produce the smallest set. Meaning to set as many fields on 'Object' as you can. Example, if you want to check if you can update all workspaces owned by 'me', try to also add an 'OrganizationID' to the settings. Omitting the 'OrganizationID' could produce the incorrect value, as workspaces have both `user` and `organization` owners. | |
There was a problem hiding this comment.
A different source of description?
There was a problem hiding this comment.
I think it's the same source, but parsing might have changed or been broken? Perhaps swagger expects certain type of formatting for lists?
There was a problem hiding this comment.
In postprocessing, we're replacing , so maybe it interferes here. As a quick fix, I replaced it with a single-line sentence.
mafredri
left a comment
There was a problem hiding this comment.
Nice changes all-in-all. Added some comments but I think we'd get pretty far with a simple replace on time.Duration.
| | Name | Type | Required | Restrictions | Description | | ||
| | -------- | ------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | `action` | string | false | | | | ||
| | `object` | [codersdk.AuthorizationObject](#codersdkauthorizationobject) | false | | Object can represent a "set" of objects, such as: - All workspaces in an organization - All workspaces owned by me - All workspaces across the entire product When defining an object, use the most specific language when possible to produce the smallest set. Meaning to set as many fields on 'Object' as you can. Example, if you want to check if you can update all workspaces owned by 'me', try to also add an 'OrganizationID' to the settings. Omitting the 'OrganizationID' could produce the incorrect value, as workspaces have both `user` and `organization` owners. | |
There was a problem hiding this comment.
I think it's the same source, but parsing might have changed or been broken? Perhaps swagger expects certain type of formatting for lists?
mafredri
left a comment
There was a problem hiding this comment.
This turned out great, nice improvements!
Related: #5538 (comment)