Abfrage von Zuhebörteilen, wie z.B. Schläuchen

src/v2/shop.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
     title: "TyrePro-API, Shop"
-    version: "Version 12"
+    version: "Version 13"
 servers:
     - url: "https://musterreifen.com/api/shop"
       description: "Development server, customers domain"
@@ -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,9 @@ 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"
+      - $ref: "#/components/parameters/GuidShopArticleConfig"
       responses:
         200:
           description: "successful operation"
@@ -628,33 +568,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 +589,9 @@ 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"
+      - $ref: "#/components/parameters/GuidShopArticleConfig"
       - name: "SearchTerm2"
         in: "query"
         required: false
@@ -760,23 +660,74 @@ paths:
           $ref: "#/components/responses/GenericError"
       security: 
       - SessionScheme: []
-  /ShopArticleStockDetails:
+# ArticleDetails
+  /ShopArticleAccessories:
     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"
+      - $ref: "#/components/parameters/GuidBranch"
+      - $ref: "#/components/parameters/GuidCalculationProfile"
+      - $ref: "#/components/parameters/GuidShopArticleConfig"
       responses:
         200:
           description: "successful operation"
+          headers:
+            Guid-Shop-Article-Config:
+              schema:
+                type: "string"
+              description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  $ref: "#/components/schemas/ShopArticle"
+        default:
+          $ref: "#/components/responses/GenericError"
+      security: 
+      - SessionScheme: []
+  /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:
+      - "ArticleDetails"
+      parameters:
+      - $ref: "#/components/parameters/GuidOnlineService"
+      - $ref: "#/components/parameters/GuidDeliveryType"
+      - $ref: "#/components/parameters/GuidShopArticle"
+      - $ref: "#/components/parameters/GuidShopArticleConfig"
+      responses:
+        200:
+          description: "successful operation"
+          headers:
+            Guid-Shop-Article-Config:
+              schema:
+                type: "string"
+              description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
           content:
             application/json:
               schema:
@@ -1053,22 +1004,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 +1124,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 +1144,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 +2194,48 @@ 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"
+      GuidShopArticleConfig:
+        name: "GuidShopArticleConfig"
+        in: "query"
+        required: false
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
       SearchTerm:
         name: "SearchTerm"
         in: "query"
@@ -2314,7 +2267,6 @@ components:
 
 # MISSING
 # GET /Vehicles
-# GET /Tubes