Commit 79fa8c5e authored by Lukas Matt's avatar Lukas Matt

Update API docs

related to api@ea43034f
parent 7ae7a591
......@@ -228,6 +228,11 @@ define({ "api": [
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
......@@ -339,6 +344,11 @@ define({ "api": [
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
......@@ -664,6 +674,76 @@ define({ "api": [
"groupTitle": "Comments endpoint",
"groupDescription": "<p>Viewing, creating and deleting Comment structures</p>"
},
{
"type": "delete",
"url": "/comments/:guid",
"title": "Delete a comment",
"name": "ApiComment_Delete",
"group": "Comments",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/comment.go",
"groupTitle": "Comments endpoint",
"groupDescription": "<p>Viewing, creating and deleting Comment structures</p>"
},
{
"type": "get",
"url": "/posts/:id/comments",
......@@ -1100,6 +1180,76 @@ define({ "api": [
"groupTitle": "Likes endpoint",
"groupDescription": "<p>Viewing, creating and deleting Like structures</p>"
},
{
"type": "delete",
"url": "/likes/:guid",
"title": "Delete a like",
"name": "ApiLike_Delete",
"group": "Likes",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/like.go",
"groupTitle": "Likes endpoint",
"groupDescription": "<p>Viewing, creating and deleting Like structures</p>"
},
{
"type": "get",
"url": "/posts/:id/likes",
......@@ -1939,6 +2089,76 @@ define({ "api": [
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "delete",
"url": "/posts/:guid",
"title": "Delete post/reshare",
"name": "ApiPost_Delete",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/post.go",
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "get",
"url": "/posts",
......@@ -2099,6 +2319,81 @@ define({ "api": [
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "post",
"url": "/posts/:guid/reshare",
"title": "Reshare a post",
"name": "ApiPost_Reshare",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/post.go",
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "post",
"url": "/posts/:guid",
......
......@@ -228,6 +228,11 @@
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
......@@ -339,6 +344,11 @@
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
......@@ -664,6 +674,76 @@
"groupTitle": "Comments endpoint",
"groupDescription": "<p>Viewing, creating and deleting Comment structures</p>"
},
{
"type": "delete",
"url": "/comments/:guid",
"title": "Delete a comment",
"name": "ApiComment_Delete",
"group": "Comments",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/comment.go",
"groupTitle": "Comments endpoint",
"groupDescription": "<p>Viewing, creating and deleting Comment structures</p>"
},
{
"type": "get",
"url": "/posts/:id/comments",
......@@ -1100,6 +1180,76 @@
"groupTitle": "Likes endpoint",
"groupDescription": "<p>Viewing, creating and deleting Like structures</p>"
},
{
"type": "delete",
"url": "/likes/:guid",
"title": "Delete a like",
"name": "ApiLike_Delete",
"group": "Likes",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/like.go",
"groupTitle": "Likes endpoint",
"groupDescription": "<p>Viewing, creating and deleting Like structures</p>"
},
{
"type": "get",
"url": "/posts/:id/likes",
......@@ -1939,6 +2089,76 @@
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "delete",
"url": "/posts/:guid",
"title": "Delete post/reshare",
"name": "ApiPost_Delete",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/post.go",
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "get",
"url": "/posts",
......@@ -2099,6 +2319,81 @@
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "post",
"url": "/posts/:guid/reshare",
"title": "Reshare a post",
"name": "ApiPost_Reshare",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "access_token",
"description": "<p>Oauth access token</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "guid",
"description": "<p>Unique global ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{}",
"type": "json"
}
]
},
"error": {
"fields": {
"Errors 4xx/5xx": [
{
"group": "Errors",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Contains the recent error message</p>"
}
]
},
"examples": [
{
"title": "BadRequest",
"content": "HTTP/1.1 400 BadRequest\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "Unauthorized",
"content": "HTTP/1.1 401 Unauthorized\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
},
{
"title": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/post.go",
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
},
{
"type": "post",
"url": "/posts/:guid",
......
......@@ -15,7 +15,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-01-13T18:32:39.226Z",
"time": "2018-01-19T01:44:59.369Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
......
......@@ -15,7 +15,7 @@
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-01-13T18:32:39.226Z",
"time": "2018-01-19T01:44:59.369Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment