Reorganization for better understanding

2025-10-16 10:14:28 +02:00 · 2025-10-16 10:14:28 +02:00 · 574b8caf49
parent dacc6cade4
commit 574b8caf49
1 changed files with 75 additions and 167 deletions
--- a/src/v2/shop.yaml
+++ b/src/v2/shop.yaml
@ -71,29 +71,9 @@ paths:
      tags:
      - "General"
      parameters:
-      - name: "GuidCart"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
+      - $ref: "#/components/parameters/GuidCart"
      responses:
        200:
          description: "successful operation"
@ -163,29 +143,9 @@ paths:
      tags:
      - "General"
      parameters:
-      - name: "GuidCart"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
+      - $ref: "#/components/parameters/GuidCart"
      responses:
        200:
          description: "successful operation"
@ -493,6 +453,7 @@ paths:
      - $ref: "#/components/parameters/GuidOffset"
      - $ref: "#/components/parameters/GuidHubBoreHole"
      - $ref: "#/components/parameters/GuidManufacturer"
+      - $ref: "#/components/parameters/GuidBranch"
      - name: "Type"
        description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
        in: "query"
@ -514,14 +475,6 @@ paths:
              - "Offset"
              - "HubBoreHole"
              - "Manufacturer"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
      responses:
        200:
          description: "successful operation"
@ -594,22 +547,8 @@ paths:
      - $ref: "#/components/parameters/GuidManufacturer"
      - $ref: "#/components/parameters/BinaryObjectContentType"
      - $ref: "#/components/parameters/GuidDeliveryType"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
      responses:
        200:
          description: "successful operation"
@ -628,33 +567,6 @@ paths:
          $ref: "#/components/responses/GenericError"
      security: 
      - SessionScheme: []
-  /ShopArticleInformations:
-    get:
-      tags:
-      - "Search"
-      parameters:
-      - $ref: "#/components/parameters/BinaryObjectContentType"
-      - $ref: "#/components/parameters/GuidOnlineService"
-      - name: "GuidShopArticle"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      responses:
-        200:
-          description: "successful operation"
-          content:
-            application/json:
-              schema:
-                type: "array"
-                items:
-                  $ref: "#/components/schemas/ShopArticleInformation"
-        default:
-          $ref: "#/components/responses/GenericError"
-      security: 
-      - SessionScheme: []
  /ShopArticlePairs:
    get:
      tags:
@ -676,22 +588,8 @@ paths:
      - $ref: "#/components/parameters/GuidManufacturer"
      - $ref: "#/components/parameters/BinaryObjectContentType"
      - $ref: "#/components/parameters/GuidDeliveryType"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
      - name: "SearchTerm2"
        in: "query"
        required: false
@ -760,20 +658,36 @@ paths:
          $ref: "#/components/responses/GenericError"
      security: 
      - SessionScheme: []
+# ArticleDetails
+  /ShopArticleInformations:
+    get:
+      tags:
+      - "ArticleDetails"
+      parameters:
+      - $ref: "#/components/parameters/BinaryObjectContentType"
+      - $ref: "#/components/parameters/GuidOnlineService"
+      - $ref: "#/components/parameters/GuidShopArticle"
+      responses:
+        200:
+          description: "successful operation"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  $ref: "#/components/schemas/ShopArticleInformation"
+        default:
+          $ref: "#/components/responses/GenericError"
+      security: 
+      - SessionScheme: []
  /ShopArticleStockDetails:
    get:
      tags:
-      - "Search"
+      - "ArticleDetails"
      parameters:
      - $ref: "#/components/parameters/GuidOnlineService"
      - $ref: "#/components/parameters/GuidDeliveryType"
-      - name: "GuidShopArticle"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidShopArticle"
      responses:
        200:
          description: "successful operation"
@ -1053,22 +967,8 @@ paths:
      - "Cart"
      parameters:
      - $ref: "#/components/parameters/GuidOnlineService"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
      responses:
        200:
          description: "successful operation"
@ -1187,29 +1087,9 @@ paths:
      tags:
      - "Cart"
      parameters:
-      - name: "GuidCart"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidBranch"
-        description: "Required for providing stock and price information."
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidCalculationProfile"
-        description: "If provided, the prices will base on this profile."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
+      - $ref: "#/components/parameters/GuidCart"
      responses:
        200:
          description: "successful operation"
@ -1227,13 +1107,7 @@ paths:
      tags:
      - "Cart"
      parameters:
-      - name: "GuidCart"
-        in: "query"
-        required: true
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      - $ref: "#/components/parameters/GuidCart"
      requestBody:
        required: true
        content:
@ -2283,6 +2157,40 @@ components:
          type: "string"
          default: null
          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      GuidBranch:
+        name: "GuidBranch"
+        description: "Required for providing stock and price information."
+        in: "query"
+        required: true
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      GuidCalculationProfile:
+        name: "GuidCalculationProfile"
+        description: "If provided, the prices will base on this profile."
+        in: "query"
+        required: false
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      GuidCart:
+        name: "GuidCart"
+        in: "query"
+        required: true
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      GuidShopArticle:
+        name: "GuidShopArticle"
+        in: "query"
+        required: true
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
      SearchTerm:
        name: "SearchTerm"
        in: "query"