Commit 38bd4c3a authored by zauberstuhl's avatar zauberstuhl

Update API docs

related to api@2fb8ead5
parent 8962e7d7
define({ "api": [
{
"type": "get",
"url": "/ap/user/:username/actor",
"title": "Display actor information",
"name": "ApiApUser_Actor",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"optional": false,
"description": ""
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Link to actor profile</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>Object type e.g. Person</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "inbox",
"description": "<p>Link to user inbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "outbox",
"description": "<p>Link to user outbox</p>"
}
]
},
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/actor\",\n \"type\": \"Person\",\n \"inbox\": \"http://localhost/api/v0/ap/user/g1/inbox\",\n \"outbox\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"following\": \"http://localhost/api/v0/ap/user/g1/following\",\n \"followers\": \"http://localhost/api/v0/ap/user/g1/followers\",\n \"preferredUsername\": \"g1\",\n \"url\": \"http://localhost/profiles/48e5074b9cada4d58e585f2394b6a4b1\",\n \"publicKey\": {\n \"id\": \"http://localhost/api/v0/ap/user/g1/actor#main-key\",\n \"owner\": \"http://localhost/api/v0/ap/user/g1/actor\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\n[...]\\n-----END PUBLIC KEY-----\\n\"\n },\n \"icon\": {\n \"url\": \"http://localhost/public/img/avatar.png\"\n },\n \"endpoints\": {\n \"sharedInbox\": \"http://localhost/api/v0/ap/inbox\"\n }\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/followers",
"title": "User follower statistics",
"name": "ApiApUser_Followers",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/followers?page=1\"\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/following",
"title": "User following statistics",
"name": "ApiApUser_Following",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/following?page=1\"\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "post",
"url": "/ap/user/:username/inbox",
"title": "User inbox",
"name": "ApiApUser_Inbox",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/outbox?page=1\"\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": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/outbox",
"title": "User outbox",
"name": "ApiApUser_Outbox",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/outbox?page=1\"\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": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "post",
"url": "/aspects",
......
[
{
"type": "get",
"url": "/ap/user/:username/actor",
"title": "Display actor information",
"name": "ApiApUser_Actor",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"optional": false,
"description": ""
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Link to actor profile</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>Object type e.g. Person</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "inbox",
"description": "<p>Link to user inbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "outbox",
"description": "<p>Link to user outbox</p>"
}
]
},
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/actor\",\n \"type\": \"Person\",\n \"inbox\": \"http://localhost/api/v0/ap/user/g1/inbox\",\n \"outbox\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"following\": \"http://localhost/api/v0/ap/user/g1/following\",\n \"followers\": \"http://localhost/api/v0/ap/user/g1/followers\",\n \"preferredUsername\": \"g1\",\n \"url\": \"http://localhost/profiles/48e5074b9cada4d58e585f2394b6a4b1\",\n \"publicKey\": {\n \"id\": \"http://localhost/api/v0/ap/user/g1/actor#main-key\",\n \"owner\": \"http://localhost/api/v0/ap/user/g1/actor\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\n[...]\\n-----END PUBLIC KEY-----\\n\"\n },\n \"icon\": {\n \"url\": \"http://localhost/public/img/avatar.png\"\n },\n \"endpoints\": {\n \"sharedInbox\": \"http://localhost/api/v0/ap/inbox\"\n }\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/followers",
"title": "User follower statistics",
"name": "ApiApUser_Followers",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/followers?page=1\"\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/following",
"title": "User following statistics",
"name": "ApiApUser_Following",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/following?page=1\"\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": "NotFound",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "post",
"url": "/ap/user/:username/inbox",
"title": "User inbox",
"name": "ApiApUser_Inbox",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/outbox?page=1\"\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": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "get",
"url": "/ap/user/:username/outbox",
"title": "User outbox",
"name": "ApiApUser_Outbox",
"group": "ApiApUsers",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>The name associated with the user account</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response",
"content": "HTTP/1.1 200 OK\n{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\"\n ],\n \"id\": \"http://localhost/api/v0/ap/user/g1/outbox\",\n \"type\": \"OrderedCollection\",\n \"totalItems\": 1,\n \"first\": \"http://localhost/api/v0/ap/user/g1/outbox?page=1\"\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": "ServerError",
"content": "HTTP/1.1 500 Internal Server Error\n{\n \"error\": \"[...]\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/ap_user.go",
"groupTitle": "ApiApUsers"
},
{
"type": "post",
"url": "/aspects",
......
......@@ -15,7 +15,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-02-22T01:12:10.798Z",
"time": "2018-10-01T22:52:48.263Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
......
......@@ -15,7 +15,7 @@
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-02-22T01:12:10.798Z",
"time": "2018-10-01T22:52:48.263Z",
"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