Skip to content
Snippets Groups Projects

Update spec to add required fields to make testing more rigid

Merged Martin Lowe requested to merge malowe/main/fix-spec-fields into main
1 file
+ 25
7
Compare changes
  • Side-by-side
  • Inline
+ 25
7
@@ -162,16 +162,32 @@ components:
MailingList:
type: object
additionalProperties: false
required:
- list_name
- project_id
- create_archives
- is_for_news_archives
- is_deleted
- is_disabled
- is_private
- is_subscribable
properties:
list_name:
type: string
description: placeholder
description: Name of the mailing list
list_description:
$ref: "#/components/schemas/NullableString"
description: placeholder
description: Description of the purpose of the mailing list
email:
type: string
description: The email address of the mailing list
url:
type: string
description: Public URL containing records of communication on the mailing list
project_id:
type: string
description: placeholder
description: Project that the mailing list is associated with, if any
list_short_description:
$ref: "#/components/schemas/NullableString"
description: placeholder
@@ -183,16 +199,16 @@ components:
description: placeholder
is_deleted:
type: boolean
description: placeholder
description: Whether the mailbox has been removed and this represents a historical list.
is_disabled:
type: boolean
description: placeholder
description: Whether the mailing list in question is currently active, or has been disabled from distributing messages
is_private:
type: boolean
description: placeholder
is_subscribable:
type: boolean
description: placeholder
description: Whether users can currently subscribe to this mailing list
create_date:
$ref: "#/components/schemas/DateTime"
created_by:
@@ -202,7 +218,9 @@ components:
$ref: "#/components/schemas/NullableString"
description: placeholder
count:
type: integer
type:
- "null"
- integer
description: The number of subscribers for the given list. Only included on singular calls.
MailingListMapping:
Loading