Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Export all user Memos as a .zip of Markdown files #2757

Closed
wants to merge 6 commits into from
Closed

feat: Export all user Memos as a .zip of Markdown files #2757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2ca226b
Created endpoint to create .zip of all memos
nalderto Jan 14, 2024
7297e62
Add godoc for ExportMemos
nalderto Jan 14, 2024
0974f3c
Add Export Memos button
nalderto Jan 14, 2024
3cdc73d
Resolve style issues
nalderto Jan 14, 2024
5a44e38
Fix incorrect docs
nalderto Jan 14, 2024
5511368
Merge branch 'main' into export-all-memos
nalderto Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 96 additions & 12 deletions api/v1/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
// Code generated by swaggo/swag. DO NOT EDIT.

// Package v1 Code generated by swaggo/swag. DO NOT EDIT
package v1

import "github.com/swaggo/swag"
Expand Down Expand Up @@ -42,7 +41,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SignIn"
"$ref": "#/definitions/api_v1.SignIn"
}
}
],
Expand Down Expand Up @@ -87,7 +86,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SSOSignIn"
"$ref": "#/definitions/api_v1.SSOSignIn"
}
}
],
Expand Down Expand Up @@ -154,7 +153,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SignUp"
"$ref": "#/definitions/api_v1.SignUp"
}
}
],
Expand Down Expand Up @@ -199,7 +198,7 @@ const docTemplate = `{
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProvider"
"$ref": "#/definitions/api_v1.IdentityProvider"
}
}
},
Expand All @@ -226,7 +225,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest"
"$ref": "#/definitions/api_v1.CreateIdentityProviderRequest"
}
}
],
Expand Down Expand Up @@ -354,7 +353,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest"
"$ref": "#/definitions/api_v1.UpdateIdentityProviderRequest"
}
}
],
Expand Down Expand Up @@ -543,6 +542,88 @@ const docTemplate = `{
}
}
},
"/api/v1/memo/export": {
"get": {
"produces": [
"application/zip"
],
"tags": [
"memo"
],
"summary": "Get a zip folder of Markdown files containing memos matching optional filters",
"parameters": [
{
"type": "integer",
"description": "Creator ID",
"name": "creatorId",
"in": "query"
},
{
"type": "string",
"description": "Creator username",
"name": "creatorUsername",
"in": "query"
},
{
"enum": [
"NORMAL",
"ARCHIVED"
],
"type": "string",
"description": "Row status",
"name": "rowStatus",
"in": "query"
},
{
"type": "boolean",
"description": "Pinned",
"name": "pinned",
"in": "query"
},
{
"type": "string",
"description": "Search for tag. Do not append #",
"name": "tag",
"in": "query"
},
{
"type": "string",
"description": "Search for content",
"name": "content",
"in": "query"
},
{
"type": "integer",
"description": "Limit",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"description": "Offset",
"name": "offset",
"in": "query"
}
],
"responses": {
"200": {
"description": "zip folder of Memos Markdown files",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"400": {
"description": "Missing user to find memo"
},
"500": {
"description": "Failed to get memo display with updated ts setting value | Failed to fetch memo list | Failed to create memo file | \"Failed to write to memo file | Failed to close zip file writer"
}
}
}
},
"/api/v1/memo/stats": {
"get": {
"description": "Used to generate the heatmap",
Expand Down Expand Up @@ -992,7 +1073,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest"
"$ref": "#/definitions/api_v1.CreateResourceRequest"
}
}
],
Expand Down Expand Up @@ -1116,7 +1197,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest"
"$ref": "#/definitions/api_v1.UpdateResourceRequest"
}
}
],
Expand Down Expand Up @@ -1457,7 +1538,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest"
"$ref": "#/definitions/api_v1.UpsertTagRequest"
}
}
],
Expand Down Expand Up @@ -1499,7 +1580,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest"
"$ref": "#/definitions/api_v1.DeleteTagRequest"
}
}
],
Expand Down Expand Up @@ -3253,6 +3334,9 @@ const docTemplate = `{
"id": {
"type": "integer"
},
"parentID": {
"type": "integer"
},
"pinned": {
"description": "Composed fields",
"type": "boolean"
Expand Down
Loading