Commit 2bfd0bc3 authored by Lukas Matt's avatar Lukas Matt

Add API documentation

parent f00ce9ec
define({ "api": [
{
"type": "get",
"url": "/posts",
"title": "Request the latest post array limited by an offset",
"name": "ApiPost_Index",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "offset",
"description": "<p>(Optional) Post offset for database</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "fields",
"description": "<p>(Optional) Display only specific fields, e.g. fields=ID,Person(ID:Profile(ID:ImageUrl))</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "visibility",
"description": "<p>(Optional) 0 = all posts, 1 = public posts, 2 private posts</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Comments",
"description": "<p>Comments related to the post</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "CreatedAt",
"description": "<p>Timestamp of creation</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Guid",
"description": "<p>Unique global ID</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ID",
"description": "<p>Unique database ID</p>"
},
{
"group": "Success 200",
"type": "Hash",
"optional": false,
"field": "Person",
"description": "<p>Author of post</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "PersonID",
"description": "<p>Author database ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "ProviderName",
"description": "<p>Provider</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "Public",
"description": "<p>Is it a public or private post</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Text",
"description": "<p>Post content</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Type",
"description": "<p>Entity type e.g. StatusMessage</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "UpdatedAt",
"description": "<p>Timestamp of last replacment</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"0\": {\n \"Guid\": \"5b5d5b4f7044e3444db73504e8b08be8\",\n \"ID\": 20,\n \"Text\": \"hi whats up?\\r\\n\\r\\n\"\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Contains recent error message</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"Error 1052: Column 'xyz' not found\"\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",
"title": "Request the latest post array limited by an offset",
"name": "ApiPost_Index",
"group": "Posts",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "offset",
"description": "<p>(Optional) Post offset for database</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "fields",
"description": "<p>(Optional) Display only specific fields, e.g. fields=ID,Person(ID:Profile(ID:ImageUrl))</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "visibility",
"description": "<p>(Optional) 0 = all posts, 1 = public posts, 2 private posts</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Comments",
"description": "<p>Comments related to the post</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "CreatedAt",
"description": "<p>Timestamp of creation</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Guid",
"description": "<p>Unique global ID</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ID",
"description": "<p>Unique database ID</p>"
},
{
"group": "Success 200",
"type": "Hash",
"optional": false,
"field": "Person",
"description": "<p>Author of post</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "PersonID",
"description": "<p>Author database ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "ProviderName",
"description": "<p>Provider</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "Public",
"description": "<p>Is it a public or private post</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Text",
"description": "<p>Post content</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "Type",
"description": "<p>Entity type e.g. StatusMessage</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "UpdatedAt",
"description": "<p>Timestamp of last replacment</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"0\": {\n \"Guid\": \"5b5d5b4f7044e3444db73504e8b08be8\",\n \"ID\": 20,\n \"Text\": \"hi whats up?\\r\\n\\r\\n\"\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Contains recent error message</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 404 Not Found\n{\n \"error\": \"Error 1052: Column 'xyz' not found\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/controllers/post.go",
"groupTitle": "Posts endpoint",
"groupDescription": "<p>Viewing, creating and deleting Post structures</p>"
}
]
define({
"name": "API Documentation",
"version": "0.0.0",
"description": "GangGo API Library",
"title": "API Documentation",
"url": "/api/v0",
"sampleUrl": false,
"defaultVersion": "0.0.0",
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-01-09T14:08:43.937Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
});
{
"name": "API Documentation",
"version": "0.0.0",
"description": "GangGo API Library",
"title": "API Documentation",
"url": "/api/v0",
"sampleUrl": false,
"defaultVersion": "0.0.0",
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-01-09T14:08:43.937Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}
}
This diff is collapsed.
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
define({
ca: {
'Allowed values:' : 'Valors permesos:',
'Compare all with predecessor': 'Comparar tot amb versió anterior',
'compare changes to:' : 'comparar canvis amb:',
'compared to' : 'comparat amb',
'Default value:' : 'Valor per defecte:',
'Description' : 'Descripció',
'Field' : 'Camp',
'General' : 'General',
'Generated with' : 'Generat amb',
'Name' : 'Nom',
'No response values.' : 'Sense valors en la resposta.',
'optional' : 'opcional',
'Parameter' : 'Paràmetre',
'Permission:' : 'Permisos:',
'Response' : 'Resposta',
'Send' : 'Enviar',
'Send a Sample Request' : 'Enviar una petició d\'exemple',
'show up to version:' : 'mostrar versió:',
'Size range:' : 'Tamany de rang:',
'Type' : 'Tipus',
'url' : 'url'
}
});
define({
de: {
'Allowed values:' : 'Erlaubte Werte:',
'Compare all with predecessor': 'Vergleiche alle mit ihren Vorgängern',
'compare changes to:' : 'vergleiche Änderungen mit:',
'compared to' : 'verglichen mit',
'Default value:' : 'Standardwert:',
'Description' : 'Beschreibung',
'Field' : 'Feld',
'General' : 'Allgemein',
'Generated with' : 'Erstellt mit',
'Name' : 'Name',
'No response values.' : 'Keine Rückgabewerte.',
'optional' : 'optional',
'Parameter' : 'Parameter',
'Permission:' : 'Berechtigung:',
'Response' : 'Antwort',
'Send' : 'Senden',
'Send a Sample Request' : 'Eine Beispielanfrage senden',
'show up to version:' : 'zeige bis zur Version:',
'Size range:' : 'Größenbereich:',
'Type' : 'Typ',
'url' : 'url'
}
});
define({
es: {
'Allowed values:' : 'Valores permitidos:',
'Compare all with predecessor': 'Comparar todo con versión anterior',
'compare changes to:' : 'comparar cambios con:',
'compared to' : 'comparado con',
'Default value:' : 'Valor por defecto:',
'Description' : 'Descripción',
'Field' : 'Campo',
'General' : 'General',
'Generated with' : 'Generado con',
'Name' : 'Nombre',
'No response values.' : 'Sin valores en la respuesta.',
'optional' : 'opcional',
'Parameter' : 'Parámetro',
'Permission:' : 'Permisos:',
'Response' : 'Respuesta',
'Send' : 'Enviar',
'Send a Sample Request' : 'Enviar una petición de ejemplo',
'show up to version:' : 'mostrar a versión:',
'Size range:' : 'Tamaño de rango:',
'Type' : 'Tipo',
'url' : 'url'
}
});
define({
fr: {
'Allowed values:' : 'Valeurs autorisées :',
'Compare all with predecessor': 'Tout comparer avec ...',
'compare changes to:' : 'comparer les changements à :',
'compared to' : 'comparer à',
'Default value:' : 'Valeur par défaut :',
'Description' : 'Description',
'Field' : 'Champ',
'General' : 'Général',
'Generated with' : 'Généré avec',
'Name' : 'Nom',
'No response values.' : 'Aucune valeur de réponse.',
'optional' : 'optionnel',
'Parameter' : 'Paramètre',
'Permission:' : 'Permission :',
'Response' : 'Réponse',
'Send' : 'Envoyer',
'Send a Sample Request' : 'Envoyer une requête représentative',
'show up to version:' : 'Montrer à partir de la version :',
'Size range:' : 'Ordre de grandeur :',
'Type' : 'Type',
'url' : 'url'
}
});
define({
it: {
'Allowed values:' : 'Valori permessi:',
'Compare all with predecessor': 'Confronta tutto con versioni precedenti',
'compare changes to:' : 'confronta modifiche con:',
'compared to' : 'confrontato con',
'Default value:' : 'Valore predefinito:',
'Description' : 'Descrizione',
'Field' : 'Campo',
'General' : 'Generale',
'Generated with' : 'Creato con',
'Name' : 'Nome',
'No response values.' : 'Nessun valore di risposta.',
'optional' : 'opzionale',
'Parameter' : 'Parametro',
'Permission:' : 'Permessi:',
'Response' : 'Risposta',
'Send' : 'Invia',
'Send a Sample Request' : 'Invia una richiesta di esempio',
'show up to version:' : 'mostra alla versione:',
'Size range:' : 'Intervallo dimensione:',
'Type' : 'Tipo',
'url' : 'url'
}
});
define([
'./locales/ca.js',
'./locales/de.js',
'./locales/es.js',
'./locales/fr.js',
'./locales/it.js',
'./locales/nl.js',
'./locales/pl.js',
'./locales/pt_br.js',
'./locales/ro.js',
'./locales/ru.js',
'./locales/tr.js',
'./locales/vi.js',
'./locales/zh.js',
'./locales/zh_cn.js'
], function() {
var langId = (navigator.language || navigator.userLanguage).toLowerCase().replace('-', '_');
var language = langId.substr(0, 2);
var locales = {};
for (index in arguments) {
for (property in arguments[index])
locales[property] = arguments[index][property];
}
if ( ! locales['en'])
locales['en'] = {};
if ( ! locales[langId] && ! locales[language])
language = 'en';
var locale = (locales[langId] ? locales[langId] : locales[language]);
function __(text) {
var index = locale[text];
if (index === undefined)
return text;
return index;
};
function setLanguage(language) {
locale = locales[language];
}
return {
__ : __,
locales : locales,
locale : locale,
setLanguage: setLanguage
};
});
define({
nl: {
'Allowed values:' : 'Toegestane waarden:',
'Compare all with predecessor': 'Vergelijk alle met voorgaande versie',
'compare changes to:' : 'vergelijk veranderingen met:',
'compared to' : 'vergelijk met',
'Default value:' : 'Standaard waarde:',
'Description' : 'Omschrijving',
'Field' : 'Veld',
'General' : 'Algemeen',
'Generated with' : 'Gegenereerd met',
'Name' : 'Naam',
'No response values.' : 'Geen response waardes.',
'optional' : 'optioneel',
'Parameter' : 'Parameter',
'Permission:' : 'Permissie:',
'Response' : 'Antwoorden',
'Send' : 'Sturen',
'Send a Sample Request' : 'Stuur een sample aanvragen',
'show up to version:' : 'toon tot en met versie:',
'Size range:' : 'Maatbereik:',
'Type' : 'Type',
'url' : 'url'
}
});
define({
pl: {
'Allowed values:' : 'Dozwolone wartości:',
'Compare all with predecessor': 'Porównaj z poprzednimi wersjami',
'compare changes to:' : 'porównaj zmiany do:',
'compared to' : 'porównaj do:',
'Default value:' : 'Wartość domyślna:',
'Description' : 'Opis',
'Field' : 'Pole',
'General' : 'Generalnie',
'Generated with' : 'Wygenerowano z',
'Name' : 'Nazwa',
'No response values.' : 'Brak odpowiedzi.',
'optional' : 'opcjonalny',
'Parameter' : 'Parametr',
'Permission:' : 'Uprawnienia:',
'Response' : 'Odpowiedź',
'Send' : 'Wyślij',
'Send a Sample Request' : 'Wyślij przykładowe żądanie',
'show up to version:' : 'pokaż do wersji:',
'Size range:' : 'Zakres rozmiaru:',
'Type' : 'Typ',
'url' : 'url'
}
});
define({
'pt_br': {
'Allowed values:' : 'Valores permitidos:',
'Compare all with predecessor': 'Compare todos com antecessores',
'compare changes to:' : 'comparar alterações com:',
'compared to' : 'comparado com',
'Default value:' : 'Valor padrão:',
'Description' : 'Descrição',
'Field' : 'Campo',
'General' : 'Geral',
'Generated with' : 'Gerado com',
'Name' : 'Nome',
'No response values.' : 'Sem valores de resposta.',
'optional' : 'opcional',
'Parameter' : 'Parâmetro',
'Permission:' : 'Permissão:',
'Response' : 'Resposta',
'Send' : 'Enviar',
'Send a Sample Request' : 'Enviar um Exemplo de Pedido',
'show up to version:' : 'aparecer para a versão:',
'Size range:' : 'Faixa de tamanho:',
'Type' : 'Tipo',
'url' : 'url'
}
});
define({
ro: {
'Allowed values:' : 'Valori permise:',
'Compare all with predecessor': 'Compară toate cu versiunea precedentă',
'compare changes to:' : 'compară cu versiunea:',
'compared to' : 'comparat cu',
'Default value:' : 'Valoare implicită:',
'Description' : 'Descriere',
'Field' : 'Câmp',
'General' : 'General',
'Generated with' : 'Generat cu',
'Name' : 'Nume',
'No response values.' : 'Nici o valoare returnată.',
'optional' : 'opțional',
'Parameter' : 'Parametru',
'Permission:' : 'Permisiune:',
'Response' : 'Răspuns',
'Send' : 'Trimite',
'Send a Sample Request' : 'Trimite o cerere de probă',
'show up to version:' : 'arată până la versiunea:',
'Size range:' : 'Interval permis:',
'Type' : 'Tip',
'url' : 'url'
}
});
define({
ru: {
'Allowed values:' : 'Допустимые значения:',
'Compare all with predecessor': 'Сравнить с предыдущей версией',
'compare changes to:' : 'сравнить с:',
'compared to' : 'в сравнении с',
'Default value:' : 'По умолчанию:',
'Description' : 'Описание',
'Field' : 'Название',
'General' : 'Общая информация',
'Generated with' : 'Сгенерировано с помощью',
'Name' : 'Название',
'No response values.' : 'Нет значений для ответа.',
'optional' : 'необязательный',
'Parameter' : 'Параметр',
'Permission:' : 'Разрешено:',
'Response' : 'Ответ',
'Send' : 'Отправить',
'Send a Sample Request' : 'Отправить тестовый запрос',
'show up to version:' : 'показать версию:',
'Size range:' : 'Ограничения:',
'Type' : 'Тип',
'url' : 'URL'
}
});
define({
tr: {
'Allowed values:' : 'İzin verilen değerler:',
'Compare all with predecessor': 'Tümünü öncekiler ile karşılaştır',
'compare changes to:' : 'değişiklikleri karşılaştır:',
'compared to' : 'karşılaştır',
'Default value:' : 'Varsayılan değer:',
'Description' : 'Açıklama',