mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-05-31 06:24:35 -04:00
Fixes for api docs
This commit is contained in:
parent
b6bea31646
commit
a13b97b0cb
@ -34,18 +34,7 @@ use Turbo124\Beacon\Facades\LightLogs;
|
|||||||
|
|
||||||
class LoginController extends BaseController
|
class LoginController extends BaseController
|
||||||
{
|
{
|
||||||
/*
|
/**
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Login Controller
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| This controller handles authenticating users for the application and
|
|
||||||
| redirecting them to your home screen. The controller uses a trait
|
|
||||||
| to conveniently provide its functionality to your applications.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
* @OA\Tag(
|
* @OA\Tag(
|
||||||
* name="login",
|
* name="login",
|
||||||
* description="Authentication",
|
* description="Authentication",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Account",
|
* schema="Account",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Activity",
|
* schema="Activity",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="BulkAction",
|
* schema="BulkAction",
|
||||||
* type="array",
|
* type="array",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="ClientContact",
|
* schema="ClientContact",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="ClientGatewayToken",
|
* schema="ClientGatewayToken",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Client",
|
* schema="Client",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CompanyGateway",
|
* schema="CompanyGateway",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CompanyLedger",
|
* schema="CompanyLedger",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Company",
|
* schema="Company",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CompanySettings",
|
* schema="CompanySettings",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CompanyToken",
|
* schema="CompanyToken",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CompanyUser",
|
* schema="CompanyUser",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="CreditPaymentable",
|
* schema="CreditPaymentable",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Credit",
|
* schema="Credit",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Design",
|
* schema="Design",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Error",
|
* schema="Error",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Expense",
|
* schema="Expense",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="FeesAndLimits",
|
* schema="FeesAndLimits",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="GroupSetting",
|
* schema="GroupSetting",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Header(
|
* @OA\Header(
|
||||||
* header="X-MINIMUM-CLIENT-VERSION",
|
* header="X-MINIMUM-CLIENT-VERSION",
|
||||||
* description="The API version",
|
* description="The API version",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="InvoicePaymentable",
|
* schema="InvoicePaymentable",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Invoice",
|
* schema="Invoice",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Parameter(
|
* @OA\Parameter(
|
||||||
* name="X-Api-Secret",
|
* name="X-Api-Secret",
|
||||||
* in="header",
|
* in="header",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Payment",
|
* schema="Payment",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="PaymentTerm",
|
* schema="PaymentTerm",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Paymentable",
|
* schema="Paymentable",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Product",
|
* schema="Product",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
9
app/Http/Controllers/OpenAPI/ProjectSchema.php
Normal file
9
app/Http/Controllers/OpenAPI/ProjectSchema.php
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* @OA\Schema(
|
||||||
|
* schema="Project",
|
||||||
|
* type="object",
|
||||||
|
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
|
||||||
|
* @OA\Property(property="name", type="string", example="New Project", description="______"),
|
||||||
|
* )
|
||||||
|
*/
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Quote",
|
* schema="Quote",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="RecurringInvoice",
|
* schema="RecurringInvoice",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="RecurringQuote",
|
* schema="RecurringQuote",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="SystemLog",
|
* schema="SystemLog",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="TaxRate",
|
* schema="TaxRate",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Template",
|
* schema="Template",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="User",
|
* schema="User",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="ValidationError",
|
* schema="ValidationError",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="VendorContact",
|
* schema="VendorContact",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Vendor",
|
* schema="Vendor",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\Schema(
|
* @OA\Schema(
|
||||||
* schema="Webhook",
|
* schema="Webhook",
|
||||||
* type="object",
|
* type="object",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* @OA\OpenApi(
|
* @OA\OpenApi(
|
||||||
* @OA\Info(
|
* @OA\Info(
|
||||||
* version="1.0.30",
|
* version="1.0.30",
|
||||||
@ -15,8 +15,8 @@
|
|||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
* @OA\Server(
|
* @OA\Server(
|
||||||
* description="InvoiceNinja host",
|
* description="Example InvoiceNinja base url",
|
||||||
* url="https://virtserver.swaggerhub.com/InvoiceNinja/invoices/1.0.30"
|
* url="https://ninja.test"
|
||||||
* ),
|
* ),
|
||||||
* @OA\ExternalDocumentation(
|
* @OA\ExternalDocumentation(
|
||||||
* description="http://docs.invoiceninja.com",
|
* description="http://docs.invoiceninja.com",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user