1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-14 07:02:34 +01:00
invoiceninja/app/Http/Controllers/OpenAPI/DocumentSchema.php

24 lines
1.9 KiB
PHP
Raw Normal View History

2021-02-15 21:58:19 +01:00
<?php
/**
* @OA\Schema(
* schema="Document",
* type="object",
2022-08-12 12:44:09 +02:00
* @OA\Property(property="id", type="string", example="AS3df3A", description="The document hashed id"),
* @OA\Property(property="user_id", type="string", example="", description="The user hashed id"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="The assigned user hashed id"),
* @OA\Property(property="project_id", type="string", example="", description="The project associated with this document"),
* @OA\Property(property="vendor_id", type="string", example="", description="The vendor associated with this documents"),
* @OA\Property(property="name", type="string", example="Beauty", description="The document name"),
* @OA\Property(property="url", type="string", example="Beauty", description="The document url"),
* @OA\Property(property="preview", type="string", example="Beauty", description="The document preview url"),
* @OA\Property(property="type", type="string", example="Beauty", description="The document type"),
* @OA\Property(property="disk", type="string", example="Beauty", description="The document disk"),
* @OA\Property(property="hash", type="string", example="Beauty", description="The document hashed"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Flag to determine if the document is deleted"),
2021-02-15 21:58:19 +01:00
* @OA\Property(property="is_default", type="boolean", example=true, description="Flag to determine if the document is a default doc"),
* @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"),
* @OA\Property(property="deleted_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* )
*/