Skip to content

fix(sat): unify Campaign/CampaignSummary status into a shared enum schema #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dmchaledev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(sat): unify Campaign/CampaignSummary status into a shared enum schema #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions sat/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@
type: boolean
required: [message, success]

CampaignStatus:
type: string
description: >
Lifecycle state of a campaign. Draft/In Review/Approved reflect the
approval workflow (see the submit-review/approve/reject endpoints);
Created/Queued/In progress/Emails Sent/Completed reflect send progress.
enum: [Created, Queued, "In progress", "Emails Sent", Completed, Draft, "In Review", Approved]

CampaignStats:
type: object
properties:
Expand Down Expand Up @@ -122,8 +130,7 @@
type: string
format: date-time
status:
type: string
enum: [Created, Queued, "In progress", "Emails Sent", Completed, Draft, "In Review", Approved]
$ref: '#/components/schemas/CampaignStatus'
stats:
$ref: '#/components/schemas/CampaignStats'

Expand Down Expand Up @@ -165,7 +172,7 @@
type: string
format: date-time
status:
type: string
$ref: '#/components/schemas/CampaignStatus'
template:
$ref: '#/components/schemas/TemplateRef'
page:
Expand Down Expand Up @@ -654,7 +661,7 @@
'503':
description: Not ready

/campaigns/:

Check warning on line 664 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 664 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listCampaigns
tags: [Campaigns]
Expand Down Expand Up @@ -1003,7 +1010,7 @@
'500':
$ref: '#/components/responses/InternalError'

/groups/:

Check warning on line 1013 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1013 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listGroups
tags: [Groups]
Expand Down Expand Up @@ -1110,7 +1117,7 @@
$ref: '#/components/responses/InternalError'

description: Deletes the target group.
/templates/:

Check warning on line 1120 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1120 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listTemplates
tags: [Templates]
Expand Down Expand Up @@ -1209,7 +1216,7 @@
$ref: '#/components/responses/InternalError'

description: Deletes the email template.
/pages/:

Check warning on line 1219 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1219 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listPages
tags: [Landing Pages]
Expand Down Expand Up @@ -1316,7 +1323,7 @@
$ref: '#/components/responses/InternalError'

description: Deletes the landing page.
/smtp/:

Check warning on line 1326 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1326 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listSendingProfiles
tags: [Sending Profiles]
Expand Down Expand Up @@ -1423,7 +1430,7 @@
$ref: '#/components/responses/InternalError'

description: Deletes the SMTP sending profile.
/roles/:

Check warning on line 1433 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1433 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listRoles
tags: [Admin]
Expand All @@ -1449,7 +1456,7 @@
'500':
$ref: '#/components/responses/InternalError'

/users/:

Check warning on line 1459 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1459 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listUsers
tags: [Admin]
Expand Down Expand Up @@ -1651,7 +1658,7 @@
description: SAML SSO is not configured

# ── Webhook payload schema (8.6) ────────────────────────────────────────────
/webhooks/:

Check warning on line 1661 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.

Check warning on line 1661 in sat/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint with Spectral 

path-keys-no-trailing-slash  Path must not end with slash.
get:
operationId: listWebhooks
tags: [Webhooks]
Expand Down
Loading