From 1c95603b70e0db5215a4e3570ffe5a1929677843 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Thu, 18 Aug 2022 23:16:25 +1000 Subject: [PATCH] OpenAPI --- app/Http/Controllers/OpenAPI/VendorSchema.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/app/Http/Controllers/OpenAPI/VendorSchema.php b/app/Http/Controllers/OpenAPI/VendorSchema.php index fc91d2728012..8cf71c4ca9ea 100644 --- a/app/Http/Controllers/OpenAPI/VendorSchema.php +++ b/app/Http/Controllers/OpenAPI/VendorSchema.php @@ -3,11 +3,11 @@ * @OA\Schema( * schema="Vendor", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"), - * @OA\Property(property="user_id", type="string", example="", description="__________"), - * @OA\Property(property="assigned_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="id", type="string", example="Opnel5aKBz", description="The hashed id of the vendor"), + * @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user who created the vendor"), + * @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The hashed id of the assigned user to this vendor"), + * @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="contacts", * type="array", @@ -16,10 +16,10 @@ * ref="#/components/schemas/VendorContact", * ), * ), - * @OA\Property(property="name", type="string", example="", description="________"), - * @OA\Property(property="website", type="string", example="", description="________"), - * @OA\Property(property="private_notes", type="string", example="", description="________"), - * @OA\Property(property="industry_id", type="string", example="", description="________"), + * @OA\Property(property="name", type="string", example="Harry's cafe de wheels", description="The vendor name"), + * @OA\Property(property="website", type="string", example="www.harry.com", description="The website of the vendor"), + * @OA\Property(property="private_notes", type="string", example="Shhh, don't tell the vendor", description="The private notes of the vendor"), + * @OA\Property(property="industry_id", type="string", example="1", description="The industry id of the vendor"), * @OA\Property(property="size_id", type="string", example="", description="________"), * @OA\Property(property="address1", type="string", example="", description="________"), * @OA\Property(property="address2", type="string", example="", description="________"),