Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-06-03 03:14:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

OpenAPI

Browse Source
This commit is contained in:
David Bomba 2019-10-06 23:24:15 +11:00
parent febe32b7d8
commit 165182266a
2 changed files with 70 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
app/Http/Controllers/AccountController.php
View File

@ -62,6 +62,76 @@ class AccountController extends BaseController
* *
* @param \App\Http\Requests\SignupRequest $request * @param \App\Http\Requests\SignupRequest $request
* @return \Illuminate\Http\Response * @return \Illuminate\Http\Response
*
* @OA\Post(
* path="/api/v1/signup",
* operationId="postSignup",
* tags={"signup"},
* summary="Attempts a new account signup",
* description="Attempts a new account signup and returns a CompanyUser object on success",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\RequestBody(
* description="Signup credentials",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* type="object",
* @OA\Property(
* property="email",
* description="The user email address",
* type="string",
* ),
* @OA\Property(
* property="first_name",
* description="The signup users first name",
* type="string",
* ),
* @OA\Property(
* property="last_name",
* description="The signup users last name",
* type="string",
* ),
* @OA\Property(
* property="terms_of_service",
* description="The user accepted the terms of service",
* type="boolean",
* ),
* @OA\Property(
* property="privacy_policy",
* description="The user accepted the privacy policy",
* type="boolean",
* ),
* @OA\Property(
* property="password",
* example="1234567",
* description="The user password must meet minimum criteria ~ >6 characters",
* type="string"
* )
* )
* )
* ),
* @OA\Response(
* response=200,
* description="The Company User response",
* @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
* @OA\JsonContent(ref="#/components/schemas/CompanyUser"),
* ),
* @OA\Response(
* response=422,
* description="Validation error",
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
* ),
* @OA\Response(
* response="default",
* description="Unexpected Error",
* @OA\JsonContent(ref="#/components/schemas/Error"),
* ),
* )
*/ */
public function store(CreateAccountRequest $request) public function store(CreateAccountRequest $request)
{ {

8
app/Http/Controllers/Auth/LoginController.php
View File

@ -153,14 +153,6 @@ class LoginController extends BaseController
* ), * ),
* ) * )
* *
* @OA\Response(
* response=200,
* description="Successful Authentication",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(ref="#/components/schemas/Company"),
* )
* ),
*/ */
public function apiLogin(Request $request) public function apiLogin(Request $request)