Mirrors/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-10 13:12:50 +01:00
Code Issues Releases Activity

OPENAPI docs

Browse Source
This commit is contained in:
David Bomba 2020-07-30 13:27:00 +10:00
parent 1db8b53128
commit 7318eb19d8
7 changed files with 5 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -72,7 +72,7 @@ class AccountController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(
* name="token_name",
* in="path",
* in="query",
* description="A custom name for the user company token",
* example="Daves iOS Device",
* required=true,

11
app/Http/Controllers/CompanyUserController.php
View File

@ -87,17 +87,6 @@ class CompanyUserController extends BaseController
* description="Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(
* name="id",
* in="path",
* description="The Invoice Hashed ID",
* example="D2J234DFA",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\Response(
* response=200,
* description="The Company User response",

4
app/Http/Controllers/LicenseController.php
View File

@ -39,7 +39,7 @@ class LicenseController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(
* name="license_key",
* in="path",
* in="query",
* description="The license hash",
* example="d87sh-s755s-s7d76-sdsd8",
* required=true,
@ -50,7 +50,7 @@ class LicenseController extends BaseController
* ),
* @OA\Parameter(
* name="product_id",
* in="path",
* in="query",
* description="The ID of the product purchased.",
* example="1",
* required=true,

2
app/Http/Controllers/MigrationController.php
View File

@ -162,7 +162,7 @@ class MigrationController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Api-Password"),
* @OA\Parameter(
* name="migration",
* in="path",
* in="query",
* description="The migraton file",
* example="migration.zip",
* required=true,

2
app/Http/Controllers/OpenAPI/Parameters.php
View File

@ -85,7 +85,7 @@
* ),
*
* @OA\Parameter(
* name="",
* name="api_version",
* in="query",
* description="The API version",
* @OA\Schema(

22
app/Http/Controllers/PreviewController.php
View File

@ -45,28 +45,6 @@ class PreviewController extends BaseController
* description="Returns a pdf preview.",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(
* name="entity",
* in="path",
* description="The PDF",
* example="invoice",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\Parameter(
* name="entity_id",
* in="path",
* description="The Entity ID",
* example="X9f87dkf",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\Response(
* response=200,
* description="The pdf response",

22
app/Http/Controllers/TemplateController.php
View File

@ -42,28 +42,6 @@ class TemplateController extends BaseController
* description="Returns a entity template with the template variables replaced with the Entities",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(
* name="entity",
* in="path",
* description="The Entity (invoice,quote,recurring_invoice)",
* example="invoice",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\Parameter(
* name="entity_id",
* in="path",
* description="The Entity ID",
* example="X9f87dkf",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\RequestBody(
* description="The template subject and body",
* required=true,