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

docs: regenerate swagger

Browse Source
pull/2860/head
Steven 1 year ago
parent fa17dce046
commit dd9ee44a1f
7 changed files with 3363 additions and 1917 deletions
Show Stats Download Patch File Download Diff File

77
api/v1/docs.go
Unescape Escape View File

@ -838,7 +838,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/api_v1.UpsertMemoRelationRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
} }
} }
], ],
@ -992,7 +992,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest" "$ref": "#/definitions/api_v1.CreateResourceRequest"
} }
} }
], ],
@ -1116,7 +1116,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest" "$ref": "#/definitions/api_v1.UpdateResourceRequest"
} }
} }
], ],
@ -1155,7 +1155,7 @@ const docTemplate = `{
"200": { "200": {
"description": "System GetSystemStatus", "description": "System GetSystemStatus",
"schema": { "schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemStatus" "$ref": "#/definitions/api_v1.SystemStatus"
} }
}, },
"401": { "401": {
@ -1212,7 +1212,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest" "$ref": "#/definitions/api_v1.CreateStorageRequest"
} }
} }
], ],
@ -1293,7 +1293,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest" "$ref": "#/definitions/api_v1.UpdateStorageRequest"
} }
} }
], ],
@ -1799,25 +1799,6 @@ const docTemplate = `{
} }
} }
}, },
"/explore/rss.xml": {
"get": {
"produces": [
"text/xml"
],
"tags": [
"rss"
],
"summary": "Get RSS",
"responses": {
"200": {
"description": "RSS"
},
"500": {
"description": "Failed to get system customized profile | Failed to find memo list | Failed to generate rss"
}
}
}
},
"/o/get/GetImage": { "/o/get/GetImage": {
"get": { "get": {
"produces": [ "produces": [
@ -1848,37 +1829,6 @@ const docTemplate = `{
} }
} }
} }
},
"/u/{id}/rss.xml": {
"get": {
"produces": [
"text/xml"
],
"tags": [
"rss"
],
"summary": "Get RSS for a user",
"parameters": [
{
"type": "integer",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "RSS"
},
"400": {
"description": "User id is not a number"
},
"500": {
"description": "Failed to get system customized profile | Failed to find memo list | Failed to generate rss"
}
}
}
} }
}, },
"definitions": { "definitions": {
@ -2228,6 +2178,9 @@ const docTemplate = `{
"path": { "path": {
"type": "string" "type": "string"
}, },
"presign": {
"type": "boolean"
},
"region": { "region": {
"type": "string" "type": "string"
}, },
@ -2859,6 +2812,9 @@ const docTemplate = `{
"path": { "path": {
"type": "string" "type": "string"
}, },
"presign": {
"type": "boolean"
},
"region": { "region": {
"type": "string" "type": "string"
}, },
@ -3253,10 +3209,16 @@ const docTemplate = `{
"id": { "id": {
"type": "integer" "type": "integer"
}, },
"parentID": {
"type": "integer"
},
"pinned": { "pinned": {
"description": "Composed fields", "description": "Composed fields",
"type": "boolean" "type": "boolean"
}, },
"resourceName": {
"type": "string"
},
"rowStatus": { "rowStatus": {
"description": "Standard fields", "description": "Standard fields",
"allOf": [ "allOf": [
@ -3330,6 +3292,9 @@ const docTemplate = `{
"memoID": { "memoID": {
"type": "integer" "type": "integer"
}, },
"resourceName": {
"type": "string"
},
"size": { "size": {
"type": "integer" "type": "integer"
}, },

1719
api/v1/swagger.md
View File

File diff suppressed because it is too large Load Diff

60
api/v1/swagger.yaml
Unescape Escape View File

@ -230,6 +230,8 @@ definitions:
type: string type: string
path: path:
type: string type: string
presign:
type: boolean
region: region:
type: string type: string
secretKey: secretKey:
@ -238,8 +240,6 @@ definitions:
type: string type: string
urlSuffix: urlSuffix:
type: string type: string
presign:
type: boolean
type: object type: object
api_v1.StorageType: api_v1.StorageType:
enum: enum:
@ -662,6 +662,8 @@ definitions:
type: string type: string
path: path:
type: string type: string
presign:
type: boolean
region: region:
type: string type: string
secretKey: secretKey:
@ -670,8 +672,6 @@ definitions:
type: string type: string
urlSuffix: urlSuffix:
type: string type: string
presign:
type: boolean
type: object type: object
github_com_usememos_memos_api_v1.StorageType: github_com_usememos_memos_api_v1.StorageType:
enum: enum:
@ -936,9 +936,13 @@ definitions:
type: integer type: integer
id: id:
type: integer type: integer
parentID:
type: integer
pinned: pinned:
description: Composed fields description: Composed fields
type: boolean type: boolean
resourceName:
type: string
rowStatus: rowStatus:
allOf: allOf:
- $ref: '#/definitions/store.RowStatus' - $ref: '#/definitions/store.RowStatus'
@ -987,6 +991,8 @@ definitions:
type: string type: string
memoID: memoID:
type: integer type: integer
resourceName:
type: string
size: size:
type: integer type: integer
type: type:
@ -1587,7 +1593,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/api_v1.UpsertMemoRelationRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
produces: produces:
- application/json - application/json
responses: responses:
@ -1747,7 +1753,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest' $ref: '#/definitions/api_v1.CreateResourceRequest'
produces: produces:
- application/json - application/json
responses: responses:
@ -1805,7 +1811,7 @@ paths:
name: patch name: patch
required: true required: true
schema: schema:
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest' $ref: '#/definitions/api_v1.UpdateResourceRequest'
produces: produces:
- application/json - application/json
responses: responses:
@ -1860,7 +1866,7 @@ paths:
"200": "200":
description: System GetSystemStatus description: System GetSystemStatus
schema: schema:
$ref: '#/definitions/github_com_usememos_memos_api_v1.SystemStatus' $ref: '#/definitions/api_v1.SystemStatus'
"401": "401":
description: Missing user in session | Unauthorized description: Missing user in session | Unauthorized
"500": "500":
@ -1896,7 +1902,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest' $ref: '#/definitions/api_v1.CreateStorageRequest'
produces: produces:
- application/json - application/json
responses: responses:
@ -1951,7 +1957,7 @@ paths:
name: patch name: patch
required: true required: true
schema: schema:
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest' $ref: '#/definitions/api_v1.UpdateStorageRequest'
produces: produces:
- application/json - application/json
responses: responses:
@ -2287,19 +2293,6 @@ paths:
summary: Get user by username summary: Get user by username
tags: tags:
- user - user
/explore/rss.xml:
get:
produces:
- text/xml
responses:
"200":
description: RSS
"500":
description: Failed to get system customized profile | Failed to find memo
list | Failed to generate rss
summary: Get RSS
tags:
- rss
/o/get/GetImage: /o/get/GetImage:
get: get:
parameters: parameters:
@ -2321,25 +2314,4 @@ paths:
summary: Get GetImage from URL summary: Get GetImage from URL
tags: tags:
- image-url - image-url
/u/{id}/rss.xml:
get:
parameters:
- description: User ID
in: path
name: id
required: true
type: integer
produces:
- text/xml
responses:
"200":
description: RSS
"400":
description: User id is not a number
"500":
description: Failed to get system customized profile | Failed to find memo
list | Failed to generate rss
summary: Get RSS for a user
tags:
- rss
swagger: "2.0" swagger: "2.0"

1606
api/v2/apidocs.swagger.md
View File

File diff suppressed because it is too large Load Diff

0
api/v2/v2.swagger.yaml → api/v2/apidocs.swagger.yaml
Unescape Escape View File

1816
docs/api/v1.md
View File

File diff suppressed because it is too large Load Diff

2
proto/buf.gen.yaml
Unescape Escape View File

@ -20,7 +20,7 @@ plugins:
- paths=source_relative - paths=source_relative
- plugin: buf.build/grpc-ecosystem/openapiv2:v2.19.0 - plugin: buf.build/grpc-ecosystem/openapiv2:v2.19.0
out: ../api/v2/ out: ../api/v2/
opt: output_format=yaml,allow_merge=true,merge_file_name=v2 opt: output_format=yaml,allow_merge=true
# Build the TypeScript definitions for the web. # Build the TypeScript definitions for the web.
- plugin: buf.build/community/stephenh-ts-proto:v1.152.1 - plugin: buf.build/community/stephenh-ts-proto:v1.152.1
out: ../web/src/types/proto out: ../web/src/types/proto

Write Preview
Loading…
Cancel
Save