		\| Name \| Type \| Required \| Restrictions \| Description\|
		\| -------- \| ------------------------------------------------------------ \| -------- \| ------------ \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
		\| `action` \| string \| false \| \|\|
		\| `object` \| [codersdk.AuthorizationObject](#codersdkauthorizationobject) \| false \| \| Object can represent a "set" of objects, such as:- Allworkspaces in an organization - Allworkspaces owned by me - Allworkspaces 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. \|

Copy link

MemberAuthor

mtojekJan 5, 2023

Choose a reason for hiding this comment

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

A different source of description?

Copy link

Member

mafredriJan 5, 2023

Choose a reason for hiding this comment

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

I think it's the same source, but parsing might have changed or been broken? Perhaps swagger expects certain type of formatting for lists?

Copy link

MemberAuthor

mtojekJan 10, 2023

Choose a reason for hiding this comment

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

In postprocessing, we're replacing , so maybe it interferes here. As a quick fix, I replaced it with a single-line sentence.

docs/api/schemas.md OutdatedShow resolvedHide resolved

mafredri reviewed

Jan 5, 2023

View reviewed changes

Copy link

Member

mafredri left a comment

Choose a reason for hiding this comment

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

Nice changes all-in-all. Added some comments but I think we'd get pretty far with a simple replace ontime.Duration.

docs/api/agents.md OutdatedShow resolvedHide resolved

docs/api/parameters.md OutdatedShow resolvedHide resolved

docs/api/schemas.md OutdatedShow resolvedHide resolved

docs/api/schemas.md Outdated

		\| Name \| Type \| Required \| Restrictions \| Description\|
		\| -------- \| ------------------------------------------------------------ \| -------- \| ------------ \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
		\| `action` \| string \| false \| \|\|
		\| `object` \| [codersdk.AuthorizationObject](#codersdkauthorizationobject) \| false \| \| Object can represent a "set" of objects, such as:- Allworkspaces in an organization - Allworkspaces owned by me - Allworkspaces 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. \|

Copy link

Member

mafredriJan 5, 2023

Choose a reason for hiding this comment

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

I think it's the same source, but parsing might have changed or been broken? Perhaps swagger expects certain type of formatting for lists?

docs/api/schemas.md OutdatedShow resolvedHide resolved

docs/api/templates.md OutdatedShow resolvedHide resolved

mtojek added7 commits

January 10, 2023 14:07

Merge branch 'main' into try-bump-swaggo

12fbfb5

swaggo: time.Duration

25af4d0

swaggo: provisionertype

7a9b226

Fix: AuthorizationObject

4cf0669

Fix: enums

b0813dd

Fix: netip.Addr

1fe5795

Fix: clickable response properties

c6e3b6d

mtojek marked this pull request as ready for review

January 10, 2023 14:37

mtojek requested a review frombpmct

January 10, 2023 14:37

mtojek mentioned this pull request

Jan 10, 2023

Autogenerated docs for REST API#3522

Closed

29 tasks

mtojek requested a review frommafredri

January 10, 2023 14:40

mafredri approved these changes

Jan 10, 2023

View reviewed changes

Copy link

Member

mafredri left a comment

Choose a reason for hiding this comment

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

This turned out great, nice improvements!

mtojek merged commita23a471 intocoder:main

Jan 10, 2023

github-actionsbot locked and limited conversation to collaborators

Jan 10, 2023

Labels

None yet

2 participants

		\| Name \| Type \| Required \| Restrictions \| Description\|
		\| -------- \| ------------------------------------------------------------ \| -------- \| ------------ \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
		\| `action` \| string \| false \| \|\|
		\| `object` \| [codersdk.AuthorizationObject](#codersdkauthorizationobject) \| false \| \| Object can represent a "set" of objects, such as:- Allworkspaces in an organization - Allworkspaces owned by me - Allworkspaces 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. \|

		\| Name \| Type \| Required \| Restrictions \| Description\|
		\| -------- \| ------------------------------------------------------------ \| -------- \| ------------ \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
		\| `action` \| string \| false \| \|\|
		\| `object` \| [codersdk.AuthorizationObject](#codersdkauthorizationobject) \| false \| \| Object can represent a "set" of objects, such as:- Allworkspaces in an organization - Allworkspaces owned by me - Allworkspaces 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. \|

Movatterモバイル変換

docs: update swaggo/swag v1.8.9#5590

docs: update swaggo/swag v1.8.9#5590

Uh oh!

Conversation

mtojek commentedJan 5, 2023

Uh oh!

mtojek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mtojekJan 5, 2023

Choose a reason for hiding this comment

Uh oh!

mafredriJan 5, 2023

Choose a reason for hiding this comment

Uh oh!

mtojekJan 10, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mafredri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mafredriJan 5, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mafredri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!