Skip to content

feat: add apis to handle bookmark tags #1081

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

Merged
fmartingr merged 19 commits into from
Mar 15, 2025
Merged

feat: add apis to handle bookmark tags #1081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
874e27b
feat: add tag search api
fmartingr Mar 13, 2025
03372a1
feat: add apis to add/remove bookmark tags
fmartingr Mar 13, 2025
d488337
chore: removed debug logger
fmartingr Mar 13, 2025
58cc91a
docs: updated swagger
fmartingr Mar 13, 2025
02554f7
test: added tests
fmartingr Mar 13, 2025
745d69e
test: invalid ids
fmartingr Mar 13, 2025
ae1ce6a
feat: webapp v2
fmartingr Mar 14, 2025
9dd6909
chore: updated swagger
fmartingr Mar 14, 2025
6ceb77f
fix: route params missing
fmartingr Mar 14, 2025
265003c
feat: added cors middleware
fmartingr Mar 14, 2025
e3e3ef5
feat: built api implementation
fmartingr Mar 14, 2025
922e6fd
feat: implemented login in webapp
fmartingr Mar 14, 2025
26677d1
feat; dark mode in web app
fmartingr Mar 14, 2025
1bc94a6
feat: labels + i18n
fmartingr Mar 15, 2025
70ad544
refactor: remove custom message output in json apis
fmartingr Mar 15, 2025
dfa6766
docs: updated swagger
fmartingr Mar 15, 2025
7d8f501
chore: make lint
fmartingr Mar 15, 2025
601fe56
chore: make styles
fmartingr Mar 15, 2025
69a4422
fix: include new webapp dist files (for now)
fmartingr Mar 15, 2025
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
7 changes: 7 additions & 0 deletions .cursorrules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Shiori Test Commands

# Run the entire test suite
make unittest

# Run SQLite database tests only
go test -timeout 10s -count=1 -tags test_sqlite_only ./internal/database
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
e2e-report.html

# Dist files
dist/
/dist

# macOS trash files
.DS_Store
Expand Down
7 changes: 6 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,12 @@ clean:
## Runs server for local development
.PHONY: run-server
run-server: generate
GIN_MODE=$(GIN_MODE) SHIORI_DEVELOPMENT=$(SHIORI_DEVELOPMENT) SHIORI_DIR=$(SHIORI_DIR) SHIORI_HTTP_SECRET_KEY=shiori SHIORI_HTTP_SERVE_SWAGGER=true go run main.go server --log-level debug
GIN_MODE=$(GIN_MODE) SHIORI_DEVELOPMENT=$(SHIORI_DEVELOPMENT) go run main.go server --log-level debug

## Runs server for local development with v2 web UI
.PHONY: run-server-v2
run-server-v2: generate
GIN_MODE=$(GIN_MODE) SHIORI_DEVELOPMENT=$(SHIORI_DEVELOPMENT) SHIORI_HTTP_SERVE_WEB_UI_V2=true go run main.go server --log-level debug

## Generate swagger docs
.PHONY: swagger
Expand Down
130 changes: 130 additions & 0 deletions docs/swagger/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,119 @@ const docTemplate = `{
}
}
},
"/api/v1/bookmarks/{id}/tags": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Get tags for a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/model.TagDTO"
}
}
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark not found"
}
}
},
"post": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Add a tag to a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Add Tag Payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api_v1.bookmarkTagPayload"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark or tag not found"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Remove a tag from a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Remove Tag Payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api_v1.bookmarkTagPayload"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark not found"
}
}
}
},
"/api/v1/system/info": {
"get": {
"description": "Get general system information like Shiori version, database, and OS",
Expand Down Expand Up @@ -429,6 +542,12 @@ const docTemplate = `{
"description": "Filter tags by bookmark ID",
"name": "bookmark_id",
"in": "query"
},
{
"type": "string",
"description": "Search tags by name",
"name": "search",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -612,6 +731,17 @@ const docTemplate = `{
}
},
"definitions": {
"api_v1.bookmarkTagPayload": {
"type": "object",
"required": [
"tag_id"
],
"properties": {
"tag_id": {
"type": "integer"
}
}
},
"api_v1.bulkUpdateBookmarkTagsPayload": {
"type": "object",
"required": [
Expand Down
130 changes: 130 additions & 0 deletions docs/swagger/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,119 @@
}
}
},
"/api/v1/bookmarks/{id}/tags": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Get tags for a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/model.TagDTO"
}
}
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark not found"
}
}
},
"post": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Add a tag to a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Add Tag Payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api_v1.bookmarkTagPayload"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark or tag not found"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"Auth"
],
"summary": "Remove a tag from a bookmark.",
"parameters": [
{
"type": "integer",
"description": "Bookmark ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Remove Tag Payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api_v1.bookmarkTagPayload"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "Token not provided/invalid"
},
"404": {
"description": "Bookmark not found"
}
}
}
},
"/api/v1/system/info": {
"get": {
"description": "Get general system information like Shiori version, database, and OS",
Expand Down Expand Up @@ -418,6 +531,12 @@
"description": "Filter tags by bookmark ID",
"name": "bookmark_id",
"in": "query"
},
{
"type": "string",
"description": "Search tags by name",
"name": "search",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -601,6 +720,17 @@
}
},
"definitions": {
"api_v1.bookmarkTagPayload": {
"type": "object",
"required": [
"tag_id"
],
"properties": {
"tag_id": {
"type": "integer"
}
}
},
"api_v1.bulkUpdateBookmarkTagsPayload": {
"type": "object",
"required": [
Expand Down
Loading
Loading