Skip to content
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

adds property description to List and NewList, updates docs #2150

Merged
merged 1 commit into from
Nov 11, 2024
Merged

adds property description to List and NewList, updates docs #2150

Show file tree
Hide file tree
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
8 changes: 6 additions & 2 deletions docs/docs/content/apis/lists.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ Create a new list.
| type | string | Yes | Type of list. Options: private, public. |
| optin | string | Yes | Opt-in type. Options: single, double. |
| tags | string\[\] | | Associated tags for a list. |
| description | string | No | Description of the new list. |

##### Example Request

Expand All @@ -162,7 +163,8 @@ curl -u "username:password" -X POST 'http://localhost:9000/api/lists'
"name": "Test list",
"type": "public",
"tags": [],
"subscriber_count": 0
"subscriber_count": 0,
"description": "This is a test list"
}
}
null
Expand All @@ -183,6 +185,7 @@ Update a list.
| type | string | | Type of list. Options: private, public. |
| optin | string | | Opt-in type. Options: single, double. |
| tags | string\[\] | | Associated tags for the list. |
| description | string | | Description of the new list. |

##### Example Request

Expand All @@ -205,7 +208,8 @@ curl -u "username:password" -X PUT 'http://localhost:9000/api/lists/5' \
"type": "private",
"optin": "single",
"tags": [],
"subscriber_count": 0
"subscriber_count": 0,
"description": "This is a test list"
}
}
```
Expand Down
4 changes: 4 additions & 0 deletions docs/swagger/collections.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3697,6 +3697,8 @@ components:
type: string
subscriber_count:
type: integer
description:
type: string

NewList:
type: object
Expand All @@ -3713,6 +3715,8 @@ components:
type: array
items:
type: string
description:
type: string

ImportStatus:
type: object
Expand Down
Loading