Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-05-24 02:14:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Finalized OpenAPI

Browse Source
This commit is contained in:
David Bomba 2019-10-07 15:57:14 +11:00
parent 0cad2c1c90
commit a54b6c3055
15 changed files with 110 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -479,7 +479,7 @@ class ClientController extends BaseController
* @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/ClientUser"),
* @OA\JsonContent(ref="#/components/schemas/Client"),
* ),
* @OA\Response(
* response=422,

11
app/Http/Controllers/OpenAPI/BulkActionSchema.php Normal file
View File

@ -0,0 +1,11 @@
<?php
/**
* @OA\Schema(
* schema="BulkAction",
* type="array",
* @OA\Items(
* type="integer",
* example="[0,1,2,3,]"
* ),
* )
*/

13
app/Http/Controllers/OpenAPI/ClientGatewayToken.php Normal file
View File

@ -0,0 +1,13 @@
<?php
/**
* @OA\Schema(
* schema="ClientGatewayToken",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="company_id", type="string", example="2", description="______"),
* @OA\Property(property="client_id", type="string", example="2", description="______"),
* @OA\Property(property="token", type="string", example="2", description="______"),
* @OA\Property(property="company_gateway_id", type="string", example="2", description="______"),
* @OA\Property(property="is_default", type="boolean", example="true", description="______"),
* )
*/

28
app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php Normal file
View File

@ -0,0 +1,28 @@
<?php
/**
* @OA\Schema(
* schema="CompanyGateway",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="company_id", type="string", example="2", description="______"),
* @OA\Property(property="gateway_key", type="string", example="2", description="______"),
* @OA\Property(property="accepted_credit_cards", type="integer", example="32", description="Bitmask representation of cards"),
* @OA\Property(property="show_address", type="boolean", example=true, description="______"),
* @OA\Property(property="show_shipping_address", type="boolean", example=true, description="______"),
* @OA\Property(property="update_details", type="boolean", example=true, description="______"),
* @OA\Property(property="adjust_fee_percent", type="boolean", example=true, description="______"),
* @OA\Property(property="config", type="string", example="2", description="______"),
* @OA\Property(property="priority_id", type="string", example="2", description="______"),
* @OA\Property(property="user_id", type="string", example="2", description="______"),
* @OA\Property(property="min_limit", type="string", example="2", description="______"),
* @OA\Property(property="max_limit", type="string", example="2", description="______"),
* @OA\Property(property="fee_amount", type="number", format="float", example="2.0", description="______"),
* @OA\Property(property="fee_percent", type="number", format="float", example="2.0", description="______"),
* @OA\Property(property="fee_tax_name1", type="string", example="2", description="______"),
* @OA\Property(property="fee_tax_name2", type="string", example="2", description="______"),
* @OA\Property(property="fee_tax_rate1", type="number", format="float", example="2.0", description="______"),
* @OA\Property(property="fee_tax_rate2", type="number", format="float", example="2.0", description="______"),
* @OA\Property(property="fee_cap", type="number", format="float", example="2.0", description="______"),
* )
*/

8
app/Http/Controllers/OpenAPI/PaymentSchema.php Normal file
View File

@ -0,0 +1,8 @@
<?php
/**
* @OA\Schema(
* schema="Payment",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* )
*/

8
app/Http/Controllers/OpenAPI/ProductSchema.php Normal file
View File

@ -0,0 +1,8 @@
<?php
/**
* @OA\Schema(
* schema="Product",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* )
*/

8
app/Http/Controllers/OpenAPI/QuoteSchema.php Normal file
View File

@ -0,0 +1,8 @@
<?php
/**
* @OA\Schema(
* schema="Quote",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* )
*/

8
app/Http/Controllers/OpenAPI/RecurringInvoice.php Normal file
View File

@ -0,0 +1,8 @@
<?php
/**
* @OA\Schema(
* schema="RecurringInvoice",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* )
*/

8
app/Http/Controllers/OpenAPI/RecurringQuote.php Normal file
View File

@ -0,0 +1,8 @@
<?php
/**
* @OA\Schema(
* schema="RecurringQuote",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* )
*/

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

@ -488,11 +488,11 @@ class PaymentController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The Payment User response",
* description="The Payment 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/PaymentUser"),
* @OA\JsonContent(ref="#/components/schemas/Payment"),
* ),
* @OA\Response(
* response=422,

6
app/Http/Controllers/ProductController.php
View File

@ -427,7 +427,7 @@ class ProductController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/index"),
* @OA\RequestBody(
* description="User credentials",
* description="Hashed IDs",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
@ -443,11 +443,11 @@ class ProductController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The Product User response",
* description="The Product 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/ProductUser"),
* @OA\JsonContent(ref="#/components/schemas/Product"),
* ),
* @OA\Response(
* response=422,

6
app/Http/Controllers/QuoteController.php
View File

@ -464,7 +464,7 @@ class QuoteController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/index"),
* @OA\RequestBody(
* description="User credentials",
* description="Hashed ids",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
@ -480,11 +480,11 @@ class QuoteController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The Quote User response",
* description="The Quote 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/QuoteUser"),
* @OA\JsonContent(ref="#/components/schemas/Quote"),
* ),
* @OA\Response(
* response=422,

6
app/Http/Controllers/RecurringInvoiceController.php
View File

@ -474,7 +474,7 @@ class RecurringInvoiceController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/index"),
* @OA\RequestBody(
* description="User credentials",
* description="Hashed IDs",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
@ -490,11 +490,11 @@ class RecurringInvoiceController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The RecurringInvoice User response",
* description="The RecurringInvoice 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/RecurringInvoiceUser"),
* @OA\JsonContent(ref="#/components/schemas/RecurringInvoice"),
* ),
* @OA\Response(
* response=422,

6
app/Http/Controllers/RecurringQuoteController.php
View File

@ -472,7 +472,7 @@ class RecurringQuoteController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/index"),
* @OA\RequestBody(
* description="User credentials",
* description="Hashed ids",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
@ -488,11 +488,11 @@ class RecurringQuoteController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The RecurringQuote User response",
* description="The RecurringQuote 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/RecurringQuoteUser"),
* @OA\JsonContent(ref="#/components/schemas/RecurringQuote"),
* ),
* @OA\Response(
* response=422,

6
app/Http/Controllers/UserController.php
View File

@ -471,7 +471,7 @@ class UserController extends BaseController
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/index"),
* @OA\RequestBody(
* description="User credentials",
* description="Hashed ids",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
@ -487,11 +487,11 @@ class UserController extends BaseController
* ),
* @OA\Response(
* response=200,
* description="The User User response",
* description="The 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/UserUser"),
* @OA\JsonContent(ref="#/components/schemas/User"),
* ),
* @OA\Response(
* response=422,