8000 chore: remove documented groups endpoint that doesn't exist (#7020) · sarvex/coder@391738c · GitHub
[go: up one dir, main page]
Skip to content

Commit 391738c

Browse files
coadlercoadler
authored
chore: remove documented groups endpoint that doesn't exist (coder#7020)
1 parent 865c8b7 commit 391738c

File tree

7 files changed

+4
-177
lines changed

7 files changed

+4
-177
lines changed

‎coderd/apidoc/docs.go

Lines changed: 0 additions & 38 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 0 additions & 34 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/enterprise.md

Lines changed: 0 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -148,99 +148,6 @@ curl -X GET http://coder-server:8080/api/v2/entitlements \
148148

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

151-
## Get groups
152-
153-
### Code samples
154-
155-
```shell
156-
# Example request using curl
157-
curl -X GET http://coder-server:8080/api/v2/groups \
158-
-H 'Accept: application/json' \
159-
-H 'Coder-Session-Token: API_KEY'
160-
```
161-
162-
`GET /groups`
163-
164-
### Parameters
165-
166-
| Name | In | Type | Required | Description |
167-
| -------------- | ---- | ------------ | -------- | --------------- |
168-
| `organization` | path | string(uuid) | true | Organization ID |
169-
170-
### Example responses
171-
172-
> 200 Response
173-
174-
```json
175-
[
176-
{
177-
"avatar_url": "string",
178-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
179-
"members": [
180-
{
181-
"avatar_url": "http://example.com",
182-
"created_at": "2019-08-24T14:15:22Z",
183-
"email": "user@example.com",
184-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
185-
"last_seen_at": "2019-08-24T14:15:22Z",
186-
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
187-
"roles": [
188-
{
189-
"display_name": "string",
190-
"name": "string"
191-
}
192-
],
193-
"status": "active",
194-
"username": "string"
195-
}
196-
],
197-
"name": "string",
198-
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
199-
"quota_allowance": 0
200-
}
201-
]
202-
```
203-
204-
### Responses
205-
206-
| Status | Meaning | Description | Schema |
207-
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------- |
208-
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Group](schemas.md#codersdkgroup) |
209-
210-
<h3 id="get-groups-responseschema">Response Schema</h3>
211-
212-
Status Code **200**
213-
214-
| Name | Type | Required | Restrictions | Description |
215-
| --------------------- | ---------------------------------------------------- | -------- | ------------ | ----------- |
216-
| `[array item]` | array | false | | |
217-
| `» avatar_url` | string | false | | |
218-
| `» id` | string(uuid) | false | | |
219-
| `» members` | array | false | | |
220-
| `»» avatar_url` | string(uri) | false | | |
221-
| `»» created_at` | string(date-time) | true | | |
222-
| `»» email` | string(email) | true | | |
223-
| `»» id` | string(uuid) | true | | |
224-
| `»» last_seen_at` | string(date-time) | false | | |
225-
| `»» organization_ids` | array | false | | |
226-
| `»» roles` | array | false | | |
227-
| `»»» display_name` | string | false | | |
228-
| `»»» name` | string | false | | |
229-
| `»» status` | [codersdk.UserStatus](schemas.md#codersdkuserstatus) | false | | |
230-
| `»» username` | string | true | | |
231-
| `» name` | string | false | | |
232-
| `» organization_id` | string(uuid) | false | | |
233-
| `» quota_allowance` | integer | false | | |
234-
235-
#### Enumerated Values
236-
237-
| Property | Value |
238-
| -------- | ----------- |
239-
| `status` | `active` |
240-
| `status` | `suspended` |
241-
242-
To perform this operation, you must be authenticated. [Learn more](authentication.md).
243-
244151
## Get group by name
245152

246153
### Code samples

‎enterprise/coderd/coderd.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,13 @@ func New(ctx context.Context, options *Options) (*API, error) {
8989
r.Post("/", api.postWorkspaceProxy)
9090
r.Get("/", api.workspaceProxies)
9191
// TODO: Add specific workspace proxy endpoints.
92-
//r.Route("/{proxyName}", func(r chi.Router) {
92+
// r.Route("/{proxyName}", func(r chi.Router) {
9393
// r.Use(
9494
// httpmw.ExtractWorkspaceProxyByNameParam(api.Database),
9595
// )
9696
//
9797
// r.Get("/", api.workspaceProxyByName)
98-
//})
98+
// })
9999
})
100100
r.Route("/organizations/{organization}/groups", func(r chi.Router) {
101101
r.Use(

‎enterprise/coderd/groups.go

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -350,14 +350,6 @@ func (api *API) groupsByOrganization(rw http.ResponseWriter, r *http.Request) {
350350
api.groups(rw, r)
351351
}
352352

353-
// @Summary Get groups
354-
// @ID get-groups
355-
// @Security CoderSessionToken
356-
// @Produce json
357-
// @Tags Enterprise
358-
// @Param organization path string true "Organization ID" format(uuid)
359-
// @Success 200 {array} codersdk.Group
360-
// @Router /groups [get]
361353
func (api *API) groups(rw http.ResponseWriter, r *http.Request) {
362354
var (
363355
ctx = r.Context()

‎enterprise/coderd/workspaceproxy.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ import (
66
"net/http"
77
"net/url"
88

9+
"github.com/google/uuid"
910
"golang.org/x/xerrors"
1011

1112
"github.com/coder/coder/coderd/audit"
1213
"github.com/coder/coder/coderd/database"
1314
"github.com/coder/coder/coderd/httpapi"
1415
"github.com/coder/coder/codersdk"
15-
"github.com/google/uuid"
1616
)
1717

1818
// @Summary Create workspace proxy

‎enterprise/coderd/workspaceproxy_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ import (
44
"testing"
55

66
"github.com/moby/moby/pkg/namesgenerator"
7+
"github.com/stretchr/testify/require"
78

89
"github.com/coder/coder/coderd/coderdtest"
910
"github.com/coder/coder/codersdk"
1011
"github.com/coder/coder/enterprise/coderd/coderdenttest"
1112
"github.com/coder/coder/enterprise/coderd/license"
1213
"github.com/coder/coder/testutil"
13-
"github.com/stretchr/testify/require"
1414
)
1515

1616
func TestWorkspaceProxyCRUD(t *testing.T) {

0 commit comments

Comments
 (0)
0