Fixes for api docs

2024-09-20 08:21:34 +02:00 · 2020-10-10 23:07:52 +11:00 · 2020-10-10 23:07:52 +11:00 · a13b97b0cb
commit a13b97b0cb
parent b6bea31646
41 changed files with 51 additions and 53 deletions
--- a/app/Http/Controllers/Auth/LoginController.php
+++ b/app/Http/Controllers/Auth/LoginController.php
@ -34,18 +34,7 @@ use Turbo124\Beacon\Facades\LightLogs;

 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(
      *     name="login",
      *     description="Authentication",
--- a/app/Http/Controllers/OpenAPI/AccountSchema.php
+++ b/app/Http/Controllers/OpenAPI/AccountSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Account",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ActivitySchema.php
+++ b/app/Http/Controllers/OpenAPI/ActivitySchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Activity",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/BulkActionSchema.php
+++ b/app/Http/Controllers/OpenAPI/BulkActionSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="BulkAction",
 *   type="array",
--- a/app/Http/Controllers/OpenAPI/ClientContactSchema.php
+++ b/app/Http/Controllers/OpenAPI/ClientContactSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="ClientContact",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ClientGatewayToken.php
+++ b/app/Http/Controllers/OpenAPI/ClientGatewayToken.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="ClientGatewayToken",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ClientSchema.php
+++ b/app/Http/Controllers/OpenAPI/ClientSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Client",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CompanyGateway",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanyLedgerSchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanyLedgerSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CompanyLedger",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanySchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanySchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Company",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanySettingsSchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanySettingsSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CompanySettings",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanyTokenSchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanyTokenSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CompanyToken",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CompanyUserSchema.php
+++ b/app/Http/Controllers/OpenAPI/CompanyUserSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CompanyUser",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php
+++ b/app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="CreditPaymentable",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/CreditSchema.php
+++ b/app/Http/Controllers/OpenAPI/CreditSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Credit",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/DesignSchema.php
+++ b/app/Http/Controllers/OpenAPI/DesignSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Design",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ErrorSchema.php
+++ b/app/Http/Controllers/OpenAPI/ErrorSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Error",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ExpenseSchema.php
+++ b/app/Http/Controllers/OpenAPI/ExpenseSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Expense",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php
+++ b/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="FeesAndLimits",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/GroupSettingSchema.php
+++ b/app/Http/Controllers/OpenAPI/GroupSettingSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="GroupSetting",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/Headers.php
+++ b/app/Http/Controllers/OpenAPI/Headers.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Header(
 *     header="X-MINIMUM-CLIENT-VERSION",
 *     description="The API version",
--- a/app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php
+++ b/app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="InvoicePaymentable",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/InvoiceSchema.php
+++ b/app/Http/Controllers/OpenAPI/InvoiceSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Invoice",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/Parameters.php
+++ b/app/Http/Controllers/OpenAPI/Parameters.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 *     @OA\Parameter(
 *         name="X-Api-Secret",
 *         in="header",
--- a/app/Http/Controllers/OpenAPI/PaymentSchema.php
+++ b/app/Http/Controllers/OpenAPI/PaymentSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Payment",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/PaymentTermSchema.php
+++ b/app/Http/Controllers/OpenAPI/PaymentTermSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="PaymentTerm",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/PaymentableSchema.php
+++ b/app/Http/Controllers/OpenAPI/PaymentableSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Paymentable",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ProductSchema.php
+++ b/app/Http/Controllers/OpenAPI/ProductSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Product",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ProjectSchema.php
+++ b/app/Http/Controllers/OpenAPI/ProjectSchema.php
@ -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="______"),
+ * )
+ */
--- a/app/Http/Controllers/OpenAPI/QuoteSchema.php
+++ b/app/Http/Controllers/OpenAPI/QuoteSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Quote",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/RecurringInvoice.php
+++ b/app/Http/Controllers/OpenAPI/RecurringInvoice.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="RecurringInvoice",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/RecurringQuote.php
+++ b/app/Http/Controllers/OpenAPI/RecurringQuote.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="RecurringQuote",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/SystemLogSchema.php
+++ b/app/Http/Controllers/OpenAPI/SystemLogSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="SystemLog",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/TaxRateSchema.php
+++ b/app/Http/Controllers/OpenAPI/TaxRateSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="TaxRate",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/TemplateSchema.php
+++ b/app/Http/Controllers/OpenAPI/TemplateSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Template",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/UserSchema.php
+++ b/app/Http/Controllers/OpenAPI/UserSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="User",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/ValidationErrorSchema.php
+++ b/app/Http/Controllers/OpenAPI/ValidationErrorSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="ValidationError",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/VendorContact.php
+++ b/app/Http/Controllers/OpenAPI/VendorContact.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="VendorContact",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/VendorSchema.php
+++ b/app/Http/Controllers/OpenAPI/VendorSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Vendor",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/WebhookSchema.php
+++ b/app/Http/Controllers/OpenAPI/WebhookSchema.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\Schema(
 *   schema="Webhook",
 *   type="object",
--- a/app/Http/Controllers/OpenAPI/swagger-v3.php
+++ b/app/Http/Controllers/OpenAPI/swagger-v3.php
@ -1,5 +1,5 @@
 <?php
-/*
+/**
 * @OA\OpenApi(
 *     @OA\Info(
 *         version="1.0.30",
@ -15,8 +15,8 @@
 *         )
 *     ),
 *     @OA\Server(
- *         description="InvoiceNinja host",
- *         url="https://virtserver.swaggerhub.com/InvoiceNinja/invoices/1.0.30"
+ *         description="Example InvoiceNinja base url",
+ *         url="https://ninja.test"
 *     ),
 *     @OA\ExternalDocumentation(
 *         description="http://docs.invoiceninja.com",