Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 47 additions & 11 deletions docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -16503,21 +16503,21 @@ const docTemplate = `{
]
}
},
"/users/me/digest-subscription": {
"/users/me/subscriptions": {
"get": {
"description": "Gets the current user's digest email subscription status",
"description": "Gets the current user's digest and workflow notification email preferences",
"produces": [
"application/json"
],
"tags": [
"Users"
],
"summary": "Get digest subscription status",
"summary": "Get notification preferences",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-handler_UserHandler"
"$ref": "#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse"
}
},
"401": {
Expand Down Expand Up @@ -16546,7 +16546,7 @@ const docTemplate = `{
]
},
"put": {
"description": "Updates the current user's digest email subscription status",
"description": "Updates the current user's digest and workflow notification email preferences",
"consumes": [
"application/json"
],
Expand All @@ -16556,23 +16556,23 @@ const docTemplate = `{
"tags": [
"Users"
],
"summary": "Update digest subscription status",
"summary": "Update notification preferences",
"parameters": [
{
"description": "Subscription status",
"description": "Notification preferences",
"name": "subscription",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/handler.UserHandler"
"$ref": "#/definitions/handler.UpdateSubscriptionsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-handler_UserHandler"
"$ref": "#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse"
}
},
"400": {
Expand Down Expand Up @@ -20654,14 +20654,14 @@ const docTemplate = `{
}
}
},
"handler.GenericDataResponse-handler_UserHandler": {
"handler.GenericDataResponse-handler_SubscriptionsResponse": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"allOf": [
{
"$ref": "#/definitions/handler.UserHandler"
"$ref": "#/definitions/handler.SubscriptionsResponse"
}
]
}
Expand Down Expand Up @@ -21567,6 +21567,34 @@ const docTemplate = `{
}
}
},
"handler.SubscriptionsResponse": {
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"taskAvailableEmailSubscribed": {
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"type": "boolean"
}
}
},
"handler.UpdateSubscriptionsRequest": {
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"taskAvailableEmailSubscribed": {
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"type": "boolean"
}
}
},
"handler.UserHandler": {
"type": "object"
},
Expand Down Expand Up @@ -29044,6 +29072,14 @@ const docTemplate = `{
"lastName": {
"type": "string"
},
"taskAvailableEmailSubscribed": {
"description": "TaskAvailableEmailSubscribed indicates if the user wants an email when tasks become available",
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"description": "TaskDailyDigestSubscribed indicates if the user wants to receive a daily task digest email",
"type": "boolean"
},
"updatedAt": {
"type": "string"
},
Expand Down
58 changes: 47 additions & 11 deletions docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -16497,21 +16497,21 @@
]
}
},
"/users/me/digest-subscription": {
"/users/me/subscriptions": {
"get": {
"description": "Gets the current user's digest email subscription status",
"description": "Gets the current user's digest and workflow notification email preferences",
"produces": [
"application/json"
],
"tags": [
"Users"
],
"summary": "Get digest subscription status",
"summary": "Get notification preferences",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-handler_UserHandler"
"$ref": "#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse"
}
},
"401": {
Expand Down Expand Up @@ -16540,7 +16540,7 @@
]
},
"put": {
"description": "Updates the current user's digest email subscription status",
"description": "Updates the current user's digest and workflow notification email preferences",
"consumes": [
"application/json"
],
Expand All @@ -16550,23 +16550,23 @@
"tags": [
"Users"
],
"summary": "Update digest subscription status",
"summary": "Update notification preferences",
"parameters": [
{
"description": "Subscription status",
"description": "Notification preferences",
"name": "subscription",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/handler.UserHandler"
"$ref": "#/definitions/handler.UpdateSubscriptionsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-handler_UserHandler"
"$ref": "#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse"
}
},
"400": {
Expand Down Expand Up @@ -20648,14 +20648,14 @@
}
}
},
"handler.GenericDataResponse-handler_UserHandler": {
"handler.GenericDataResponse-handler_SubscriptionsResponse": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"allOf": [
{
"$ref": "#/definitions/handler.UserHandler"
"$ref": "#/definitions/handler.SubscriptionsResponse"
}
]
}
Expand Down Expand Up @@ -21561,6 +21561,34 @@
}
}
},
"handler.SubscriptionsResponse": {
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"taskAvailableEmailSubscribed": {
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"type": "boolean"
}
}
},
"handler.UpdateSubscriptionsRequest": {
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"taskAvailableEmailSubscribed": {
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"type": "boolean"
}
}
},
"handler.UserHandler": {
"type": "object"
},
Expand Down Expand Up @@ -29038,6 +29066,14 @@
"lastName": {
"type": "string"
},
"taskAvailableEmailSubscribed": {
"description": "TaskAvailableEmailSubscribed indicates if the user wants an email when tasks become available",
"type": "boolean"
},
"taskDailyDigestSubscribed": {
"description": "TaskDailyDigestSubscribed indicates if the user wants to receive a daily task digest email",
"type": "boolean"
},
"updatedAt": {
"type": "string"
},
Expand Down
50 changes: 39 additions & 11 deletions docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -785,11 +785,11 @@ definitions:
- $ref: '#/definitions/handler.OscalLikeEvidence'
description: Items from the list response
type: object
handler.GenericDataResponse-handler_UserHandler:
handler.GenericDataResponse-handler_SubscriptionsResponse:
properties:
data:
allOf:
- $ref: '#/definitions/handler.UserHandler'
- $ref: '#/definitions/handler.SubscriptionsResponse'
description: Items from the list response
type: object
handler.GenericDataResponse-oscal_BuildByPropsResponse:
Expand Down Expand Up @@ -1299,6 +1299,24 @@ definitions:
$ref: '#/definitions/handler.StatusCount'
type: array
type: object
handler.SubscriptionsResponse:
properties:
subscribed:
type: boolean
taskAvailableEmailSubscribed:
type: boolean
taskDailyDigestSubscribed:
type: boolean
type: object
handler.UpdateSubscriptionsRequest:
properties:
subscribed:
type: boolean
taskAvailableEmailSubscribed:
type: boolean
taskDailyDigestSubscribed:
type: boolean
type: object
handler.UserHandler:
type: object
handler.createFilterRequest:
Expand Down Expand Up @@ -6248,6 +6266,14 @@ definitions:
type: string
lastName:
type: string
taskAvailableEmailSubscribed:
description: TaskAvailableEmailSubscribed indicates if the user wants an email
when tasks become available
type: boolean
taskDailyDigestSubscribed:
description: TaskDailyDigestSubscribed indicates if the user wants to receive
a daily task digest email
type: boolean
updatedAt:
type: string
userAttributes:
Expand Down Expand Up @@ -17998,16 +18024,17 @@ paths:
summary: Change password for logged-in user
tags:
- Users
/users/me/digest-subscription:
/users/me/subscriptions:
get:
description: Gets the current user's digest email subscription status
description: Gets the current user's digest and workflow notification email
preferences
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.GenericDataResponse-handler_UserHandler'
$ref: '#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse'
"401":
description: Unauthorized
schema:
Expand All @@ -18022,27 +18049,28 @@ paths:
$ref: '#/definitions/api.Error'
security:
- OAuth2Password: []
summary: Get digest subscription status
summary: Get notification preferences
tags:
- Users
put:
consumes:
- application/json
description: Updates the current user's digest email subscription status
description: Updates the current user's digest and workflow notification email
preferences
parameters:
- description: Subscription status
- description: Notification preferences
in: body
name: subscription
required: true
schema:
$ref: '#/definitions/handler.UserHandler'
$ref: '#/definitions/handler.UpdateSubscriptionsRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.GenericDataResponse-handler_UserHandler'
$ref: '#/definitions/handler.GenericDataResponse-handler_SubscriptionsResponse'
"400":
description: Bad Request
schema:
Expand All @@ -18061,7 +18089,7 @@ paths:
$ref: '#/definitions/api.Error'
security:
- OAuth2Password: []
summary: Update digest subscription status
summary: Update notification preferences
tags:
- Users
/workflows/control-relationships:
Expand Down
Loading
Loading