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

Padding out OpenAPI definitions

Browse Source
This commit is contained in:
David Bomba 2022-08-11 10:47:34 +10:00
parent 04642b0324
commit f6c377a10a
3 changed files with 38 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
app/Http/Controllers/OpenAPI/ActivitySchema.php
View File

@ -3,20 +3,21 @@
* @OA\Schema(
* schema="Activity",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="activity_type_id", type="string", example="2", description="______"),
* @OA\Property(property="client_id", type="string", example="2", description="______"),
* @OA\Property(property="company_id", type="string", example="2", description="______"),
* @OA\Property(property="user_id", type="string", example="2", description="______"),
* @OA\Property(property="invoice_id", type="string", example="2", description="______"),
* @OA\Property(property="payment_id", type="string", example="2", description="______"),
* @OA\Property(property="credit_id", type="string", example="2", description="______"),
* @OA\Property(property="updated_at", type="string", example="2", description="______"),
* @OA\Property(property="expense_id", type="string", example="2", description="______"),
* @OA\Property(property="is_system", type="boolean", example=true, description="______"),
* @OA\Property(property="contact_id", type="string", example="2", description="______"),
* @OA\Property(property="task_id", type="string", example="2", description="______"),
* @OA\Property(property="notes", type="string", example="2", description="______"),
* @OA\Property(property="ip", type="string", example="2", description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The id field of the activity"),
* @OA\Property(property="activity_type_id", type="string", example="Opnel5aKBz", description="The activity type id"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The client hashed id"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The company hashed id"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The user hashed id"),
* @OA\Property(property="invoice_id", type="string", example="Opnel5aKBz", description="The invoice hashed id"),
* @OA\Property(property="payment_id", type="string", example="Opnel5aKBz", description="The payment hashed id"),
* @OA\Property(property="credit_id", type="string", example="Opnel5aKBz", description="The credit hashed id"),
* @OA\Property(property="updated_at", type="integer", example="343421434", description="Unixtimestamp the last time the record was updated"),
* @OA\Property(property="expense_id", type="string", example="Opnel5aKBz", description="The expense hashed id"),
* @OA\Property(property="is_system", type="boolean", example=true, description="Defines is the activity was performed by the system"),
* @OA\Property(property="contact_id", type="string", example="Opnel5aKBz", description="The contact hashed id"),
* @OA\Property(property="task_id", type="string", example="Opnel5aKBz", description="The task hashed id"),
* @OA\Property(property="notes", type="string", example="Opnel5aKBz", description="Activity Notes"),
* @OA\Property(property="token_id", type="string", example="Opnel5aKBz", description="The hashed ID of the token who performed the action"),
* @OA\Property(property="ip", type="string", example="192.168.1.252", description="The IP Address of the user who performed the action"),
* )
*/

1
app/Http/Controllers/OpenAPI/BankTransaction.php
View File

@ -6,7 +6,6 @@
* @OA\Property(property="id", type="string", example="AS3df3A", description="The bank integration hashed id"),
* @OA\Property(property="company_id", type="string", example="AS3df3A", description="The company hashed id"),
* @OA\Property(property="user_id", type="string", example="AS3df3A", description="The user hashed id"),
* @OA\Property(property="transaction_id", type="integer", example=343434, description="The id of the transaction"),
* @OA\Property(property="amount", type="number", example=10.00, description="The transaction amount"),
* @OA\Property(property="currency_code", type="string", example="USD", description="The ISO 3166 3 character currency code"),

45
app/Http/Controllers/OpenAPI/ClientContactSchema.php
View File

@ -3,29 +3,28 @@
* @OA\Schema(
* schema="ClientContact",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="company_id", type="string", example="", description="________"),
* @OA\Property(property="client_id", type="string", example="", description="________"),
* @OA\Property(property="first_name", type="string", example="", description="________"),
* @OA\Property(property="last_name", type="string", example="", description="________"),
* @OA\Property(property="phone", type="string", example="", description="________"),
* @OA\Property(property="custom_value1", type="string", example="", description="________"),
* @OA\Property(property="custom_value2", type="string", example="", description="________"),
* @OA\Property(property="custom_value3", type="string", example="", description="________"),
* @OA\Property(property="custom_value4", type="string", example="", description="________"),
* @OA\Property(property="email", type="string", example="", description="________"),
* @OA\Property(property="accepted_terms_version", type="string", example="", description="________"),
* @OA\Property(property="password", type="string", example="", description="________"),
* @OA\Property(property="confirmation-code", type="string", example="", description="________"),
* @OA\Property(property="token", type="string", example="", description="________"),
* @OA\Property(property="is_primary", type="boolean", example=true, description="________"),
* @OA\Property(property="confirmed", type="boolean", example=true, description="________"),
* @OA\Property(property="is_locked", type="boolean", example=true, description="________"),
* @OA\Property(property="send_email", type="boolean", example=true, description="________"),
* @OA\Property(property="failed_logins", type="number", format="integer", example="3", description="________"),
* @OA\Property(property="email_verified_at", type="number", format="integer", example="134341234234", description="________"),
* @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed if of the contact"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user who created the contact"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The hashed id of the company"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The hashed id of the client"),
* @OA\Property(property="first_name", type="string", example="John", description="The first name of the contact"),
* @OA\Property(property="last_name", type="string", example="Doe", description="The last name of the contact"),
* @OA\Property(property="phone", type="string", example="555-152-4524", description="The phone number of the contact"),
* @OA\Property(property="custom_value1", type="string", example="", description="A Custom field value"),
* @OA\Property(property="custom_value2", type="string", example="", description="A Custom field value"),
* @OA\Property(property="custom_value3", type="string", example="", description="A Custom field value"),
* @OA\Property(property="custom_value4", type="string", example="", description="A Custom field value"),
* @OA\Property(property="email", type="string", example="", description="The email of the contact"),
* @OA\Property(property="accepted_terms_version", type="string", example="A long set of ToS", description="The terms of service which the contact has accpeted"),
* @OA\Property(property="password", type="string", example="*****", description="The hashed password of the contact"),
* @OA\Property(property="confirmation-code", type="string", example="333-sdjkh34gbasd", description="The confirmation code used to authenticate the contacts email address"),
* @OA\Property(property="token", type="string", example="333-sdjkh34gbasd", description="A uuid based token."),
* @OA\Property(property="is_primary", type="boolean", example=true, description="Defines is this contact is the primary contact for the client"),
* @OA\Property(property="confirmed", type="boolean", example=true, description="Boolean value confirms the user has confirmed their account."),
* @OA\Property(property="is_locked", type="boolean", example=true, description="Boolean value defines if the contact has been locked out."),
* @OA\Property(property="send_email", type="boolean", example=true, description="Boolean value determines is this contact should receive emails"),
* @OA\Property(property="failed_logins", type="number", format="integer", example="3", description="The number of failed logins the contact has had"),
* @OA\Property(property="email_verified_at", type="number", format="integer", example="134341234234", description="The date which the contact confirmed their email"),
* @OA\Property(property="last_login", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="created_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="134341234234", description="Timestamp"),