Merge pull request #5 from Adventure-Tech/feature/new-amounts-object

Feature/new amounts object

api/availability/Availabilities.yaml → endpoints/availability/Availabilities.yaml

@@ -1,5 +1,5 @@
 get:
-  description: Returns a single product based on its ID
+  description: Returns paginated list of availabilities
   tags: [ Availabilities API ]
   parameters:
     - name: from
@@ -26,7 +26,7 @@ get:
           type: integer
   responses:
     200:
-      description: Successfully retrieved the product from the server
+      description: Successfully retrieved the availabilities from the server
       content:
         application/json:
           schema:
@@ -35,4 +35,21 @@ get:
               data:
                 type: array
                 items:
-                  $ref: '../../schemas/availabilities/Availability.yaml'
+                  $ref: '../../schemas/availabilities/Availability.yaml'
+              links:
+                $ref: '../../schemas/pagination/Links.yaml'
+post:
+  description: Creates new availability
+  tags: [ Availabilities API ]
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/availabilities/Availability.yaml'
+  responses:
+    201:
+      description: Successfully created new availability on the server
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/availabilities/AvailabilityWrapped.yaml'

endpoints/availability/Availability.yaml

@@ -0,0 +1,41 @@
+get:
+  description: Returns a single availability based on its ID
+  tags: [ Availabilities API ]
+  parameters:
+    - $ref: '../../parameters/path/AvailabilityId.yaml'
+  responses:
+    200:
+      description: Successfully retrieved the availability from the server
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/availabilities/AvailabilityWrapped.yaml'
+    404:
+      $ref: '../../responses/404NotFound.yaml'
+patch:
+  description: Patch a specific availability based on its ID. This is inspired by the JSON patch syntax with some modifications such as custom operations and modified array referencing
+  tags: [ Availabilities API ]
+  parameters:
+    - $ref: '../../parameters/path/AvailabilityId.yaml'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: array
+          items:
+            $ref: '../../schemas/jsonpatch/PatchObject.yaml'
+  responses:
+    200:
+      description: Successfully updated the availability on the server
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/availabilities/AvailabilityWrapped.yaml'
+delete:
+  description: Delete a specific availability based on its ID
+  tags: [ Availabilities API ]
+  parameters:
+    - $ref: '../../parameters/path/AvailabilityID.yaml'
+  responses:
+    200:
+      description: Successfully deleted the availability on the server

api/products/Product.yaml → endpoints/products/ProductEndpoints.yaml

@@ -9,7 +9,11 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../schemas/products/ProductWrapped.yaml'
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/products/Product.yaml'
     404:
       $ref: '../../responses/404NotFound.yaml'
 patch:
@@ -30,12 +34,16 @@ patch:
       content:
         application/json:
           schema:
-            $ref: '../../schemas/products/ProductWrapped.yaml'
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/products/Product.yaml'
 delete:
-  description: Cancel a specific product based on its ID
+  description: Soft-delete a specific product based on its ID
   tags: [ Products API ]
   parameters:
     - $ref: '../../parameters/path/ProductId.yaml'
   responses:
     200:
-      description: Successfully cancelled the product on the server
+      description: Successfully soft-deleted the product on the server

api/products/Products.yaml → endpoints/products/ProductsEndpoints.yaml

@@ -32,4 +32,8 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../../schemas/products/ProductWrapped.yaml'
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/products/Product.yaml'

endpoints/vat/VatEndpoints.yaml

@@ -0,0 +1,49 @@
+get:
+  description: Returns a single vat model based on its ID
+  tags: [ VAT API ]
+  parameters:
+    - $ref: '../../parameters/path/VatModelId.yaml'
+  responses:
+    200:
+      description: Successfully retrieved the vat model from the server
+      content:
+        application/json:
+          schema:
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/vat/VatModel.yaml'
+    404:
+      $ref: '../../responses/404NotFound.yaml'
+patch:
+  description: Patch a specific vat model based on its ID. This is inspired by the JSON patch syntax with some modifications such as custom operations and modified array referencing
+  tags: [ VAT API ]
+  parameters:
+    - $ref: '../../parameters/path/VatModelId.yaml'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: array
+          items:
+            $ref: '../../schemas/jsonpatch/PatchObject.yaml'
+  responses:
+    200:
+      description: Successfully updated the vat model on the server
+      content:
+        application/json:
+          schema:
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/vat/VatModel.yaml'
+delete:
+  description: Soft-delete a specific vat model based on its ID
+  tags: [ VAT API ]
+  parameters:
+    - $ref: '../../parameters/path/VatModelId.yaml'
+  responses:
+    200:
+      description: Successfully deleted the vat model on the server

endpoints/vat/VatsEndpoints.yaml

@@ -0,0 +1,39 @@
+get:
+  description: Returns paginated list of vat models
+  tags: [ VAT API ]
+  parameters:
+    - $ref: '../../parameters/query/PageCursor.yaml'
+    - $ref: '../../parameters/query/PerPage.yaml'
+  responses:
+    200:
+      description: Successfully retrieved vat models from the server
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              data:
+                type: array
+                items:
+                  $ref: '../../schemas/vat/VatModel.yaml'
+              links:
+                $ref: '../../schemas/pagination/Links.yaml'
+post:
+  description: Creates new vat model
+  tags: [ VAT API ]
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/vat/VatModel.yaml'
+  responses:
+    201:
+      description: Successfully created new vat model on the server
+      content:
+        application/json:
+          schema:
+            type: object
+            required: [ data ]
+            properties:
+              data:
+                $ref: '../../schemas/vat/VatModel.yaml'

