Update schema

Author: karlomikus

CHANGELOG.md

@@ -1,6 +1,6 @@
 # v5.9.0
 # New
-- Added `public/{slugOrId}` endpoints
+- Documented `public/{slugOrId}` endpoints
     - You can now access public bar data via `public/{slugOrId}` endpoints
     - Added GET `public/{slugOrId}/menu` endpoint
     - Added GET `public/{slugOrId}/cocktails` endpoint

app/Http/Controllers/Public/BarController.php

@@ -23,7 +23,7 @@ class BarController extends Controller
     public function show(string $slugOrId): BarResource
     {
         $bar = Bar::where('slug', $slugOrId)->orWhere('id', $slugOrId)->firstOrFail();
-        if (!$bar->is_public) {
+        if (!$bar->isPublic()) {
             abort(404);
         }
 

app/Http/Controllers/Public/CocktailController.php

@@ -39,7 +39,7 @@ class CocktailController extends Controller
     public function index(Request $request, string $slugOrId): JsonResource
     {
         $bar = Bar::where('slug', $slugOrId)->orWhere('id', $slugOrId)->firstOrFail();
-        if (!$bar->is_public) {
+        if (!$bar->isPublic()) {
             abort(404);
         }
 
@@ -66,23 +66,22 @@ public function index(Request $request, string $slugOrId): JsonResource
         return CocktailResource::collection($cocktails->withQueryString());
     }
 
-    #[OAT\Get(path: '/public/{slugOrId}/cocktails/{slugOrPublicId}', tags: ['Public'], operationId: 'showPublicBarCocktail', description: 'Show public information about cocktail. If valid public ID is provided it will used, if not it will use cocktail slug.', summary: 'Show cocktail', parameters: [
+    #[OAT\Get(path: '/public/{slugOrId}/cocktails/{cocktailSlug}', tags: ['Public'], operationId: 'showPublicBarCocktail', description: 'Show public information about cocktail.', summary: 'Show cocktail', parameters: [
         new OAT\Parameter(name: 'slugOrId', in: 'path', required: true, description: 'Database id of bar', schema: new OAT\Schema(type: 'string')),
-        new OAT\Parameter(name: 'slugOrPublicId', in: 'path', required: true, description: 'Cocktail slug or public id (ULID)', schema: new OAT\Schema(type: 'string')),
+        new OAT\Parameter(name: 'cocktailSlug', in: 'path', required: true, description: 'Cocktail slug', schema: new OAT\Schema(type: 'string')),
     ], security: [])]
     #[BAO\SuccessfulResponse(content: [
         new BAO\WrapObjectWithData(CocktailResource::class),
     ])]
     #[BAO\NotFoundResponse]
-    public function show(string $barId, string $slugOrPublicId): CocktailResource
+    public function show(string $barId, string $cocktailSlug): CocktailResource
     {
         $bar = Bar::where('slug', $barId)->orWhere('id', $barId)->firstOrFail();
-        if (!$bar->is_public) {
+        if (!$bar->isPublic()) {
             abort(404);
         }
 
-        $cocktail = Cocktail::where('public_id', $slugOrPublicId)
-            ->orWhere('slug', $slugOrPublicId)
+        $cocktail = Cocktail::where('slug', $cocktailSlug)
             ->with('ingredients.ingredient', 'ingredients.substitutes.ingredient', 'images', 'tags', 'utensils')
             ->firstOrFail();
 

app/Http/Controllers/Public/MenuController.php

@@ -12,7 +12,7 @@
 
 class MenuController extends Controller
 {
-    #[OAT\Get(path: '/public/{slugOrId}/menu', tags: ['Public'], operationId: 'showPublicBarMenu', description: 'Show a public bar menu details', summary: 'Show public menu', parameters: [
+    #[OAT\Get(path: '/public/{slugOrId}/menu', tags: ['Public'], operationId: 'showPublicBarMenu', description: 'Show a public bar menu details. The bar must have menu enabled.', summary: 'Show public menu', parameters: [
     new OAT\Parameter(name: 'slugOrId', in: 'path', required: true, description: 'Database id or slug of bar', schema: new OAT\Schema(type: 'string')),
     ], security: [])]
     #[BAO\SuccessfulResponse(content: [

app/Http/Resources/BarResource.php

@@ -99,7 +99,7 @@ public function toArray($request)
                 $this->relationLoaded('images'),
                 fn () => ImageResource::collection($this->images)
             ),
-            'is_public' => (bool) $this->is_public,
+            'is_public' => $this->is_public,
         ];
     }
 }

app/Models/Bar.php

@@ -186,6 +186,16 @@ public function isAccessible(): bool
         return $this->status !== BarStatusEnum::Deactivated->value;
     }
 
+    public function isProvisioning(): bool
+    {
+        return $this->status === BarStatusEnum::Provisioning->value;
+    }
+
+    public function isPublic(): bool
+    {
+        return $this->is_public && $this->isAccessible() && !$this->isProvisioning();
+    }
+
     public function getIngredientsDirectory(): string
     {
         return 'ingredients/' . $this->id . '/';

docs/openapi-generated.yaml

@@ -5983,12 +5983,12 @@ paths:
                   data: { $ref: '#/components/schemas/APIError' }
                 type: object
       security: []
-  '/public/{slugOrId}/cocktails/{slugOrPublicId}':
+  '/public/{slugOrId}/cocktails/{cocktailSlug}':
     get:
       tags:
         - Public
       summary: 'Show cocktail'
-      description: 'Show public information about cocktail. If valid public ID is provided it will used, if not it will use cocktail slug.'
+      description: 'Show public information about cocktail.'
       operationId: showPublicBarCocktail
       parameters:
         -
@@ -5999,9 +5999,9 @@ paths:
           schema:
             type: string
         -
-          name: slugOrPublicId
+          name: cocktailSlug
           in: path
-          description: 'Cocktail slug or public id (ULID)'
+          description: 'Cocktail slug'
           required: true
           schema:
             type: string
@@ -6048,7 +6048,7 @@ paths:
       tags:
         - Public
       summary: 'Show public menu'
-      description: 'Show a public bar menu details'
+      description: 'Show a public bar menu details. The bar must have menu enabled.'
       operationId: showPublicBarMenu
       parameters:
         -