Skip to content

Commit e0f7cf5

Browse files
coadlercoadler
authored
chore: fix postGroupByOrganization swagger tag (coder#7021)
1 parent 391738c commit e0f7cf5

File tree

5 files changed

+74
-74
lines changed

5 files changed

+74
-74
lines changed

‎coderd/apidoc/docs.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/enterprise.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,77 @@ Status Code **200**
492492

493493
To perform this operation, you must be authenticated. [Learn more](authentication.md).
494494

495+
## Create group for organization
496+
497+
### Code samples
498+
499+
```shell
500+
# Example request using curl
501+
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/groups \
502+
-H 'Content-Type: application/json' \
503+
-H 'Accept: application/json' \
504+
-H 'Coder-Session-Token: API_KEY'
505+
```
506+
507+
`POST /organizations/{organization}/groups`
508+
509+
> Body parameter
510+
511+
```json
512+
{
513+
"avatar_url": "string",
514+
"name": "string",
515+
"quota_allowance": 0
516+
}
517+
```
518+
519+
### Parameters
520+
521+
| Name | In | Type | Required | Description |
522+
| -------------- | ---- | -------------------------------------------------------------------- | -------- | -------------------- |
523+
| `organization` | path | string | true | Organization ID |
524+
| `body` | body | [codersdk.CreateGroupRequest](schemas.md#codersdkcreategrouprequest) | true | Create group request |
525+
526+
### Example responses
527+
528+
> 201 Response
529+
530+
```json
531+
{
532+
"avatar_url": "string",
533+
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
534+
"members": [
535+
{
536+
"avatar_url": "http://example.com",
537+
"created_at": "2019-08-24T14:15:22Z",
538+
"email": "user@example.com",
539+
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
540+
"last_seen_at": "2019-08-24T14:15:22Z",
541+
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
542+
"roles": [
543+
{
544+
"display_name": "string",
545+
"name": "string"
546+
}
547+
],
548+
"status": "active",
549+
"username": "string"
550+
}
551+
],
552+
"name": "string",
553+
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
554+
"quota_allowance": 0
555+
}
556+
```
557+
558+
### Responses
559+
560+
| Status | Meaning | Description | Schema |
561+
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------ |
562+
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Group](schemas.md#codersdkgroup) |
563+
564+
To perform this operation, you must be authenticated. [Learn more](authentication.md).
565+
495566
## Get group by organization and group name
496567

497568
### Code samples

‎docs/api/templates.md

Lines changed: 0 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,5 @@
11
# Templates
22

3-
## Create group for organization
4-
5-
### Code samples
6-
7-
```shell
8-
# Example request using curl
9-
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/groups \
10-
-H 'Content-Type: application/json' \
11-
-H 'Accept: application/json' \
12-
-H 'Coder-Session-Token: API_KEY'
13-
```
14-
15-
`POST /organizations/{organization}/groups`
16-
17-
> Body parameter
18-
19-
```json
20-
{
21-
"avatar_url": "string",
22-
"name": "string",
23-
"quota_allowance": 0
24-
}
25-
```
26-
27-
### Parameters
28-
29-
| Name | In | Type | Required | Description |
30-
| -------------- | ---- | -------------------------------------------------------------------- | -------- | -------------------- |
31-
| `organization` | path | string | true | Organization ID |
32-
| `body` | body | [codersdk.CreateGroupRequest](schemas.md#codersdkcreategrouprequest) | true | Create group request |
33-
34-
### Example responses
35-
36-
> 201 Response
37-
38-
```json
39-
{
40-
"avatar_url": "string",
41-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
42-
"members": [
43-
{
44-
"avatar_url": "http://example.com",
45-
"created_at": "2019-08-24T14:15:22Z",
46-
"email": "user@example.com",
47-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
48-
"last_seen_at": "2019-08-24T14:15:22Z",
49-
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
50-
"roles": [
51-
{
52-
"display_name": "string",
53-
"name": "string"
54-
}
55-
],
56-
"status": "active",
57-
"username": "string"
58-
}
59-
],
60-
"name": "string",
61-
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
62-
"quota_allowance": 0
63-
}
64-
```
65-
66-
### Responses
67-
68-
| Status | Meaning | Description | Schema |
69-
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------ |
70-
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Group](schemas.md#codersdkgroup) |
71-
72-
To perform this operation, you must be authenticated. [Learn more](authentication.md).
73-
743
## Get templates by organization
754

765
### Code samples

‎enterprise/coderd/groups.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
// @Security CoderSessionToken
2323
// @Accept json
2424
// @Produce json
25-
// @Tags Templates
25+
// @Tags Enterprise
2626
// @Param request body codersdk.CreateGroupRequest true "Create group request"
2727
// @Param organization path string true "Organization ID"
2828
// @Success 201 {object} codersdk.Group

0 commit comments

Comments
 (0)