openapi.yaml

@@ -7,30 +7,33 @@ info:
 
 servers:
   - url: 'https://bilberry.test/api/v0'
-  - url: 'https://bilberry-v3-staging-sxren.ondigitalocean.app/api/v0'
 
 #security:
 #  - BasicAuth: []
 
 paths:
   /products:
-    $ref: './api/products/Products.yaml'
+    $ref: './endpoints/products/ProductsEndpoints.yaml'
   /product/{product}:
-    $ref: './api/products/Product.yaml'
-  /availabilities:
-    $ref: './api/availability/Availabilities.yaml'
+    $ref: './endpoints/products/ProductEndpoints.yaml'
+#  /availabilities:
+#    $ref: './endpoints/availability/Availabilities.yaml'
+#  /availabilities/{availability}:
+#    $ref: './endpoints/availability/Availability.yaml'
   /bookings:
-    $ref: './api/bookings/Bookings.yaml'
+    $ref: './endpoints/bookings/BookingsEndpoints.yaml'
   /bookings/{booking}:
-    $ref: './api/bookings/Booking.yaml'
+    $ref: './endpoints/bookings/BookingEndpoints.yaml'
   /invoices/{invoice}:
-    $ref: './api/reporting/Invoice.yaml'
+    $ref: './endpoints/reporting/InvoiceEndpoints.yaml'
   /notifications:
-    $ref: './api/notifications/Notifications.yaml'
+    $ref: './endpoints/notifications/NotificationsEndpoints.yaml'
 
   /users: {}
-  /instances: {}
   /resources: {}
-  /vat-models: {}
+  /vat-models:
+    $ref: './endpoints/vat/VatsEndpoints.yaml'
+  /vat-models/{vat}:
+    $ref: './endpoints/vat/VatEndpoints.yaml'
   /reports: {}
   /staff: {}

parameters/path/AvailabilityId.yaml

@@ -0,0 +1,7 @@
+name: availability
+in: path
+required: true
+description: The availability ID
+schema:
+  type: integer
+  minimum: 0

parameters/path/VatModelId.yaml

@@ -0,0 +1,7 @@
+name: vat
+in: path
+required: true
+description: The vat model ID
+schema:
+  type: integer
+  minimum: 0

schemas/availabilities/Availability.yaml

@@ -1,23 +1,28 @@
 type: object
-required:
-  - productId
-  - ticketOptionId
-  - bookableId
-  - availability
+required: [productId, ticketOptionId, productId, availability, price, maxCapacity]
 properties:
-  productId:
-    type: integer
+  id:
+    $ref: '../types/ID.yaml'
+  createdAt:
+    $ref: '../types/CreatedAt.yaml'
   ticketOptionId:
     type: integer
-  bookableId:
+  productId:
     type: integer
+    readOnly: true
   availability:
     type: integer
+    readOnly: true
     minimum: 0
   start:
     type: string
     format: date-time
   end:
     type: string
     format: date-time
+  price:
+    $ref: '../prices/Price.yaml'
+  maxCapacity:
+    type: integer
+    minimum: 0
   # cutoff, refund policy, price,

schemas/products/ProductWrapped.yaml → schemas/availabilities/AvailabilityWrapped.yaml

@@ -2,4 +2,4 @@ type: object
 required: [data]
 properties:
   data:
-    $ref: './Product.yaml'
+    $ref: './Availability.yaml'

schemas/bookings/Booking.yaml

@@ -16,18 +16,7 @@ allOf:
       tickets:
         type: array
         items:
-          type: object
-          required: [ id, bookableId, quantity ]
-          properties:
-            id:
-              $ref: '../types/ULID.yaml'
-            bookableId:
-              type: integer
-            quantity:
-              type: integer
-              minimum: 1
-              default: 1
-              # TODO: more info about product, ticket option etc?
+          $ref: './Ticket.yaml'
       invoice:
         allOf:
           - $ref: '../reporting/InvoiceShort.yaml'

schemas/bookings/BookingMetaInfo.yaml

@@ -1,17 +1,19 @@
-type: object
-required: [firstName, lastName, email, phone]
-properties:
-  firstName:
-    type: string
-    nullable: true
-  lastName:
-    type: string
-    nullable: true
-  email:
-    type: string
-    format: email
-    nullable: true
-  phone:
-    allOf:
-      - $ref: '../types/PhoneNumber.yaml'
-      - nullable: true
+allOf:
+  - type: object
+    required: [firstName, lastName, email, phone]
+    properties:
+      firstName:
+        type: string
+        nullable: true
+      lastName:
+        type: string
+        nullable: true
+      email:
+        type: string
+        format: email
+        nullable: true
+      phone:
+        allOf:
+          - $ref: '../types/PhoneNumber.yaml'
+          - nullable: true
+  - $ref: '../types/Address.yaml' # TODO: nullability