Skip to content

Commit e5b9ac6

Browse files
committed
generate doc
1 parent c629f07 commit e5b9ac6

File tree

6 files changed

+115
-124
lines changed

6 files changed

+115
-124
lines changed

coderd/apidoc/docs.go

Lines changed: 34 additions & 41 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: 30 additions & 37 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/api/enterprise.md

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

enterprise/coderd/coderd.go

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 4 deletions
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
203+
// @Summary Fetch provisioner key details
204+
// @ID fetch-provisioner-key
205205
// @Security CoderProvisionerDaemonKey
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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,10 @@ func TestProvisionerKey(t *testing.T) {
159159
})
160160
require.NoError(t, err)
161161

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

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

0 commit comments

Comments
 (0)