Skip to content

Commit d4167da

Browse files
committed
docs(api): return member notify outcomes as recipients
An items array beside scalar fields reads as a list page, and the CLI bounds list pages by withholding rows. A dry run's html sibling made every realistic email overflow that bound. Naming the per-recipient outcomes recipients keeps the response a plain object.
1 parent b409541 commit d4167da

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎api-reference/openapi.en.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28988,7 +28988,7 @@
2898828988
"type": "object",
2898928989
"description": "Notify members by email response",
2899028990
"properties": {
28991-
"items": {
28991+
"recipients": {
2899228992
"type": "array",
2899328993
"items": {
2899428994
"$ref": "#/components/schemas/MemberNotifyResultItem"
@@ -60174,7 +60174,7 @@
6017460174
"example": {
6017560175
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
6017660176
"data": {
60177-
"items": [
60177+
"recipients": [
6017860178
{
6017960179
"person_id": 5068740052131,
6018060180
"status": "accepted"

‎api-reference/openapi.zh.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28988,7 +28988,7 @@
2898828988
"type": "object",
2898928989
"description": "邮件通知成员响应",
2899028990
"properties": {
28991-
"items": {
28991+
"recipients": {
2899228992
"type": "array",
2899328993
"items": {
2899428994
"$ref": "#/components/schemas/MemberNotifyResultItem"
@@ -60174,7 +60174,7 @@
6017460174
"example": {
6017560175
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
6017660176
"data": {
60177-
"items": [
60177+
"recipients": [
6017860178
{
6017960179
"person_id": 5068740052131,
6018060180
"status": "accepted"

‎api-reference/platform.openapi.en.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2336,7 +2336,7 @@
23362336
"example": {
23372337
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
23382338
"data": {
2339-
"items": [
2339+
"recipients": [
23402340
{
23412341
"person_id": 5068740052131,
23422342
"status": "accepted"
@@ -4571,7 +4571,7 @@
45714571
"type": "object",
45724572
"description": "Notify members by email response",
45734573
"properties": {
4574-
"items": {
4574+
"recipients": {
45754575
"type": "array",
45764576
"items": {
45774577
"$ref": "#/components/schemas/MemberNotifyResultItem"

‎api-reference/platform.openapi.zh.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2336,7 +2336,7 @@
23362336
"example": {
23372337
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
23382338
"data": {
2339-
"items": [
2339+
"recipients": [
23402340
{
23412341
"person_id": 5068740052131,
23422342
"status": "accepted"
@@ -4571,7 +4571,7 @@
45714571
"type": "object",
45724572
"description": "邮件通知成员响应",
45734573
"properties": {
4574-
"items": {
4574+
"recipients": {
45754575
"type": "array",
45764576
"items": {
45774577
"$ref": "#/components/schemas/MemberNotifyResultItem"

0 commit comments

Comments
 (0)