Skip to content

Commit 0babb43

Browse files
committed
add better doc description
1 parent 7a19ece commit 0babb43

File tree

4 files changed

+30
-16
lines changed

4 files changed

+30
-16
lines changed

coderd/apidoc/docs.go

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

coderd/apidoc/swagger.json

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

coderd/inboxnotifications.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ func convertInboxNotificationResponse(ctx context.Context, logger slog.Logger, n
6666
// @Param targets query string false "Comma-separated list of target IDs to filter notifications"
6767
// @Param templates query string false "Comma-separated list of template IDs to filter notifications"
6868
// @Param read_status query string false "Filter notifications by read status. Possible values: read, unread, all"
69-
// @Param format query string false "Define the output format for notifications title and body. Possible values: plaintext, markdown"
69+
// @Param format query string false "Define the output format for notifications title and body." enums(plaintext,markdown)
7070
// @Success 200 {object} codersdk.GetInboxNotificationResponse
7171
// @Router /notifications/inbox/watch [get]
7272
func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request) {
@@ -221,7 +221,7 @@ func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request)
221221
// @Param targets query string false "Comma-separated list of target IDs to filter notifications"
222222
// @Param templates query string false "Comma-separated list of template IDs to filter notifications"
223223
// @Param read_status query string false "Filter notifications by read status. Possible values: read, unread, all"
224-
// @Param starting_before query string false "ID of the last notification from the current page. Notifications returned will be older than the associated one"
224+
// @Param starting_before query string false "ID of the last notification from the current page. Notifications returned will be older than the associated one" format(uuid)
225225
// @Success 200 {object} codersdk.ListInboxNotificationsResponse
226226
// @Router /notifications/inbox [get]
227227
func (api *API) listInboxNotifications(rw http.ResponseWriter, r *http.Request) {

docs/reference/api/notifications.md

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

0 commit comments

Comments
 (0)