happyz
/
memos
mirror of https://github.com/usememos/memos.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minimize differences in openapi.yaml

This commit is contained in:
Florian Dewald 2025-10-30 21:38:37 +01:00
parent 55025e1382
commit db412ae135
1 changed files with 117 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
proto/gen/openapi.yaml
View File

@ -78,23 +78,35 @@ paths:
parameters: parameters:
- name: pageSize - name: pageSize
in: query in: query
description: "Optional. The maximum number of attachments to return.\r\n The service may return fewer than this value.\r\n If unspecified, at most 50 attachments will be returned.\r\n The maximum value is 1000; values above 1000 will be coerced to 1000." description: |-
Optional. The maximum number of attachments to return.
The service may return fewer than this value.
If unspecified, at most 50 attachments will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
schema: schema:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
in: query in: query
description: "Optional. A page token, received from a previous `ListAttachments` call.\r\n Provide this to retrieve the subsequent page." description: |-
Optional. A page token, received from a previous `ListAttachments` call.
Provide this to retrieve the subsequent page.
schema: schema:
type: string type: string
- name: filter - name: filter
in: query in: query
description: "Optional. Filter to apply to the list results.\r\n Example: \"type=image/png\" or \"filename:*.jpg\"\r\n Supported operators: =, !=, <, <=, >, >=, :\r\n Supported fields: filename, type, size, create_time, memo" description: |-
Optional. Filter to apply to the list results.
Example: "type=image/png" or "filename:*.jpg"
Supported operators: =, !=, <, <=, >, >=, :
Supported fields: filename, type, size, create_time, memo
schema: schema:
type: string type: string
- name: orderBy - name: orderBy
in: query in: query
description: "Optional. The order to sort results by.\r\n Example: \"create_time desc\" or \"filename asc\"" description: |-
Optional. The order to sort results by.
Example: "create_time desc" or "filename asc"
schema: schema:
type: string type: string
responses: responses:
@ -118,7 +130,9 @@ paths:
parameters: parameters:
- name: attachmentId - name: attachmentId
in: query in: query
description: "Optional. The attachment ID to use for this attachment.\r\n If empty, a unique ID will be generated." description: |-
Optional. The attachment ID to use for this attachment.
If empty, a unique ID will be generated.
schema: schema:
type: string type: string
requestBody: requestBody:
@ -502,18 +516,26 @@ paths:
parameters: parameters:
- name: pageSize - name: pageSize
in: query in: query
description: "Optional. The maximum number of memos to return.\r\n The service may return fewer than this value.\r\n If unspecified, at most 50 memos will be returned.\r\n The maximum value is 1000; values above 1000 will be coerced to 1000." description: |-
Optional. The maximum number of memos to return.
The service may return fewer than this value.
If unspecified, at most 50 memos will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
schema: schema:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
in: query in: query
description: "Optional. A page token, received from a previous `ListMemos` call.\r\n Provide this to retrieve the subsequent page." description: |-
Optional. A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
schema: schema:
type: string type: string
- name: state - name: state
in: query in: query
description: "Optional. The state of the memos to list.\r\n Default to `NORMAL`. Set to `ARCHIVED` to list archived memos." description: |-
Optional. The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
schema: schema:
enum: enum:
- STATE_UNSPECIFIED - STATE_UNSPECIFIED
@ -523,12 +545,20 @@ paths:
format: enum format: enum
- name: orderBy - name: orderBy
in: query in: query
description: "Optional. The order to sort results by.\r\n Default to \"display_time desc\".\r\n Supports comma-separated list of fields following AIP-132.\r\n Example: \"pinned desc, display_time desc\" or \"create_time asc\"\r\n Supported fields: pinned, display_time, create_time, update_time, name" description: |-
Optional. The order to sort results by.
Default to "display_time desc".
Supports comma-separated list of fields following AIP-132.
Example: "pinned desc, display_time desc" or "create_time asc"
Supported fields: pinned, display_time, create_time, update_time, name
schema: schema:
type: string type: string
- name: filter - name: filter
in: query in: query
description: "Optional. Filter to apply to the list results.\r\n Filter is a CEL expression to filter memos.\r\n Refer to `Shortcut.filter`." description: |-
Optional. Filter to apply to the list results.
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
schema: schema:
type: string type: string
- name: showDeleted - name: showDeleted
@ -557,7 +587,9 @@ paths:
parameters: parameters:
- name: memoId - name: memoId
in: query in: query
description: "Optional. The memo ID to use for this memo.\r\n If empty, a unique ID will be generated." description: |-
Optional. The memo ID to use for this memo.
If empty, a unique ID will be generated.
schema: schema:
type: string type: string
- name: validateOnly - name: validateOnly
@ -604,7 +636,9 @@ paths:
type: string type: string
- name: readMask - name: readMask
in: query in: query
description: "Optional. The fields to return in the response.\r\n If not specified, all fields are returned." description: |-
Optional. The fields to return in the response.
If not specified, all fields are returned.
schema: schema:
type: string type: string
format: field-mask format: field-mask
@ -2139,7 +2173,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "The name of the attachment.\r\n Format: attachments/{attachment}" description: |-
The name of the attachment.
Format: attachments/{attachment}
createTime: createTime:
readOnly: true readOnly: true
type: string type: string
@ -2165,7 +2201,9 @@ components:
description: Output only. The size of the attachment in bytes. description: Output only. The size of the attachment in bytes.
memo: memo:
type: string type: string
description: "Optional. The related memo. Refer to `Memo.name`.\r\n Format: memos/{memo}" description: |-
Optional. The related memo. Refer to `Memo.name`.
Format: memos/{memo}
CreateSessionRequest: CreateSessionRequest:
type: object type: object
properties: properties:
@ -2239,7 +2277,9 @@ components:
properties: properties:
parent: parent:
type: string type: string
description: "Required. The parent, who owns the tags.\r\n Format: memos/{memo}. Use \"memos/-\" to delete all tags." description: |-
Required. The parent, who owns the tags.
Format: memos/{memo}. Use "memos/-" to delete all tags.
tag: tag:
type: string type: string
description: Required. The tag name to delete. description: Required. The tag name to delete.
@ -2400,7 +2440,9 @@ components:
description: The list of attachments. description: The list of attachments.
nextPageToken: nextPageToken:
type: string type: string
description: "A token that can be sent as `page_token` to retrieve the next page.\r\n If this field is omitted, there are no subsequent pages." description: |-
A token that can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
totalSize: totalSize:
type: integer type: integer
description: The total count of attachments (may be approximate). description: The total count of attachments (may be approximate).
@ -2500,7 +2542,9 @@ components:
description: The list of memos. description: The list of memos.
nextPageToken: nextPageToken:
type: string type: string
description: "A token that can be sent as `page_token` to retrieve the next page.\r\n If this field is omitted, there are no subsequent pages." description: |-
A token that can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
totalSize: totalSize:
type: integer type: integer
description: The total count of memos (may be approximate). description: The total count of memos (may be approximate).
@ -2602,7 +2646,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "The resource name of the memo.\r\n Format: memos/{memo}, memo is the user defined id or uuid." description: |-
The resource name of the memo.
Format: memos/{memo}, memo is the user defined id or uuid.
state: state:
enum: enum:
- STATE_UNSPECIFIED - STATE_UNSPECIFIED
@ -2614,7 +2660,9 @@ components:
creator: creator:
readOnly: true readOnly: true
type: string type: string
description: "The name of the creator.\r\n Format: users/{user}" description: |-
The name of the creator.
Format: users/{user}
createTime: createTime:
readOnly: true readOnly: true
type: string type: string
@ -2674,7 +2722,9 @@ components:
parent: parent:
readOnly: true readOnly: true
type: string type: string
description: "Output only. The name of the parent memo.\r\n Format: memos/{memo}" description: |-
Output only. The name of the parent memo.
Format: memos/{memo}
snippet: snippet:
readOnly: true readOnly: true
type: string type: string
@ -2712,7 +2762,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "The resource name of the memo.\r\n Format: memos/{memo}" description: |-
The resource name of the memo.
Format: memos/{memo}
snippet: snippet:
readOnly: true readOnly: true
type: string type: string
@ -2758,14 +2810,21 @@ components:
name: name:
readOnly: true readOnly: true
type: string type: string
description: "The resource name of the reaction.\r\n Format: reactions/{reaction}" description: |-
The resource name of the reaction.
Format: reactions/{reaction}
creator: creator:
readOnly: true readOnly: true
type: string type: string
description: "The resource name of the creator.\r\n Format: users/{user}" description: |-
The resource name of the creator.
Format: users/{user}
contentId: contentId:
type: string type: string
description: "The resource name of the content.\r\n For memo reactions, this should be the memo's resource name.\r\n Format: memos/{memo}" description: |-
The resource name of the content.
For memo reactions, this should be the memo's resource name.
Format: memos/{memo}
reactionType: reactionType:
type: string type: string
description: "Required. The type of reaction (e.g., \"\U0001F44D\", \"❤️\", \"\U0001F604\")." description: "Required. The type of reaction (e.g., \"\U0001F44D\", \"❤️\", \"\U0001F604\")."
@ -2783,7 +2842,9 @@ components:
properties: properties:
parent: parent:
type: string type: string
description: "Required. The parent, who owns the tags.\r\n Format: memos/{memo}. Use \"memos/-\" to rename all tags." description: |-
Required. The parent, who owns the tags.
Format: memos/{memo}. Use "memos/-" to rename all tags.
oldTag: oldTag:
type: string type: string
description: Required. The old tag name to rename. description: Required. The old tag name to rename.
@ -2798,7 +2859,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "Required. The resource name of the memo.\r\n Format: memos/{memo}" description: |-
Required. The resource name of the memo.
Format: memos/{memo}
attachments: attachments:
type: array type: array
items: items:
@ -2812,7 +2875,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "Required. The resource name of the memo.\r\n Format: memos/{memo}" description: |-
Required. The resource name of the memo.
Format: memos/{memo}
relations: relations:
type: array type: array
items: items:
@ -2865,7 +2930,9 @@ components:
type: string type: string
usePathStyle: usePathStyle:
type: boolean type: boolean
description: "S3 configuration for cloud storage backend.\r\n Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/" description: |-
S3 configuration for cloud storage backend.
Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/
UpsertMemoReactionRequest: UpsertMemoReactionRequest:
required: required:
- name - name
@ -2874,7 +2941,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "Required. The resource name of the memo.\r\n Format: memos/{memo}" description: |-
Required. The resource name of the memo.
Format: memos/{memo}
reaction: reaction:
allOf: allOf:
- $ref: '#/components/schemas/Reaction' - $ref: '#/components/schemas/Reaction'
@ -3150,7 +3219,9 @@ components:
properties: properties:
owner: owner:
type: string type: string
description: "The name of instance owner.\r\n Format: users/{user}" description: |-
The name of instance owner.
Format: users/{user}
version: version:
type: string type: string
description: Version is the current version of instance. description: Version is the current version of instance.
@ -3166,7 +3237,9 @@ components:
properties: properties:
name: name:
type: string type: string
description: "The name of the workspace setting.\r\n Format: workspace/settings/{setting}" description: |-
The name of the workspace setting.
Format: workspace/settings/{setting}
generalSetting: generalSetting:
$ref: '#/components/schemas/WorkspaceSetting_GeneralSetting' $ref: '#/components/schemas/WorkspaceSetting_GeneralSetting'
storageSetting: storageSetting:
@ -3179,7 +3252,9 @@ components:
properties: properties:
theme: theme:
type: string type: string
description: "theme is the name of the selected theme.\r\n This references a CSS file in the web/public/themes/ directory." description: |-
theme is the name of the selected theme.
This references a CSS file in the web/public/themes/ directory.
disallowUserRegistration: disallowUserRegistration:
type: boolean type: boolean
description: disallow_user_registration disallows user registration. description: disallow_user_registration disallows user registration.
@ -3198,7 +3273,10 @@ components:
description: custom_profile is the custom profile. description: custom_profile is the custom profile.
weekStartDayOffset: weekStartDayOffset:
type: integer type: integer
description: "week_start_day_offset is the week start day offset from Sunday.\r\n 0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\r\n Default is Sunday." 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.
format: int32 format: int32
disallowChangeUsername: disallowChangeUsername:
type: boolean type: boolean
@ -3257,7 +3335,9 @@ components:
format: enum format: enum
filepathTemplate: filepathTemplate:
type: string type: string
description: "The template of file path.\r\n e.g. assets/{timestamp}_{filename}" description: |-
The template of file path.
e.g. assets/{timestamp}_{filename}
uploadSizeLimitMb: uploadSizeLimitMb:
type: string type: string
description: The max upload size in megabytes. description: The max upload size in megabytes.
@ -3267,7 +3347,9 @@ components:
description: The S3 config. description: The S3 config.
enableS3ImageThumbnails: enableS3ImageThumbnails:
type: boolean type: boolean
description: "enable_s3_image_thumbnails enables thumbnail generation for images stored in S3.\r\n When false, images stored in S3 will not have thumbnails generated." description: |-
enable_s3_image_thumbnails enables thumbnail generation for images stored in S3.
When false, images stored in S3 will not have thumbnails generated.
description: Storage configuration settings for workspace attachments. description: Storage configuration settings for workspace attachments.
tags: tags:
- name: ActivityService - name: ActivityService