Skip to content

Commit ef213ac

Browse files
committed
More fixes
1 parent 4719a18 commit ef213ac

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

coderd/apidoc/docs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ const docTemplate = `{
744744
]
745745
},
746746
"object": {
747-
"description": "Object can represent a \"set\" of objects, such as:\n- All workspaces in an organization\n- All workspaces owned by me\n- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both ` + "`" + `user` + "`" + ` and ` + "`" + `organization` + "`" + ` owners.",
747+
"description": "Object can represent a \"set\" of objects, such as:\n\t- All workspaces in an organization\n\t- All workspaces owned by me\n\t- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both ` + "`" + `user` + "`" + ` and ` + "`" + `organization` + "`" + ` owners.",
748748
"$ref": "#/definitions/codersdk.AuthorizationObject"
749749
}
750750
}

coderd/apidoc/swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@
648648
"enum": ["create", "read", "update", "delete"]
649649
},
650650
"object": {
651-
"description": "Object can represent a \"set\" of objects, such as:\n- All workspaces in an organization\n- All workspaces owned by me\n- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both `user` and `organization` owners.",
651+
"description": "Object can represent a \"set\" of objects, such as:\n\t- All workspaces in an organization\n\t- All workspaces owned by me\n\t- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both `user` and `organization` owners.",
652652
"$ref": "#/definitions/codersdk.AuthorizationObject"
653653
}
654654
}

codersdk/authorization.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ type AuthorizationRequest struct {
2525
// @Description AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.
2626
type AuthorizationCheck struct {
2727
// Object can represent a "set" of objects, such as:
28-
// - All workspaces in an organization
29-
// - All workspaces owned by me
30-
// - All workspaces across the entire product
28+
// - All workspaces in an organization
29+
// - All workspaces owned by me
30+
// - All workspaces across the entire product
3131
// When defining an object, use the most specific language when possible to
3232
// produce the smallest set. Meaning to set as many fields on 'Object' as
3333
// you can. Example, if you want to check if you can update all workspaces

docs/api/applications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \
2222

2323
### Responses
2424

25-
| Status | Meaning | Description | Schema |
26-
| ------ | ----------------------------------------------------------------------- | ------------------ | --------- |
27-
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | no schema |
25+
| Status | Meaning | Description | Schema |
26+
| ------ | ----------------------------------------------------------------------- | ------------------ | ------ |
27+
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | |
2828

2929
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
3030

docs/api/workspaces.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -707,9 +707,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace} \
707707

708708
### Responses
709709

710-
| Status | Meaning | Description | Schema |
711-
| ------ | --------------------------------------------------------------- | ----------- | --------- |
712-
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | no schema |
710+
| Status | Meaning | Description | Schema |
711+
| ------ | --------------------------------------------------------------- | ----------- | ------ |
712+
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
713713

714714
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
715715

@@ -743,9 +743,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autostart \
743743

744744
### Responses
745745

746-
| Status | Meaning | Description | Schema |
747-
| ------ | --------------------------------------------------------------- | ----------- | --------- |
748-
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | no schema |
746+
| Status | Meaning | Description | Schema |
747+
| ------ | --------------------------------------------------------------- | ----------- | ------ |
748+
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
749749

750750
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
751751

@@ -833,9 +833,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/ttl \
833833

834834
### Responses
835835

836-
| Status | Meaning | Description | Schema |
837-
| ------ | --------------------------------------------------------------- | ----------- | --------- |
838-
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | no schema |
836+
| Status | Meaning | Description | Schema |
837+
| ------ | --------------------------------------------------------------- | ----------- | ------ |
838+
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
839839

840840
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
841841

scripts/apidocgen/markdown-template/responses.def

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
break;
77
}
88
if (!content) {
9-
return "no schema";
9+
return "";
1010
}
1111

1212
var ref = content.schema["x-widdershins-oldRef"];

0 commit comments

Comments
 (0)