From 65f428fe783223d00863f70c69f107839aa5b9df Mon Sep 17 00:00:00 2001 From: kolaente Date: Fri, 8 Mar 2019 15:41:46 +0100 Subject: [PATCH] Updated swagger docs --- pkg/swagger/docs.go | 148 +++------------------------------------ pkg/swagger/swagger.json | 146 ++------------------------------------ pkg/swagger/swagger.yaml | 104 ++------------------------- 3 files changed, 22 insertions(+), 376 deletions(-) diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index 7f6f9126..1331f791 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -1,6 +1,6 @@ // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT // This file was generated by swaggo/swag at -// 2019-02-18 19:07:23.651383203 +0100 CET m=+0.098746766 +// 2019-03-08 15:41:16.787899662 +0100 CET m=+0.154547316 package swagger @@ -391,7 +391,7 @@ var doc = `{ "JWTKeyAuth": [] } ], - "description": "Returns a list by its ID.", + "description": "Returns a team by its ID.", "consumes": [ "application/json" ], @@ -399,13 +399,13 @@ var doc = `{ "application/json" ], "tags": [ - "list" + "team" ], - "summary": "Gets one list", + "summary": "Gets one team", "parameters": [ { "type": "integer", - "description": "List ID", + "description": "Team ID", "name": "id", "in": "path", "required": true @@ -413,14 +413,14 @@ var doc = `{ ], "responses": { "200": { - "description": "The list", + "description": "The team", "schema": { "type": "object", - "$ref": "#/definitions/models.List" + "$ref": "#/definitions/models.Team" } }, "403": { - "description": "The user does not have access to the list", + "description": "The user does not have access to the team", "schema": { "type": "object", "$ref": "#/definitions/code.vikunja.io.web.HTTPError" @@ -2319,138 +2319,6 @@ var doc = `{ } } }, - "/tasks/all/{sortby}": { - "get": { - "security": [ - { - "JWTKeyAuth": [] - } - ], - "description": "Returns all tasks on any list the user has access to.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "task" - ], - "summary": "Get tasks sorted", - "parameters": [ - { - "type": "integer", - "description": "The page number. Used for pagination. If not provided, the first page of results is returned.", - "name": "p", - "in": "query" - }, - { - "type": "string", - "description": "Search tasks by task text.", - "name": "s", - "in": "query" - }, - { - "type": "string", - "description": "The sorting parameter. Possible values to sort by are priority, prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc.", - "name": "sortby", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "The tasks", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/models.List" - } - } - }, - "500": { - "description": "Internal error", - "schema": { - "type": "object", - "$ref": "#/definitions/models.Message" - } - } - } - } - }, - "/tasks/all/{sortby}/{startdate}/{enddate}": { - "get": { - "security": [ - { - "JWTKeyAuth": [] - } - ], - "description": "Returns all tasks on any list the user has access to.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "task" - ], - "summary": "Get tasks sorted and within a date range", - "parameters": [ - { - "type": "integer", - "description": "The page number. Used for pagination. If not provided, the first page of results is returned.", - "name": "p", - "in": "query" - }, - { - "type": "string", - "description": "Search tasks by task text.", - "name": "s", - "in": "query" - }, - { - "type": "string", - "description": "The sorting parameter. Possible values to sort by are priority, prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc.", - "name": "sortby", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The start date parameter. Expects a unix timestamp.", - "name": "startdate", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The end date parameter. Expects a unix timestamp.", - "name": "enddate", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "The tasks", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/models.List" - } - } - }, - "500": { - "description": "Internal error", - "schema": { - "type": "object", - "$ref": "#/definitions/models.Message" - } - } - } - } - }, "/tasks/bulk": { "post": { "security": [ diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index d899119d..46e4b59b 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -378,7 +378,7 @@ "JWTKeyAuth": [] } ], - "description": "Returns a list by its ID.", + "description": "Returns a team by its ID.", "consumes": [ "application/json" ], @@ -386,13 +386,13 @@ "application/json" ], "tags": [ - "list" + "team" ], - "summary": "Gets one list", + "summary": "Gets one team", "parameters": [ { "type": "integer", - "description": "List ID", + "description": "Team ID", "name": "id", "in": "path", "required": true @@ -400,14 +400,14 @@ ], "responses": { "200": { - "description": "The list", + "description": "The team", "schema": { "type": "object", - "$ref": "#/definitions/models.List" + "$ref": "#/definitions/models.Team" } }, "403": { - "description": "The user does not have access to the list", + "description": "The user does not have access to the team", "schema": { "type": "object", "$ref": "#/definitions/code.vikunja.io/web.HTTPError" @@ -2306,138 +2306,6 @@ } } }, - "/tasks/all/{sortby}": { - "get": { - "security": [ - { - "JWTKeyAuth": [] - } - ], - "description": "Returns all tasks on any list the user has access to.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "task" - ], - "summary": "Get tasks sorted", - "parameters": [ - { - "type": "integer", - "description": "The page number. Used for pagination. If not provided, the first page of results is returned.", - "name": "p", - "in": "query" - }, - { - "type": "string", - "description": "Search tasks by task text.", - "name": "s", - "in": "query" - }, - { - "type": "string", - "description": "The sorting parameter. Possible values to sort by are priority, prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc.", - "name": "sortby", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "The tasks", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/models.List" - } - } - }, - "500": { - "description": "Internal error", - "schema": { - "type": "object", - "$ref": "#/definitions/models.Message" - } - } - } - } - }, - "/tasks/all/{sortby}/{startdate}/{enddate}": { - "get": { - "security": [ - { - "JWTKeyAuth": [] - } - ], - "description": "Returns all tasks on any list the user has access to.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "task" - ], - "summary": "Get tasks sorted and within a date range", - "parameters": [ - { - "type": "integer", - "description": "The page number. Used for pagination. If not provided, the first page of results is returned.", - "name": "p", - "in": "query" - }, - { - "type": "string", - "description": "Search tasks by task text.", - "name": "s", - "in": "query" - }, - { - "type": "string", - "description": "The sorting parameter. Possible values to sort by are priority, prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc.", - "name": "sortby", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The start date parameter. Expects a unix timestamp.", - "name": "startdate", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The end date parameter. Expects a unix timestamp.", - "name": "enddate", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "The tasks", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/models.List" - } - } - }, - "500": { - "description": "Internal error", - "schema": { - "type": "object", - "$ref": "#/definitions/models.Message" - } - } - } - } - }, "/tasks/bulk": { "post": { "security": [ diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index 0a698292..2b244731 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -913,9 +913,9 @@ paths: get: consumes: - application/json - description: Returns a list by its ID. + description: Returns a team by its ID. parameters: - - description: List ID + - description: Team ID in: path name: id required: true @@ -924,12 +924,12 @@ paths: - application/json responses: "200": - description: The list + description: The team schema: - $ref: '#/definitions/models.List' + $ref: '#/definitions/models.Team' type: object "403": - description: The user does not have access to the list + description: The user does not have access to the team schema: $ref: '#/definitions/code.vikunja.io/web.HTTPError' type: object @@ -940,9 +940,9 @@ paths: type: object security: - JWTKeyAuth: [] - summary: Gets one list + summary: Gets one team tags: - - list + - team post: consumes: - application/json @@ -2565,96 +2565,6 @@ paths: summary: Get tasks tags: - task - /tasks/all/{sortby}: - get: - consumes: - - application/json - description: Returns all tasks on any list the user has access to. - parameters: - - description: The page number. Used for pagination. If not provided, the first - page of results is returned. - in: query - name: p - type: integer - - description: Search tasks by task text. - in: query - name: s - type: string - - description: The sorting parameter. Possible values to sort by are priority, - prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc. - in: path - name: sortby - required: true - type: string - produces: - - application/json - responses: - "200": - description: The tasks - schema: - items: - $ref: '#/definitions/models.List' - type: array - "500": - description: Internal error - schema: - $ref: '#/definitions/models.Message' - type: object - security: - - JWTKeyAuth: [] - summary: Get tasks sorted - tags: - - task - /tasks/all/{sortby}/{startdate}/{enddate}: - get: - consumes: - - application/json - description: Returns all tasks on any list the user has access to. - parameters: - - description: The page number. Used for pagination. If not provided, the first - page of results is returned. - in: query - name: p - type: integer - - description: Search tasks by task text. - in: query - name: s - type: string - - description: The sorting parameter. Possible values to sort by are priority, - prioritydesc, priorityasc, dueadate, dueadatedesc, dueadateasc. - in: path - name: sortby - required: true - type: string - - description: The start date parameter. Expects a unix timestamp. - in: path - name: startdate - required: true - type: string - - description: The end date parameter. Expects a unix timestamp. - in: path - name: enddate - required: true - type: string - produces: - - application/json - responses: - "200": - description: The tasks - schema: - items: - $ref: '#/definitions/models.List' - type: array - "500": - description: Internal error - schema: - $ref: '#/definitions/models.Message' - type: object - security: - - JWTKeyAuth: [] - summary: Get tasks sorted and within a date range - tags: - - task /tasks/bulk: post: consumes: