mirror/wakapi
1
0
Fork 0
mirror of https://github.com/muety/wakapi.git synced 2023-08-10 21:12:56 +03:00
Code Issues Projects Releases Wiki Activity
ff7d595a86
wakapi/static/docs/docs.go

1746 lines
56 KiB
Go
Raw Normal View History

chore: minor fixes
2022-02-13 12:59:14 +03:00
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
// This file was generated by swaggo/swag
chore: minor fixes
2022-02-13 12:59:14 +03:00
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
package docs
import (
"bytes"
"encoding/json"
"strings"
chore: minor fixes
2022-02-13 12:59:14 +03:00
"github.com/alecthomas/template"
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"github.com/swaggo/swag"
)
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
chore: minor fixes
2022-02-13 12:59:14 +03:00
"description": "{{.Description}}",
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"title": "{{.Title}}",
"contact": {
"name": "Ferdinand Mütsch",
"url": "https://github.com/muety",
"email": "ferdinand@muetsch.io"
},
"license": {
"name": "GPL-3.0",
"url": "https://github.com/muety/wakapi/blob/master/LICENSE"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/shields/v1/{user}/{interval}/{filter}": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"get": {
"description": "Retrieve total time for a given entity (e.g. a project) within a given range (e.g. one week) in a format compatible with [Shields.io](https://shields.io/endpoint). Requires public data access to be allowed.",
"produces": [
"application/json"
],
"tags": [
"badges"
],
"summary": "Get badge data",
"operationId": "get-badge",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for",
"name": "user",
"in": "path",
"required": true
},
{
"enum": [
"today",
"yesterday",
"week",
"month",
"year",
"7_days",
"last_7_days",
"30_days",
"last_30_days",
"12_months",
"last_12_months",
"any"
],
"type": "string",
"description": "Interval to aggregate data for",
"name": "interval",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Filter to apply (e.g. 'project:wakapi' or 'language:Go')",
"name": "filter",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.BadgeData"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}": {
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/developers#users",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve the given user",
"operationId": "get-wakatime-user",
"parameters": [
{
"type": "string",
"description": "User ID to fetch (or 'current')",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.UserViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/all_time_since_today": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/developers#all_time_since_today",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve summary for all time",
"operationId": "get-all-time",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for (or 'current')",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.AllTimeViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/heartbeats": {
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"heartbeat"
],
"summary": "Get heartbeats of user for specified date",
"operationId": "get-heartbeats",
"parameters": [
{
"type": "string",
"description": "Date",
"name": "date",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
chore: minor fixes
2022-02-13 12:59:14 +03:00
"$ref": "#/definitions/v1.HeartbeatsResult"
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
}
},
"400": {
"description": "bad date",
"schema": {
"type": "string"
}
}
}
},
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push a new heartbeat",
"operationId": "post-heartbeat-3",
"parameters": [
{
"description": "A single heartbeat",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Heartbeat"
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/heartbeats.bulk": {
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push new heartbeats",
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
"operationId": "post-heartbeat-7",
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"parameters": [
{
"description": "Multiple heartbeats",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Heartbeat"
}
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/projects": {
feat: implement wakatime projects endpoint (resolve #196)
2021-05-01 14:52:03 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/developers#projects",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve and fitler the user's projects",
"operationId": "get-wakatime-projects",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for (or 'current')",
"name": "user",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Query to filter projects by",
"name": "q",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.ProjectsViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/stats/{range}": {
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/developers#stats",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve statistics for a given user",
"operationId": "get-wakatimes-tats",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for (or 'current')",
"name": "user",
"in": "path",
"required": true
},
{
"enum": [
"today",
"yesterday",
"week",
"month",
"year",
"7_days",
"last_7_days",
"30_days",
"last_30_days",
"12_months",
"last_12_months",
"any"
],
"type": "string",
"description": "Range interval identifier",
"name": "range",
fix(docs): wrong parameter in OpenAPI-Docs The parameter `range` of `/compat/wakatime/v1/users/{user}/stats/{range} [get]` is path. However, it was described as query in OpenAPI-Docs. So, I fixed it and generated files in `static/docs`. Closes: #239 Signed-off-by: Hiroya Onoe <hiroyanoe.io@gmail.com>
2021-09-04 21:02:01 +03:00
"in": "path"
fix: neutered file system docs: add filter params to api docs
2021-12-26 21:29:17 +03:00
},
{
"type": "string",
"description": "Project to filter by",
"name": "project",
"in": "query"
},
{
"type": "string",
"description": "Language to filter by",
"name": "language",
"in": "query"
},
{
"type": "string",
"description": "Editor to filter by",
"name": "editor",
"in": "query"
},
{
"type": "string",
"description": "OS to filter by",
"name": "operating_system",
"in": "query"
},
{
"type": "string",
"description": "Machine to filter by",
"name": "machine",
"in": "query"
},
{
"type": "string",
"description": "Project label to filter by",
"name": "label",
"in": "query"
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.StatsViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/compat/wakatime/v1/users/{user}/summaries": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/developers#summaries.",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve WakaTime-compatible summaries",
"operationId": "get-wakatime-summaries",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for (or 'current')",
"name": "user",
"in": "path",
"required": true
},
{
"enum": [
"today",
"yesterday",
"week",
"month",
"year",
"7_days",
"last_7_days",
"30_days",
"last_30_days",
"12_months",
"last_12_months",
"any"
],
"type": "string",
"description": "Range interval identifier",
"name": "range",
"in": "query"
},
{
"type": "string",
"description": "Start date (e.g. '2021-02-07')",
"name": "start",
"in": "query"
},
{
"type": "string",
"description": "End date (e.g. '2021-02-08')",
"name": "end",
"in": "query"
fix: neutered file system docs: add filter params to api docs
2021-12-26 21:29:17 +03:00
},
{
"type": "string",
"description": "Project to filter by",
"name": "project",
"in": "query"
},
{
"type": "string",
"description": "Language to filter by",
"name": "language",
"in": "query"
},
{
"type": "string",
"description": "Editor to filter by",
"name": "editor",
"in": "query"
},
{
"type": "string",
"description": "OS to filter by",
"name": "operating_system",
"in": "query"
},
{
"type": "string",
"description": "Machine to filter by",
"name": "machine",
"in": "query"
},
{
"type": "string",
"description": "Project label to filter by",
"name": "label",
"in": "query"
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.SummariesViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/health": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"get": {
"produces": [
"text/plain"
],
"tags": [
"misc"
],
"summary": "Check the application's health status",
"operationId": "get-health",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/heartbeat": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push a new heartbeat",
"operationId": "post-heartbeat",
"parameters": [
{
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"description": "A single heartbeat",
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Heartbeat"
}
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/heartbeats": {
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push new heartbeats",
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
"operationId": "post-heartbeat-5",
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"parameters": [
{
"description": "Multiple heartbeats",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Heartbeat"
}
}
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/plugins/errors": {
chore: implement diagnostics endpoint (resolve #225)
2021-08-07 11:16:50 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"diagnostics"
],
"summary": "Push a new diagnostics object",
"operationId": "post-diagnostics",
"parameters": [
{
"description": "A single diagnostics object sent by WakaTime CLI",
"name": "diagnostics",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Diagnostics"
}
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/relay": {
"get": {
"tags": [
"relay"
],
"summary": "Proxy an GET API request to another Wakapi instance",
"operationId": "relay-get",
"parameters": [
{
"type": "string",
"description": "Original URL to perform the request to",
"name": "X-Target-URL",
"in": "header",
"required": true
}
],
"responses": {
"403": {
"description": "Returned if request path is not whitelisted",
"schema": {
"type": "string"
}
},
"502": {
"description": "Returned if upstream host is down",
"schema": {
"type": "string"
}
}
}
},
"put": {
"tags": [
"relay"
],
"summary": "Proxy an PUT API request to another Wakapi instance",
"operationId": "relay-put",
"parameters": [
{
"type": "string",
"description": "Original URL to perform the request to",
"name": "X-Target-URL",
"in": "header",
"required": true
}
],
"responses": {
"403": {
"description": "Returned if request path is not whitelisted",
"schema": {
"type": "string"
}
},
"502": {
"description": "Returned if upstream host is down",
"schema": {
"type": "string"
}
}
}
},
"post": {
"tags": [
"relay"
],
"summary": "Proxy an POST API request to another Wakapi instance",
"operationId": "relay-post",
"parameters": [
{
"type": "string",
"description": "Original URL to perform the request to",
"name": "X-Target-URL",
"in": "header",
"required": true
}
],
"responses": {
"403": {
"description": "Returned if request path is not whitelisted",
"schema": {
"type": "string"
}
},
"502": {
"description": "Returned if upstream host is down",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"tags": [
"relay"
],
"summary": "Proxy an DELETE API request to another Wakapi instance",
"operationId": "relay-delete",
"parameters": [
{
"type": "string",
"description": "Original URL to perform the request to",
"name": "X-Target-URL",
"in": "header",
"required": true
}
],
"responses": {
"403": {
"description": "Returned if request path is not whitelisted",
"schema": {
"type": "string"
}
},
"502": {
"description": "Returned if upstream host is down",
"schema": {
"type": "string"
}
}
}
},
"patch": {
"tags": [
"relay"
],
"summary": "Proxy an PATCH API request to another Wakapi instance",
"operationId": "relay-patch",
"parameters": [
{
"type": "string",
"description": "Original URL to perform the request to",
"name": "X-Target-URL",
"in": "header",
"required": true
}
],
"responses": {
"403": {
"description": "Returned if request path is not whitelisted",
"schema": {
"type": "string"
}
},
"502": {
"description": "Returned if upstream host is down",
"schema": {
"type": "string"
}
}
}
}
},
"/summary": {
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"summary"
],
"summary": "Retrieve a summary",
"operationId": "get-summary",
"parameters": [
{
"enum": [
"today",
"yesterday",
"week",
"month",
"year",
"7_days",
"last_7_days",
"30_days",
"last_30_days",
"12_months",
"last_12_months",
"any"
],
"type": "string",
"description": "Interval identifier",
"name": "interval",
"in": "query"
},
{
"type": "string",
"description": "Start date (e.g. '2021-02-07')",
"name": "from",
"in": "query"
},
{
"type": "string",
"description": "End date (e.g. '2021-02-08')",
"name": "to",
"in": "query"
},
{
"type": "boolean",
"description": "Whether to recompute the summary from raw heartbeat or use cache",
"name": "recompute",
"in": "query"
fix: neutered file system docs: add filter params to api docs
2021-12-26 21:29:17 +03:00
},
{
"type": "string",
"description": "Project to filter by",
"name": "project",
"in": "query"
},
{
"type": "string",
"description": "Language to filter by",
"name": "language",
"in": "query"
},
{
"type": "string",
"description": "Editor to filter by",
"name": "editor",
"in": "query"
},
{
"type": "string",
"description": "OS to filter by",
"name": "operating_system",
"in": "query"
},
{
"type": "string",
"description": "Machine to filter by",
"name": "machine",
"in": "query"
},
{
"type": "string",
"description": "Project label to filter by",
"name": "label",
"in": "query"
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.Summary"
}
}
}
}
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/users/{user}/heartbeats": {
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push a new heartbeat",
"operationId": "post-heartbeat-4",
"parameters": [
{
"description": "A single heartbeat",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Heartbeat"
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/users/{user}/heartbeats.bulk": {
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push new heartbeats",
"operationId": "post-heartbeat-8",
"parameters": [
{
"description": "Multiple heartbeats",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Heartbeat"
}
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/users/{user}/statusbar/today": {
docs: include relay endpoint in swagger docs
2021-10-13 18:47:18 +03:00
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Mimics https://wakatime.com/api/v1/users/current/statusbar/today. Have no official documentation",
"produces": [
"application/json"
],
"tags": [
"wakatime"
],
"summary": "Retrieve summary for statusbar",
"operationId": "statusbar",
"parameters": [
{
"type": "string",
"description": "User ID to fetch data for (or 'current')",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.StatusBarViewModel"
}
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/v1/users/{user}/heartbeats": {
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push a new heartbeat",
"operationId": "post-heartbeat-2",
"parameters": [
{
"description": "A single heartbeat",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Heartbeat"
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
},
fix: swagger /api/api duplication Resolves #289
2022-01-02 03:22:58 +03:00
"/v1/users/{user}/heartbeats.bulk": {
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"tags": [
"heartbeat"
],
"summary": "Push new heartbeats",
chore: add api tests for all alternative heartbeat endpoints
2021-06-22 01:27:46 +03:00
"operationId": "post-heartbeat-6",
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"parameters": [
{
"description": "Multiple heartbeats",
"name": "heartbeat",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Heartbeat"
}
}
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
},
{
"type": "string",
"description": "Username (or current)",
"name": "user",
"in": "path",
"required": true
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
}
],
"responses": {
"201": {
"description": ""
}
}
}
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
},
"definitions": {
chore: implement diagnostics endpoint (resolve #225)
2021-08-07 11:16:50 +03:00
"models.Diagnostics": {
"type": "object",
"properties": {
"architecture": {
"type": "string"
},
"cli_version": {
"type": "string"
},
"id": {
"type": "integer"
},
"logs": {
"type": "string"
},
"platform": {
"type": "string"
},
"plugin": {
"type": "string"
},
"stacktrace": {
"type": "string"
}
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"models.Heartbeat": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"category": {
"type": "string"
},
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
"created_at": {
"description": "https://gorm.io/docs/conventions.html#CreatedAt",
"type": "number"
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"editor": {
"description": "ignored because editor might be parsed differently by wakatime",
"type": "string"
},
"entity": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_write": {
"type": "boolean"
},
"language": {
"type": "string"
},
"machine": {
"description": "ignored because wakatime api doesn't return machines currently",
"type": "string"
},
"operating_system": {
"description": "ignored because os might be parsed differently by wakatime",
"type": "string"
},
"project": {
"type": "string"
},
"time": {
"type": "number"
},
"type": {
"type": "string"
docs: include relay endpoint in swagger docs
2021-10-13 18:47:18 +03:00
},
"user_agent": {
"type": "string"
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
}
},
"models.Summary": {
"type": "object",
"properties": {
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"branches": {
"description": "branches are not persisted, but calculated at runtime in case a project filter is applied",
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"editors": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
"from": {
"type": "string",
"format": "date",
"example": "2006-01-02 15:04:05.000"
},
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"labels": {
chore: implement diagnostics endpoint (resolve #225)
2021-08-07 11:16:50 +03:00
"description": "labels are not persisted, but calculated at runtime, i.e. when summary is retrieved",
fix: single heartbeat endpoint (resolve #212) docs: swagger docs for all available heartbeat endpoints
2021-06-21 22:53:47 +03:00
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"languages": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
"machines": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
"operating_systems": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
"projects": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SummaryItem"
}
},
"to": {
"type": "string",
"format": "date",
"example": "2006-01-02 15:04:05.000"
},
"user_id": {
"type": "string"
}
}
},
"models.SummaryItem": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"total": {
"type": "integer"
}
}
},
"v1.AllTimeData": {
"type": "object",
"properties": {
"is_up_to_date": {
"description": "true if the stats are up to date; when false, a 202 response code is returned and stats will be refreshed soon\u003e",
"type": "boolean"
},
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
"range": {
"$ref": "#/definitions/v1.AllTimeRange"
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"text": {
"description": "total time logged since account created as human readable string\u003e",
"type": "string"
},
"total_seconds": {
"description": "total number of seconds logged since account created",
"type": "number"
}
}
},
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
"v1.AllTimeRange": {
"type": "object",
"properties": {
"end": {
"type": "string"
},
"end_date": {
"type": "string"
},
"start": {
"type": "string"
},
"start_date": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"v1.AllTimeViewModel": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/v1.AllTimeData"
}
}
},
"v1.BadgeData": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"message": {
"type": "string"
},
"schemaVersion": {
"type": "integer"
}
}
},
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"v1.HeartbeatEntry": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"category": {
"type": "string"
},
"created_at": {
"type": "string"
},
"entity": {
"type": "string"
},
"id": {
"type": "string"
},
"is_write": {
"type": "boolean"
},
"language": {
"type": "string"
},
"machine_name_id": {
"type": "string"
},
chore: minor fixes
2022-02-13 12:59:14 +03:00
"modified_at": {
"type": "string"
},
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"project": {
"type": "string"
},
"time": {
"type": "number"
},
"type": {
"type": "string"
},
"user_agent_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
chore: minor fixes
2022-02-13 12:59:14 +03:00
"v1.HeartbeatsResult": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.HeartbeatEntry"
}
},
"end": {
"type": "string"
},
"start": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
feat: implement wakatime projects endpoint (resolve #196)
2021-05-01 14:52:03 +03:00
"v1.Project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"repository": {
"type": "string"
}
}
},
"v1.ProjectsViewModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.Project"
}
}
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"v1.StatsData": {
"type": "object",
"properties": {
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"branches": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"daily_average": {
"type": "number"
},
"days_including_holidays": {
"type": "integer"
},
"editors": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"end": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"machines": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"operating_systems": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"projects": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"start": {
"type": "string"
},
"total_seconds": {
"type": "number"
},
"user_id": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"v1.StatsViewModel": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/v1.StatsData"
}
}
},
docs: include relay endpoint in swagger docs
2021-10-13 18:47:18 +03:00
"v1.StatusBarViewModel": {
"type": "object",
"properties": {
"cached_at": {
"type": "string"
},
"data": {
"$ref": "#/definitions/v1.SummariesData"
}
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"v1.SummariesData": {
"type": "object",
"properties": {
feat: GET /heartbeat endpoint (resolves #241)
2022-01-28 14:28:47 +03:00
"branches": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
"categories": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"editors": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"grand_total": {
"$ref": "#/definitions/v1.SummariesGrandTotal"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"machines": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"operating_systems": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"projects": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesEntry"
}
},
"range": {
"$ref": "#/definitions/v1.SummariesRange"
}
}
},
"v1.SummariesEntry": {
"type": "object",
"properties": {
"digital": {
"type": "string"
},
"hours": {
"type": "integer"
},
"minutes": {
"type": "integer"
},
"name": {
"type": "string"
},
"percent": {
"type": "number"
},
"seconds": {
"type": "integer"
},
"text": {
"type": "string"
},
"total_seconds": {
"type": "number"
}
}
},
"v1.SummariesGrandTotal": {
"type": "object",
"properties": {
"digital": {
"type": "string"
},
"hours": {
"type": "integer"
},
"minutes": {
"type": "integer"
},
"text": {
"type": "string"
},
"total_seconds": {
"type": "number"
}
}
},
"v1.SummariesRange": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"end": {
"type": "string"
},
"start": {
"type": "string"
},
"text": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"v1.SummariesViewModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SummariesData"
}
},
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
feat: implement wakatime users endpoint (resolve #193)
2021-04-30 11:12:28 +03:00
},
"v1.User": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"display_name": {
"type": "string"
},
"email": {
"type": "string"
},
"full_name": {
"type": "string"
},
"id": {
"type": "string"
},
"is_email_confirmed": {
"type": "boolean"
},
"is_email_public": {
"type": "boolean"
},
"last_heartbeat_at": {
"type": "string"
},
"last_plugin_name": {
"type": "string"
},
"last_project": {
"type": "string"
},
"modified_at": {
"type": "string"
},
"timezone": {
"type": "string"
},
"username": {
"type": "string"
},
"website": {
"type": "string"
}
}
},
"v1.UserViewModel": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/v1.User"
}
}
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "1.0",
Host: "",
BasePath: "/api",
Schemes: []string{},
Title: "Wakapi API",
Description: "REST API to interact with [Wakapi](https://wakapi.dev)\n\n## Authentication\nSet header `Authorization` to your API Key encoded as Base64 and prefixed with `Basic`\n**Example:** `Basic ODY2NDhkNzQtMTljNS00NTJiLWJhMDEtZmIzZWM3MGQ0YzJmCg==`",
}
type s struct{}
func (s *s) ReadDoc() string {
sInfo := SwaggerInfo
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v interface{}) string {
a, _ := json.Marshal(v)
return string(a)
},
}).Parse(doc)
if err != nil {
return doc
}
var tpl bytes.Buffer
if err := t.Execute(&tpl, sInfo); err != nil {
return doc
}
return tpl.String()
}
func init() {
chore: minor fixes
2022-02-13 12:59:14 +03:00
swag.Register(swag.Name, &s{})
feat: add swagger docs (resolve #40)
2021-02-07 13:54:07 +03:00
}
Reference in New Issue Copy Permalink