Skip to content

Document the multipart support submission API #86

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
Eoic merged 2 commits into from
Oct 23, 2026
Merged

Document the multipart support submission API #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cc8d40
docs: document multipart support submission API
Eoic Oct 23, 2026
3caafed
fix: pin server revision matching support API snapshot
Eoic Oct 23, 2026
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
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ jobs:
- uses: actions/checkout@v4
with:
repository: PapyrusReader/server
ref: 56b9d14e84fbc8805bca0998bcde825aa74e7e17
# Combined account-deletion (#40) and support (#41) API snapshot revision.
ref: cc69c75abfb5b48954fcbe0593f247ef32bb5244
path: .server
- uses: astral-sh/setup-uv@v6
with:
Expand Down
138 changes: 138 additions & 0 deletions _static/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1581,6 +1581,38 @@
"title": "BatchUpdateResponse",
"type": "object"
},
"Body_create_support_issue_v1_support_issues_post": {
"properties": {
"attachments": {
"anyOf": [
{
"items": {
"contentMediaType": "application/octet-stream",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Attachments"
},
"payload": {
"contentMediaType": "application/json",
"contentSchema": {
"$ref": "#/components/schemas/SupportRequest"
},
"title": "Payload",
"type": "string"
}
},
"required": [
"payload"
],
"title": "Body_create_support_issue_v1_support_issues_post",
"type": "object"
},
"Body_upload_book_cover_v1_books__book_id__cover_put": {
"properties": {
"file": {
Expand Down Expand Up @@ -6659,6 +6691,71 @@
"title": "SubmitRequest",
"type": "object"
},
"SupportRequest": {
"additionalProperties": false,
"properties": {
"app_version": {
"maxLength": 80,
"minLength": 1,
"title": "App Version",
"type": "string"
},
"description": {
"maxLength": 8000,
"minLength": 10,
"title": "Description",
"type": "string"
},
"kind": {
"enum": [
"bug",
"feature"
],
"title": "Kind",
"type": "string"
},
"platform": {
"maxLength": 80,
"minLength": 1,
"title": "Platform",
"type": "string"
},
"title": {
"maxLength": 150,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"kind",
"title",
"description",
"app_version",
"platform"
],
"title": "SupportRequest",
"type": "object"
},
"SupportResponse": {
"properties": {
"number": {
"exclusiveMinimum": 0.0,
"title": "Number",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"number",
"url"
],
"title": "SupportResponse",
"type": "object"
},
"Tag": {
"description": "Tag response schema.",
"properties": {
Expand Down Expand Up @@ -14549,6 +14646,47 @@
]
}
},
"/v1/support/issues": {
"post": {
"operationId": "create_support_issue_v1_support_issues_post",
Comment thread
Eoic marked this conversation as resolved.
Resolved
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_support_issue_v1_support_issues_post"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupportResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Support Issue",
"tags": [
"Support"
]
}
},
"/v1/sync/powersync-upload": {
"post": {
"description": "Apply one PowerSync CRUD transaction atomically.",
Expand Down
Loading