improve annotations for endpoint

defelmnq · defelmnq · commit 0796e9c3fcc5 · 2024-11-14T07:27:09.000+01:00
diff --git a/coderd/provisionerkeys.go b/coderd/provisionerkeys.go
@@ -13,7 +13,13 @@ import (
 // Returns tags from a provisioner key.
 // The purpose of this function is to return the provisioner tags
 // associated with the provisioner key using the ID.
-// GET /provisionerkeys/{provisionerkeyid}/tags
+// @Summary Get provisioner key tags by ID
+// @ID get-provisioner-key-tags-by-id
+// @Produce json
+// @Tags Provisioner-Keys
+// @Param provisionerkeyid path string true "Provisioner Key ID" format(uuid)
+// @Success 200 {object} codersdk.ProvisionerKeyTags
+// @Router /provisionerkeys/{provisionerkeyid}/tags [get]
 func (api *API) getProvisionKeyTags(rw http.ResponseWriter, r *http.Request) {
 	var (
 		ctx   = r.Context()
