keksCloud
/
keksAccount
1
0
Fork 0
Code Issues 3 Pull Requests Releases Wiki Activity

Docs

This commit is contained in:
Kekskurse 2019-07-17 16:28:34 +02:00
parent d13b2f870a
commit 24a33b7d7c
14 changed files with 616 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/Http/Controllers/API/UserController.php
View File

@ -69,7 +69,7 @@ class UserController extends BaseController
$_SESSION["token"] = $token->token;
}
return new AccessToken($token);
return $response->withData(new AccessToken($token));
}
public function me(Response $response) {

349
public/docs/api.yml Normal file
View File

@ -0,0 +1,349 @@
swagger: "2.0"
info:
description: "API Dokumentation for keksAccount oAuth Service."
version: "1.0.0"
title: "KeksAccount"
contact:
email: "admin@keks.cloud"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "api.account.keks.cloud"
basePath: "/api/v1"
tags:
- name: "account"
description: "The User-Account"
- name: "user"
description: "Register and Login to an Account"
schemes:
- "https"
paths:
/user/register:
post:
tags:
- "user"
summary: "Register a new Account"
description: "Possible if registration is enabled or the request contains a valide invide"
produces:
- "application/json"
consumes:
- "multipart/form-data"
- "application/json"
parameters:
- in: formData
name: username
description: "Username for the new User"
required: true
type: string
- in: formData
name: password
description: "Password for the new User"
required: true
type: string
- in: formData
name: mail
description: "A valide E-Mail adress for the User"
required: true
type: string
- in: formData
name: invite
description: "If the user have an invite code to create the account"
required: false
type: string
- in: formData
name: g-recaptcha-response
description: "If google recaptcha is enabled for account creation this parameter is requierd"
required: false
type: string
responses:
200:
description: "User Account crated"
schema:
type: "object"
properties:
data:
$ref: '#/definitions/User'
success:
type: "boolean"
example: true
msg:
type: "string"
example: ""
400:
description: "Register disabled, you may can register with an valide invite code"
schema:
type: "object"
properties:
success:
type: "boolean"
example: false
msg:
type: "string"
example: "Registration disabled"
422:
description: "Some of the data ar missing or invalide, see data in the response object for details"
schema:
type: "object"
properties:
data:
type: "object"
properties:
username:
type: array
items:
type: string
example: "The username field is required."
password:
type: array
items:
type: string
example: "The password field is required."
mail:
type: array
items:
type: string
example: "The mail field is required."
success:
type: "boolean"
example: false
msg:
type: "string"
example: "The given data was invalid."
/user/login:
post:
tags:
- "user"
summary: "Login to an Account with Username/Passwort"
description: "Login with Passwort for the keksAccount GUI, dont use this in your Application."
produces:
- "application/json"
consumes:
- "multipart/form-data"
- "application/json"
parameters:
- in: formData
name: username
description: "Username"
required: true
type: string
- in: formData
name: password
description: "Password"
required: true
type: string
responses:
200:
description: "Login succesfull"
schema:
type: "object"
properties:
data:
type: "object"
properties:
access_token:
type: "string"
description: "Access Token for the user"
token_type:
type: "string"
description: "Typ of the Token"
example: ""
success:
type: "boolean"
example: true
msg:
type: "string"
example: ""
400:
description: "Register disabled, you may can register with an valide invite code"
schema:
type: "object"
properties:
success:
type: "boolean"
example: false
msg:
type: "string"
example: "Registration disabled"
422:
description: "Some of the data ar missing or invalide, see data in the response object for details"
schema:
type: "object"
properties:
data:
type: "object"
properties:
username:
type: array
items:
type: string
example: "The username field is required."
password:
type: array
items:
type: string
example: "The password field is required."
success:
type: "boolean"
example: false
msg:
type: "string"
example: "The given data was invalid."
/user/captcha:
get:
tags:
- "user"
summary: "Return the Captcha Key and Settings"
description: "Return the Google Recaptcha Key and the list of actions the captcha is enabled/required for"
produces:
- "application/json"
responses:
200:
description: "Captcha Informations"
schema:
type: "object"
properties:
data:
type: "object"
properties:
key:
type: "string"
description: "Pubplic Recaptcha code"
login:
type: "boolean"
description: "Show captcha if the User want to loging"
example: true
register:
type: "boolean"
description: "Show captcha if the User want to register"
example: true
success:
type: "boolean"
example: true
msg:
type: "string"
example: ""
/user/invites:
get:
tags:
- "user"
summary: "Return information about an invite code"
description: ""
produces:
- "application/json"
parameters:
- in: query
name: code
description: "The invite code"
required: true
type: string
responses:
200:
description: "Captcha Informations"
schema:
type: "object"
properties:
data:
type: "object"
properties:
usable:
type: "boolean"
example: true
description: "If the value is true the invite code is valide and can be used to register a new account"
username:
type: "string"
description: "If a username is set the user have to use this username for the registration"
example: ""
success:
type: "boolean"
example: true
msg:
type: "string"
example: ""
404:
description: "Invite code not found"
schema:
type: "object"
properties:
success:
type: "boolean"
example: false
msg:
type: "string"
example: "Resource not Found"
/user/me:
get:
tags:
- "user"
summary: "Return information about the current User"
description: ""
produces:
- "application/json"
responses:
200:
description: "Found user and return informations"
schema:
type: "object"
properties:
data:
$ref: '#/definitions/User'
success:
type: "boolean"
example: true
msg:
type: "string"
example: ""
401:
description: "Not logged in"
schema:
type: "object"
properties:
success:
type: "boolean"
example: false
msg:
type: "string"
example: "You need to login"
definitions:
User:
type: "object"
properties:
id:
type: "integer"
format: "int64"
example: 18
username:
type: "string"
example: "testaccount"
created_at:
type: "string"
format: "DateTime"
example: "2019-07-17T13:37:40.000000Z"
updated_at:
type: "string"
format: "DateTime"
example: "2019-07-17T13:37:40.000000Z"
primaryMail:
type: "string"
format: "mail"
example: "mail@example.com"
status:
type: "string"
description: "Account Status"
example: "active"
enum:
- "active"
inviteCode:
type: "string"
example: "sdjfios"
description: "Invite Code used to register this Account"
developer:
type: "boolean"
example: false
description: "If the user is a developer Account (Can create new Apps)"
admin:
type: "boolean"
example: false
description: "If the user is a admin Account"

BIN
public/docs/favicon-16x16.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 445 B

BIN
public/docs/favicon-32x32.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

96
public/docs/index.html Executable file
View File

@ -0,0 +1,96 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body {
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
<defs>
<symbol viewBox="0 0 20 20" id="unlocked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
</symbol>
<symbol viewBox="0 0 20 20" id="locked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="close">
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow">
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow-down">
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="jump-to">
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="expand">
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
</symbol>
</defs>
</svg>
<div id="swagger-ui"></div>
<script src="./swagger-ui-bundle.js"> </script>
<script src="./swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
url: "api.yml",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
window.ui = ui
}
</script>
</body>
</html>

57
public/docs/oauth2-redirect.html Executable file
View File

@ -0,0 +1,57 @@
<!doctype html>
<html lang="en-US">
<body onload="run()">
</body>
</html>
<script>
'use strict';
function run () {
var oauth2 = window.opener.swaggerUIRedirectOauth2;
var sentState = oauth2.state;
var redirectUrl = oauth2.redirectUrl;
var isValid, qp, arr;
if (/code|token|error/.test(window.location.hash)) {
qp = window.location.hash.substring(1);
} else {
qp = location.search.substring(1);
}
arr = qp.split("&")
arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
qp = qp ? JSON.parse('{' + arr.join() + '}',
function (key, value) {
return key === "" ? value : decodeURIComponent(value)
}
) : {}
isValid = qp.state === sentState
if (oauth2.auth.schema.get("flow") === "accessCode" && !oauth2.auth.code) {
if (!isValid) {
oauth2.errCb({
authId: oauth2.auth.name,
source: "auth",
level: "warning",
message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
});
}
if (qp.code) {
delete oauth2.state;
oauth2.auth.code = qp.code;
oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
} else {
oauth2.errCb({
authId: oauth2.auth.name,
source: "auth",
level: "error",
message: "Authorization failed: no accessCode received from the server"
});
}
} else {
oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
}
window.close();
}
</script>

86
public/docs/swagger-ui-bundle.js Executable file
View File

File diff suppressed because one or more lines are too long

1
public/docs/swagger-ui-bundle.js.map Executable file
View File

@ -0,0 +1 @@
{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;;;;;AAwjMA;;;;;;AA65DA;;;;;;;;;;;;;;;;;;;;;;;;;;AAs9TA;;;;;;;;;;;;;;AAs8JA;;;;;;;;;AAm/pBA;;;;;AAu5QA;;;;;AAynBA;AAi0CA;;;;;;AAq/YA;;;;;;AAojaA;AA8lvBA","sourceRoot":""}

13
public/docs/swagger-ui-standalone-preset.js Executable file
View File

File diff suppressed because one or more lines are too long

1
public/docs/swagger-ui-standalone-preset.js.map Executable file
View File

@ -0,0 +1 @@
{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA80CA;;;;;;AAqpFA","sourceRoot":""}

2
public/docs/swagger-ui.css Executable file
View File

File diff suppressed because one or more lines are too long

1
public/docs/swagger-ui.css.map Executable file
View File

@ -0,0 +1 @@
{"version":3,"file":"swagger-ui.css","sources":[],"mappings":"","sourceRoot":""}

8
public/docs/swagger-ui.js Executable file
View File

File diff suppressed because one or more lines are too long

1
public/docs/swagger-ui.js.map Executable file
View File

@ -0,0 +1 @@
{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAmxeA","sourceRoot":""}