Skip to content

Commit 54437f2

Browse files
committed
generate doc
1 parent c629f07 commit 54437f2

File tree

7 files changed

+121
-128
lines changed

7 files changed

+121
-128
lines changed

coderd/apidoc/docs.go

+34-41
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

+30-37
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

codersdk/provisionerdaemons.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ func (c *Client) GetProvisionerKey(ctx context.Context, pk string) (ProvisionerK
377377
},
378378
)
379379
if err != nil {
380-
return ProvisionerKey{}, xerrors.Errorf("make request: %w", err)
380+
return ProvisionerKey{}, xerrors.Errorf("request to fetch provisioner key failed: %w", err)
381381
}
382382
defer res.Body.Close()
383383

docs/reference/api/enterprise.md

+44-39
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

enterprise/coderd/coderd.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
346346
Optional: false,
347347
}),
348348
)
349-
r.Get("/{provisionerkey}", api.getProvisionerKey)
349+
r.Get("/{provisionerkey}", api.fetchProvisionerKey)
350350
})
351351
r.Route("/organizations/{organization}/provisionerkeys", func(r chi.Router) {
352352
r.Use(

enterprise/coderd/provisionerkeys.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -200,15 +200,15 @@ func (api *API) deleteProvisionerKey(rw http.ResponseWriter, r *http.Request) {
200200
httpapi.Write(ctx, rw, http.StatusNoContent, nil)
201201
}
202202

203-
// @Summary Get provisioner key details
204-
// @ID get-provisioner-key
205-
// @Security CoderProvisionerDaemonKey
203+
// @Summary Fetch provisioner key details
204+
// @ID fetch-provisioner-key-details
205+
// @Security CoderSessionToken
206206
// @Produce json
207207
// @Tags Enterprise
208208
// @Param provisionerkey path string true "Provisioner Key"
209209
// @Success 200 {object} codersdk.ProvisionerKey
210-
// @Router provisionerkeys/{provisionerkey} [get]
211-
func (*API) getProvisionerKey(rw http.ResponseWriter, r *http.Request) {
210+
// @Router /provisionerkeys/{provisionerkey} [get]
211+
func (*API) fetchProvisionerKey(rw http.ResponseWriter, r *http.Request) {
212212
ctx := r.Context()
213213

214214
pk, ok := httpmw.ProvisionerKeyAuthOptional(r)

enterprise/coderd/provisionerkeys_test.go

+6-4
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ func TestProvisionerKey(t *testing.T) {
139139
t.Run("GetKey", func(t *testing.T) {
140140
t.Parallel()
141141

142-
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
143-
t.Cleanup(cancel)
142+
ctx := testutil.Context(t, testutil.WaitShort)
143+
144144
dv := coderdtest.DeploymentValues(t)
145145
client, owner := coderdenttest.New(t, &coderdenttest.Options{
146146
Options: &coderdtest.Options{
@@ -153,15 +153,17 @@ func TestProvisionerKey(t *testing.T) {
153153
},
154154
})
155155

156+
// nolint:gocritic
156157
key, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
157158
Name: "my-test-key",
158159
Tags: map[string]string{"key1": "value1", "key2": "value2"},
159160
})
160161
require.NoError(t, err)
161162

162-
_, err = client.GetProvisionerKey(ctx, key.Key)
163+
fetchedKey, err := client.GetProvisionerKey(ctx, key.Key)
163164
require.NoError(t, err)
164-
// require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
165+
require.Equal(t, fetchedKey.Name, "my-test-key")
166+
require.Equal(t, fetchedKey.Tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
165167

166168
erroneousPK, err := client.GetProvisionerKey(ctx, "abcdefghijklmnopqrstuvwxyz01234567890123456")
167169
require.Empty(t, erroneousPK)

0 commit comments

Comments
 (0)