Skip to content

C
canifa_note
Commit 8e6d9b49 authored by johnnyjoy's avatar johnnyjoy
Browse files
Options

chore: buf generate

parent a63d9b47
Hide whitespace changes
Inline Side-by-side
Showing with 42 additions and 127 deletions
proto/gen/apidocs.swagger.yaml
View file @ 8e6d9b49
...@@ -305,9 +305,7 @@ paths: ...@@ -305,9 +305,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos."
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in: query in: query
required: false required: false
type: string type: string
...@@ -318,16 +316,12 @@ paths: ...@@ -318,16 +316,12 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: |- description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page."
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in: query in: query
required: false required: false
type: string type: string
- name: state - name: state
description: |- description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos."
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in: query in: query
required: false required: false
type: string type: string
...@@ -337,16 +331,12 @@ paths: ...@@ -337,16 +331,12 @@ paths:
- ARCHIVED - ARCHIVED
default: STATE_UNSPECIFIED default: STATE_UNSPECIFIED
- name: sort - name: sort
description: |- description: "What field to sort the results by.\r\nDefault to display_time."
What field to sort the results by.
Default to display_time.
in: query in: query
required: false required: false
type: string type: string
- name: direction - name: direction
description: |- description: "The direction to sort the results by.\r\nDefault to DESC."
The direction to sort the results by.
Default to DESC.
in: query in: query
required: false required: false
type: string type: string
...@@ -356,16 +346,12 @@ paths: ...@@ -356,16 +346,12 @@ paths:
- DESC - DESC
default: DIRECTION_UNSPECIFIED default: DIRECTION_UNSPECIFIED
- name: filter - name: filter
description: |- description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`."
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in: query in: query
required: false required: false
type: string type: string
- name: oldFilter - name: oldFilter
description: |- description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\""
[Deprecated] Old filter contains some specific conditions to filter memos.
Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
...@@ -410,9 +396,7 @@ paths: ...@@ -410,9 +396,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: id - name: id
description: |- description: "The id of the reaction.\r\nRefer to the `Reaction.id`."
The id of the reaction.
Refer to the `Reaction.id`.
in: path in: path
required: true required: true
type: integer type: integer
...@@ -678,9 +662,7 @@ paths: ...@@ -678,9 +662,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The resource name of the workspace setting.\r\nFormat: settings/{setting}"
The resource name of the workspace setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
...@@ -702,9 +684,7 @@ paths: ...@@ -702,9 +684,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: setting.name - name: setting.name
description: |- description: "name is the name of the setting.\r\nFormat: settings/{setting}"
name is the name of the setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
...@@ -826,17 +806,13 @@ paths: ...@@ -826,17 +806,13 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: memo.name - name: memo.name
description: |- description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid."
The name of the memo.
Format: memos/{memo}, memo is the user defined id or uuid.
in: path in: path
required: true required: true
type: string type: string
pattern: memos/[^/]+ pattern: memos/[^/]+
- name: memo - name: memo
description: |- description: "The memo to update.\r\nThe `name` field is required."
The memo to update.
The `name` field is required.
in: body in: body
required: true required: true
schema: schema:
...@@ -846,9 +822,7 @@ paths: ...@@ -846,9 +822,7 @@ paths:
$ref: '#/definitions/v1State' $ref: '#/definitions/v1State'
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{user}"
The name of the creator.
Format: users/{user}
createTime: createTime:
type: string type: string
format: date-time format: date-time
...@@ -896,9 +870,7 @@ paths: ...@@ -896,9 +870,7 @@ paths:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: |- title: "The name of the parent memo.\r\nFormat: memos/{id}"
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
...@@ -907,9 +879,7 @@ paths: ...@@ -907,9 +879,7 @@ paths:
location: location:
$ref: '#/definitions/apiv1Location' $ref: '#/definitions/apiv1Location'
description: The location of the memo. description: The location of the memo.
title: |- title: "The memo to update.\r\nThe `name` field is required."
The memo to update.
The `name` field is required.
required: required:
- memo - memo
tags: tags:
...@@ -1105,9 +1075,7 @@ paths: ...@@ -1105,9 +1075,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the activity.\r\nFormat: activities/{id}, id is the system generated auto-incremented id."
The name of the activity.
Format: activities/{id}, id is the system generated auto-incremented id.
in: path in: path
required: true required: true
type: string type: string
...@@ -1466,9 +1434,7 @@ paths: ...@@ -1466,9 +1434,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos."
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in: path in: path
required: true required: true
type: string type: string
...@@ -1480,16 +1446,12 @@ paths: ...@@ -1480,16 +1446,12 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: |- description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page."
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in: query in: query
required: false required: false
type: string type: string
- name: state - name: state
description: |- description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos."
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in: query in: query
required: false required: false
type: string type: string
...@@ -1499,16 +1461,12 @@ paths: ...@@ -1499,16 +1461,12 @@ paths:
- ARCHIVED - ARCHIVED
default: STATE_UNSPECIFIED default: STATE_UNSPECIFIED
- name: sort - name: sort
description: |- description: "What field to sort the results by.\r\nDefault to display_time."
What field to sort the results by.
Default to display_time.
in: query in: query
required: false required: false
type: string type: string
- name: direction - name: direction
description: |- description: "The direction to sort the results by.\r\nDefault to DESC."
The direction to sort the results by.
Default to DESC.
in: query in: query
required: false required: false
type: string type: string
...@@ -1518,16 +1476,12 @@ paths: ...@@ -1518,16 +1476,12 @@ paths:
- DESC - DESC
default: DIRECTION_UNSPECIFIED default: DIRECTION_UNSPECIFIED
- name: filter - name: filter
description: |- description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`."
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in: query in: query
required: false required: false
type: string type: string
- name: oldFilter - name: oldFilter
description: |- description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\""
[Deprecated] Old filter contains some specific conditions to filter memos.
Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
...@@ -1665,9 +1619,7 @@ paths: ...@@ -1665,9 +1619,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags."
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to delete all tags.
in: path in: path
required: true required: true
type: string type: string
...@@ -1698,9 +1650,7 @@ paths: ...@@ -1698,9 +1650,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to rename all tags."
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to rename all tags.
in: path in: path
required: true required: true
type: string type: string
...@@ -1727,9 +1677,7 @@ paths: ...@@ -1727,9 +1677,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: resource.name - name: resource.name
description: |- description: "The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid."
The name of the resource.
Format: resources/{resource}, resource is the user defined if or uuid.
in: path in: path
required: true required: true
type: string type: string
...@@ -1815,9 +1763,7 @@ paths: ...@@ -1815,9 +1763,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user.name - name: user.name
description: |- description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id."
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
in: path in: path
required: true required: true
type: string type: string
...@@ -2080,9 +2026,7 @@ definitions: ...@@ -2080,9 +2026,7 @@ definitions:
properties: properties:
memo: memo:
type: string type: string
description: |- description: "The memo name of comment.\r\nRefer to `Memo.name`."
The memo name of comment.
Refer to `Memo.name`.
relatedMemo: relatedMemo:
type: string type: string
description: The name of related memo. description: The name of related memo.
...@@ -2144,17 +2088,13 @@ definitions: ...@@ -2144,17 +2088,13 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: |- description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid."
The name of the memo.
Format: memos/{memo}, memo is the user defined id or uuid.
readOnly: true readOnly: true
state: state:
$ref: '#/definitions/v1State' $ref: '#/definitions/v1State'
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{user}"
The name of the creator.
Format: users/{user}
createTime: createTime:
type: string type: string
format: date-time format: date-time
...@@ -2202,9 +2142,7 @@ definitions: ...@@ -2202,9 +2142,7 @@ definitions:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: |- title: "The name of the parent memo.\r\nFormat: memos/{id}"
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
...@@ -2290,10 +2228,7 @@ definitions: ...@@ -2290,10 +2228,7 @@ definitions:
weekStartDayOffset: weekStartDayOffset:
type: integer type: integer
format: int32 format: int32
description: |- 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."
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.
disallowChangeUsername: disallowChangeUsername:
type: boolean type: boolean
description: disallow_change_username disallows changing username. description: disallow_change_username disallows changing username.
...@@ -2346,9 +2281,7 @@ definitions: ...@@ -2346,9 +2281,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "name is the name of the setting.\r\nFormat: settings/{setting}"
name is the name of the setting.
Format: settings/{setting}
generalSetting: generalSetting:
$ref: '#/definitions/apiv1WorkspaceGeneralSetting' $ref: '#/definitions/apiv1WorkspaceGeneralSetting'
storageSetting: storageSetting:
...@@ -2363,9 +2296,7 @@ definitions: ...@@ -2363,9 +2296,7 @@ definitions:
description: storage_type is the storage type. description: storage_type is the storage type.
filepathTemplate: filepathTemplate:
type: string type: string
title: |- title: "The template of file path.\r\ne.g. assets/{timestamp}_{filename}"
The template of file path.
e.g. assets/{timestamp}_{filename}
uploadSizeLimitMb: uploadSizeLimitMb:
type: string type: string
format: int64 format: int64
...@@ -2524,15 +2455,11 @@ definitions: ...@@ -2524,15 +2455,11 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the activity.\r\nFormat: activities/{id}"
The name of the activity.
Format: activities/{id}
readOnly: true readOnly: true
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{user}"
The name of the creator.
Format: users/{user}
type: type:
type: string type: string
description: The type of the activity. description: The type of the activity.
...@@ -2794,9 +2721,7 @@ definitions: ...@@ -2794,9 +2721,7 @@ definitions:
$ref: '#/definitions/apiv1Memo' $ref: '#/definitions/apiv1Memo'
nextPageToken: nextPageToken:
type: string type: string
description: |- 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."
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v1ListNode: v1ListNode:
type: object type: object
properties: properties:
...@@ -2885,9 +2810,7 @@ definitions: ...@@ -2885,9 +2810,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
uid: uid:
type: string type: string
snippet: snippet:
...@@ -3073,9 +2996,7 @@ definitions: ...@@ -3073,9 +2996,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: |- description: "The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid."
The name of the resource.
Format: resources/{resource}, resource is the user defined if or uuid.
readOnly: true readOnly: true
createTime: createTime:
type: string type: string
...@@ -3209,9 +3130,7 @@ definitions: ...@@ -3209,9 +3130,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: |- description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id."
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
readOnly: true readOnly: true
role: role:
$ref: '#/definitions/UserRole' $ref: '#/definitions/UserRole'
...@@ -3261,9 +3180,7 @@ definitions: ...@@ -3261,9 +3180,7 @@ definitions:
items: items:
type: string type: string
format: date-time format: date-time
description: |- 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."
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.
memoTypeStats: memoTypeStats:
$ref: '#/definitions/UserStatsMemoTypeStats' $ref: '#/definitions/UserStatsMemoTypeStats'
description: The stats of memo types. description: The stats of memo types.
...@@ -3272,9 +3189,7 @@ definitions: ...@@ -3272,9 +3189,7 @@ definitions:
additionalProperties: additionalProperties:
type: integer type: integer
format: int32 format: int32
title: |- title: "The count of tags.\r\nFormat: \"tag1\": 1, \"tag2\": 2"
The count of tags.
Format: "tag1": 1, "tag2": 2
pinnedMemos: pinnedMemos:
type: array type: array
items: items:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment