diff --git a/proto/gen/apidocs.swagger.yaml b/proto/gen/apidocs.swagger.yaml index 74b5da75..3136e502 100644 --- a/proto/gen/apidocs.swagger.yaml +++ b/proto/gen/apidocs.swagger.yaml @@ -305,9 +305,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent - description: |- - The parent is the owner of the memos. - If not specified or `users/-`, it will list all memos. + description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." in: query required: false type: string @@ -318,16 +316,12 @@ paths: type: integer format: int32 - name: pageToken - description: |- - A page token, received from a previous `ListMemos` call. - Provide this to retrieve the subsequent page. + description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." in: query required: false type: string - name: state - description: |- - The state of the memos to list. - Default to `NORMAL`. Set to `ARCHIVED` to list archived memos. + description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." in: query required: false type: string @@ -337,16 +331,12 @@ paths: - ARCHIVED default: STATE_UNSPECIFIED - name: sort - description: |- - What field to sort the results by. - Default to display_time. + description: "What field to sort the results by.\r\nDefault to display_time." in: query required: false type: string - name: direction - description: |- - The direction to sort the results by. - Default to DESC. + description: "The direction to sort the results by.\r\nDefault to DESC." in: query required: false type: string @@ -356,16 +346,12 @@ paths: - DESC default: DIRECTION_UNSPECIFIED - name: filter - description: |- - Filter is a CEL expression to filter memos. - Refer to `Shortcut.filter`. + description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." in: query required: false type: string - name: oldFilter - description: |- - [Deprecated] Old filter contains some specific conditions to filter memos. - Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']" + description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" in: query required: false type: string @@ -410,9 +396,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: id - description: |- - The id of the reaction. - Refer to the `Reaction.id`. + description: "The id of the reaction.\r\nRefer to the `Reaction.id`." in: path required: true type: integer @@ -826,17 +810,13 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: memo.name - description: |- - The name of the memo. - Format: memos/{memo}, memo is the user defined id or uuid. + description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid." in: path required: true type: string pattern: memos/[^/]+ - name: memo - description: |- - The memo to update. - The `name` field is required. + description: "The memo to update.\r\nThe `name` field is required." in: body required: true schema: @@ -846,9 +826,7 @@ paths: $ref: '#/definitions/v1State' creator: type: string - title: |- - The name of the creator. - Format: users/{user} + title: "The name of the creator.\r\nFormat: users/{user}" createTime: type: string format: date-time @@ -896,9 +874,7 @@ paths: readOnly: true parent: type: string - title: |- - The name of the parent memo. - Format: memos/{id} + title: "The name of the parent memo.\r\nFormat: memos/{id}" readOnly: true snippet: type: string @@ -907,9 +883,7 @@ paths: location: $ref: '#/definitions/apiv1Location' description: The location of the memo. - title: |- - The memo to update. - The `name` field is required. + title: "The memo to update.\r\nThe `name` field is required." required: - memo tags: @@ -1466,9 +1440,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent - description: |- - The parent is the owner of the memos. - If not specified or `users/-`, it will list all memos. + description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." in: path required: true type: string @@ -1480,16 +1452,12 @@ paths: type: integer format: int32 - name: pageToken - description: |- - A page token, received from a previous `ListMemos` call. - Provide this to retrieve the subsequent page. + description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." in: query required: false type: string - name: state - description: |- - The state of the memos to list. - Default to `NORMAL`. Set to `ARCHIVED` to list archived memos. + description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." in: query required: false type: string @@ -1499,16 +1467,12 @@ paths: - ARCHIVED default: STATE_UNSPECIFIED - name: sort - description: |- - What field to sort the results by. - Default to display_time. + description: "What field to sort the results by.\r\nDefault to display_time." in: query required: false type: string - name: direction - description: |- - The direction to sort the results by. - Default to DESC. + description: "The direction to sort the results by.\r\nDefault to DESC." in: query required: false type: string @@ -1518,16 +1482,12 @@ paths: - DESC default: DIRECTION_UNSPECIFIED - name: filter - description: |- - Filter is a CEL expression to filter memos. - Refer to `Shortcut.filter`. + description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." in: query required: false type: string - name: oldFilter - description: |- - [Deprecated] Old filter contains some specific conditions to filter memos. - Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']" + description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" in: query required: false type: string @@ -1665,9 +1625,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent - description: |- - The parent, who owns the tags. - Format: memos/{id}. Use "memos/-" to delete all tags. + description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags." in: path required: true type: string @@ -1698,9 +1656,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent - description: |- - The parent, who owns the tags. - Format: memos/{id}. Use "memos/-" to rename all tags. + description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to rename all tags." in: path required: true type: string @@ -1815,9 +1771,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: user.name - description: |- - The name of the user. - Format: users/{id}, id is the system generated auto-incremented id. + description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id." in: path required: true type: string @@ -2152,17 +2106,13 @@ definitions: properties: name: type: string - description: |- - The name of the memo. - Format: memos/{memo}, memo is the user defined id or uuid. + description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid." readOnly: true state: $ref: '#/definitions/v1State' creator: type: string - title: |- - The name of the creator. - Format: users/{user} + title: "The name of the creator.\r\nFormat: users/{user}" createTime: type: string format: date-time @@ -2210,9 +2160,7 @@ definitions: readOnly: true parent: type: string - title: |- - The name of the parent memo. - Format: memos/{id} + title: "The name of the parent memo.\r\nFormat: memos/{id}" readOnly: true snippet: type: string @@ -2793,9 +2741,7 @@ definitions: $ref: '#/definitions/apiv1Memo' nextPageToken: type: string - description: |- - A token, which can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + description: "A token, which can be sent as `page_token` to retrieve the next page.\r\nIf this field is omitted, there are no subsequent pages." v1ListNode: type: object properties: @@ -3213,9 +3159,7 @@ definitions: properties: name: type: string - description: |- - The name of the user. - Format: users/{id}, id is the system generated auto-incremented id. + description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id." role: $ref: '#/definitions/UserRole' username: @@ -3264,9 +3208,7 @@ definitions: items: type: string format: date-time - description: |- - The timestamps when the memos were displayed. - We should return raw data to the client, and let the client format the data with the user's timezone. + description: "The timestamps when the memos were displayed.\r\nWe should return raw data to the client, and let the client format the data with the user's timezone." memoTypeStats: $ref: '#/definitions/UserStatsMemoTypeStats' description: The stats of memo types. @@ -3275,9 +3217,7 @@ definitions: additionalProperties: type: integer format: int32 - title: |- - The count of tags. - Format: "tag1": 1, "tag2": 2 + title: "The count of tags.\r\nFormat: \"tag1\": 1, \"tag2\": 2" v1Visibility: type: string enum: