diff --git a/proto/gen/apidocs.swagger.yaml b/proto/gen/apidocs.swagger.yaml index 1f90ca9b..7f3563f9 100644 --- a/proto/gen/apidocs.swagger.yaml +++ b/proto/gen/apidocs.swagger.yaml @@ -311,16 +311,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: filter - description: |- - Filter is used to filter memos returned in the list. - Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']" + description: "Filter is used to filter memos returned in the list.\r\nFormat: \"creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']\"" in: query required: false type: string @@ -509,9 +505,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: filter - description: |- - Filter is used to filter users returned in the list. - Format: "username == 'frank'" + description: "Filter is used to filter users returned in the list.\r\nFormat: \"username == 'frank'\"" in: query required: false type: string @@ -672,9 +666,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The resource name of the workspace setting. - Format: settings/{setting} + description: "The resource name of the workspace setting.\r\nFormat: settings/{setting}" in: path required: true type: string @@ -696,9 +688,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: setting.name - description: |- - name is the name of the setting. - Format: settings/{setting} + description: "name is the name of the setting.\r\nFormat: settings/{setting}" in: path required: true type: string @@ -734,9 +724,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: identityProvider.name - description: |- - The name of the identityProvider. - Format: identityProviders/{id} + description: "The name of the identityProvider.\r\nFormat: identityProviders/{id}" in: path required: true type: string @@ -774,9 +762,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: inbox.name - description: |- - The name of the inbox. - Format: inboxes/{id} + description: "The name of the inbox.\r\nFormat: inboxes/{id}" in: path required: true type: string @@ -820,10 +806,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: memo.name - description: |- - The name of the memo. - Format: memos/{id} - id is the system generated id. + description: "The name of the memo.\r\nFormat: memos/{id}\r\nid is the system generated id." in: path required: true type: string @@ -841,9 +824,7 @@ paths: $ref: '#/definitions/v1RowStatus' creator: type: string - title: |- - The name of the creator. - Format: users/{id} + title: "The name of the creator.\r\nFormat: users/{id}" createTime: type: string format: date-time @@ -890,9 +871,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 @@ -918,9 +897,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_1 - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -942,9 +919,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_1 - description: |- - The name of the identityProvider to delete. - Format: identityProviders/{id} + description: "The name of the identityProvider to delete.\r\nFormat: identityProviders/{id}" in: path required: true type: string @@ -966,9 +941,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_2 - description: |- - The name of the identityProvider to get. - Format: identityProviders/{id} + description: "The name of the identityProvider to get.\r\nFormat: identityProviders/{id}" in: path required: true type: string @@ -990,9 +963,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_2 - description: |- - The name of the inbox to delete. - Format: inboxes/{id} + description: "The name of the inbox to delete.\r\nFormat: inboxes/{id}" in: path required: true type: string @@ -1014,10 +985,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_3 - description: |- - The name of the resource. - Format: resources/{id} - id is the system generated unique identifier. + description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier." in: path required: true type: string @@ -1039,10 +1007,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_3 - description: |- - The name of the resource. - Format: resources/{id} - id is the system generated unique identifier. + description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier." in: path required: true type: string @@ -1064,9 +1029,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_4 - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1088,9 +1051,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_4 - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1112,9 +1073,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the activity. - Format: activities/{id} + description: "The name of the activity.\r\nFormat: activities/{id}" in: path required: true type: string @@ -1136,9 +1095,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1160,9 +1117,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1183,9 +1138,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1213,9 +1166,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1242,9 +1193,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1265,9 +1214,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1294,9 +1241,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1317,9 +1262,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1346,9 +1289,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1370,9 +1311,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1399,9 +1338,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1423,9 +1360,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the memo. - Format: memos/{id} + description: "The name of the memo.\r\nFormat: memos/{id}" in: path required: true type: string @@ -1452,9 +1387,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1477,9 +1410,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 @@ -1510,9 +1441,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 @@ -1539,10 +1468,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: resource.name - description: |- - The name of the resource. - Format: resources/{id} - id is the system generated unique identifier. + description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier." in: path required: true type: string @@ -1574,9 +1500,7 @@ paths: format: int64 memo: type: string - title: |- - The related memo. - Format: memos/{id} + title: "The related memo.\r\nFormat: memos/{id}" tags: - ResourceService /api/v1/{setting.name}: @@ -1594,9 +1518,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: setting.name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1633,9 +1555,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: user.name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1689,9 +1609,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the user. - Format: users/{id} + description: "The name of the user.\r\nFormat: users/{id}" in: path required: true type: string @@ -1724,10 +1642,7 @@ paths: $ref: '#/definitions/googlerpcStatus' parameters: - name: name - description: |- - The name of the resource. - Format: resources/{id} - id is the system generated unique identifier. + description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier." in: path required: true type: string @@ -1920,9 +1835,7 @@ definitions: properties: name: type: string - title: |- - The name of the identityProvider. - Format: identityProviders/{id} + title: "The name of the identityProvider.\r\nFormat: identityProviders/{id}" type: $ref: '#/definitions/apiv1IdentityProviderType' title: @@ -1958,10 +1871,7 @@ definitions: properties: name: type: string - description: |- - The name of the memo. - Format: memos/{id} - id is the system generated id. + description: "The name of the memo.\r\nFormat: memos/{id}\r\nid is the system generated id." uid: type: string description: The user defined id of the memo. @@ -1969,9 +1879,7 @@ definitions: $ref: '#/definitions/v1RowStatus' creator: type: string - title: |- - The name of the creator. - Format: users/{id} + title: "The name of the creator.\r\nFormat: users/{id}" createTime: type: string format: date-time @@ -2018,9 +1926,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 @@ -2053,9 +1959,7 @@ definitions: properties: name: type: string - title: |- - The name of the user. - Format: users/{id} + title: "The name of the user.\r\nFormat: users/{id}" locale: type: string description: The preferred locale of the user. @@ -2099,10 +2003,7 @@ definitions: weekStartDayOffset: type: integer format: int32 - description: |- - week_start_day_offset is the week start day offset from Sunday. - 0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday - Default is Sunday. + description: "week_start_day_offset is the week start day offset from Sunday.\r\n0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\r\nDefault is Sunday." disallowChangeUsername: type: boolean description: disallow_change_username disallows changing username. @@ -2153,9 +2054,7 @@ definitions: properties: name: type: string - title: |- - name is the name of the setting. - Format: settings/{setting} + title: "name is the name of the setting.\r\nFormat: settings/{setting}" generalSetting: $ref: '#/definitions/apiv1WorkspaceGeneralSetting' storageSetting: @@ -2170,9 +2069,7 @@ definitions: description: storage_type is the storage type. filepathTemplate: type: string - title: |- - The template of file path. - e.g. assets/{timestamp}_{filename} + title: "The template of file path.\r\ne.g. assets/{timestamp}_{filename}" uploadSizeLimitMb: type: string format: int64 @@ -2331,9 +2228,7 @@ definitions: properties: name: type: string - title: |- - The name of the activity. - Format: activities/{id} + title: "The name of the activity.\r\nFormat: activities/{id}" creatorId: type: integer format: int32 @@ -2476,9 +2371,7 @@ definitions: properties: name: type: string - title: |- - The name of the inbox. - Format: inboxes/{id} + title: "The name of the inbox.\r\nFormat: inboxes/{id}" sender: type: string title: 'Format: users/{id}' @@ -2552,9 +2445,7 @@ definitions: $ref: '#/definitions/v1Inbox' 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." v1ListMemoCommentsResponse: type: object properties: @@ -2597,9 +2488,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: @@ -2675,14 +2564,10 @@ definitions: properties: memo: $ref: '#/definitions/v1MemoRelationMemo' - title: |- - The name of memo. - Format: "memos/{uid}" + title: "The name of memo.\r\nFormat: \"memos/{uid}\"" relatedMemo: $ref: '#/definitions/v1MemoRelationMemo' - title: |- - The name of related memo. - Format: "memos/{uid}" + title: "The name of related memo.\r\nFormat: \"memos/{uid}\"" type: $ref: '#/definitions/v1MemoRelationType' v1MemoRelationMemo: @@ -2690,9 +2575,7 @@ definitions: properties: name: type: string - title: |- - The name of the memo. - Format: memos/{id} + title: "The name of the memo.\r\nFormat: memos/{id}" uid: type: string snippet: @@ -2866,9 +2749,7 @@ definitions: format: int32 creator: type: string - title: |- - The name of the creator. - Format: users/{id} + title: "The name of the creator.\r\nFormat: users/{id}" contentId: type: string reactionType: @@ -2885,10 +2766,7 @@ definitions: properties: name: type: string - description: |- - The name of the resource. - Format: resources/{id} - id is the system generated unique identifier. + description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier." uid: type: string description: The user defined id of the resource. @@ -2910,9 +2788,7 @@ definitions: format: int64 memo: type: string - title: |- - The related memo. - Format: memos/{id} + title: "The related memo.\r\nFormat: memos/{id}" v1RestoreMarkdownNodesRequest: type: object properties: @@ -3034,9 +2910,7 @@ definitions: properties: name: type: string - title: |- - The name of the user. - Format: users/{id} + title: "The name of the user.\r\nFormat: users/{id}" id: type: integer format: int32 @@ -3110,9 +2984,7 @@ definitions: properties: owner: type: string - title: |- - The name of instance owner. - Format: "users/{id}" + title: "The name of instance owner.\r\nFormat: \"users/{id}\"" version: type: string title: version is the current version of instance