GitCaddy/GitCaddy Server
Limited
2
0
Fork 0
Code Issues Releases 4

docs(issues): expand API documentation with examples

Browse Source 
Expands AutoTicket and AutoRelease API documentation with detailed request/response examples, authentication details, rate limiting info, UI integration notes, and code samples for in-app integration. Clarifies endpoint behavior and adds field descriptions.
This commit is contained in:
David H. Friedel Jr.
2026-01-22 15:33:42 -05:00
parent a74d25e6ea
commit 503b0cff37
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.notes/note-1769113417187-fdw7f9pbd.json
View File

File diff suppressed because one or more lines are too long

4
.notes/note-1769113439411-asd5qtp9l.json
View File

@@ -1,8 +1,8 @@
{
"id": "note-1769113439411-asd5qtp9l",
"title": "AutoRelease",
"content": " New Endpoint: /{owner}/{repo}/releases/latest.json\n\n Simple URL - no /api/v1 prefix needed!\n\n Channel Support\n\n | Channel | Description |\n |--------------------|-------------------------------------|\n | stable (default) | Latest non-prerelease release |\n | prerelease or beta | Latest prerelease only |\n | any or all | Latest release regardless of status |\n\n Usage Examples\n\n # Get latest stable release\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json\n\n # Get latest beta/prerelease\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json?channel=beta\n\n # Get absolute latest (stable or prerelease)\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json?channel=any\n\n Response Format\n\n {\n \"tag_name\": \"v1.2.3\",\n \"name\": \"Version 1.2.3\",\n \"body\": \"Release notes here...\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2026-01-20T10:30:00Z\",\n \"published_at\": \"2026-01-20T10:30:00Z\",\n \"html_url\": \"https://gitcaddy.com/myorg/myapp/releases/tag/v1.2.3\",\n \"tarball_url\": \"https://gitcaddy.com/myorg/myapp/archive/v1.2.3.tar.gz\",\n \"zipball_url\": \"https://gitcaddy.com/myorg/myapp/archive/v1.2.3.zip\",\n \"assets\": [\n {\n \"name\": \"myapp-windows.exe\",\n \"size\": 12345678,\n \"download_count\": 1234,\n \"browser_download_url\": \"https://gitcaddy.com/myorg/myapp/releases/download/v1.2.3/myapp-windows.exe\"\n }\n ]\n }",
"content": " New Endpoint: /{owner}/{repo}/releases/latest.json\n\n Simple URL - no /api/v1 prefix needed!\n\n Channel Support\n\n | Channel | Description |\n |--------------------|-------------------------------------|\n | stable (default) | Latest non-prerelease release |\n | prerelease or beta | Latest prerelease only |\n | any or all | Latest release regardless of status |\n\n Authentication\n\n - Public repos: No authentication required\n - Private repos: Vault token via Authorization: Bearer gvt_xxx\n\n Rate Limiting\n\n Endpoint includes X-RateLimit-Exempt: update-check header for app update checks.\n\n Usage Examples\n\n # Get latest stable release\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json\n\n # Get latest beta/prerelease\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json?channel=beta\n\n # Get absolute latest (stable or prerelease)\n curl https://gitcaddy.com/myorg/myapp/releases/latest.json?channel=any\n\n # Private repo with vault token\n curl -H \"Authorization: Bearer gvt_xxx\" \\\n https://gitcaddy.com/myorg/private-app/releases/latest.json\n\n Response Format\n\n {\n \"repo_url\": \"https://gitcaddy.com/myorg/myapp\",\n \"repo_name\": \"myapp\",\n \"repo_full_name\": \"myorg/myapp\",\n \"repo_display_name\": \"My Application\",\n \"repo_description\": \"A great app for doing things\",\n \"tag_name\": \"v1.2.3\",\n \"name\": \"Version 1.2.3\",\n \"body\": \"Release notes here...\",\n \"draft\": false,\n \"prerelease\": false,\n \"channel\": \"stable\",\n \"created_at\": \"2026-01-20T10:30:00Z\",\n \"published_at\": \"2026-01-20T10:30:00Z\",\n \"html_url\": \"https://gitcaddy.com/myorg/myapp/releases/tag/v1.2.3\",\n \"tarball_url\": \"https://gitcaddy.com/myorg/myapp/archive/v1.2.3.tar.gz\",\n \"zipball_url\": \"https://gitcaddy.com/myorg/myapp/archive/v1.2.3.zip\",\n \"assets\": [\n {\n \"name\": \"myapp-windows.exe\",\n \"size\": 15728640,\n \"download_count\": 1234,\n \"browser_download_url\": \"https://gitcaddy.com/myorg/myapp/releases/download/v1.2.3/myapp-windows.exe\"\n }\n ]\n }\n\n UI Integration\n\n A JSON button appears on the Releases page (header and per-release) linking to this endpoint.",
"createdAt": 1769113439408,
"updatedAt": 1769113463716,
"updatedAt": 1769113860499,
"tags": []
}