refactor: 💡 allOf

plugoinc · Aug 15, 2023 · 1631495 · 1631495
1 parent 32e896e
commit 1631495
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 127 deletions.
diff --git a/openapi/components/responses/BadRequest.yaml b/openapi/components/responses/BadRequest.yaml
@@ -2,22 +2,7 @@ description: Bad Request
 content:
   application/json:
     schema:
-      type: object
-      required:
-        - status_code
-        - timestamp
-      properties:
-        status_code:
-          type: integer
-          enum:
-            - 400
-        status_message:
-          type: string
-          enum:
-            - Bad Request
-        timestamp:
-          type: string
-          format: date-time
+      $ref: ./BaseResponse.yaml
     example:
       status_code: 400
       status_message: Bad Request

diff --git a/openapi/components/responses/BaseResponse.yaml b/openapi/components/responses/BaseResponse.yaml
@@ -0,0 +1,14 @@
+required:
+  - status_code
+  - timestamp
+properties:
+  data:
+    description: Contains the actual response data object or list of objects from each request, depending on the cardinality of the response data, this is an array (card. * or +), or a single object (card. 1 or ?)
+  status_code:
+    type: number
+  status_message:
+    type: string
+  timestamp:
+    type: string
+    format: date-time
+    example: "2020-01-01T00:00:00Z"
diff --git a/openapi/components/responses/ChargingPreferencesResponse.yaml b/openapi/components/responses/ChargingPreferencesResponse.yaml
@@ -1,20 +1,15 @@
-required:
-  - status_code
-  - timestamp
-type: object
-properties:
-  status_code:
-    type: integer
-    format: int32
-  status_message:
-    type: string
-  data:
-    type: string
-    enum:
-      - ACCEPTED
-      - DEPARTURE_REQUIRED
-      - ENERGY_NEED_REQUIRED
-      - NOT_POSSIBLE
-      - PROFILE_TYPE_NOT_SUPPORTED
-  timestamp:
-    type: string
+description: Success
+content:
+  application/json:
+    schema:
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              type: string
+              enum:
+                - ACCEPTED
+                - DEPARTURE_REQUIRED
+                - ENERGY_NEED_REQUIRED
+                - NOT_POSSIBLE
+                - PROFILE_TYPE_NOT_SUPPORTED
diff --git a/openapi/components/responses/CommandResponse.yaml b/openapi/components/responses/CommandResponse.yaml
@@ -2,20 +2,8 @@ description: Success
 content:
   application/json:
     schema:
-      required:
-        - status_code
-        - timestamp
-      type: object
-      properties:
-        data:
-          $ref: ../schemas/CommandResponse.yaml
-        status_code:
-          type: integer
-          format: int32
-          example: 1000
-        status_message:
-          type: string
-          example: Success
-        timestamp:
-          type: string
-          example: "2020-01-01T00:00:00Z"
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/CommandResponse.yaml
diff --git a/openapi/components/responses/NotFound.yaml b/openapi/components/responses/NotFound.yaml
@@ -2,23 +2,7 @@ description: Not Found
 content:
   application/json:
     schema:
-      type: object
-      required:
-        - status_code
-        - timestamp
-      properties:
-        status_code:
-          type: integer
-          enum:
-            - 404
-        status_message:
-          type: string
-          enum:
-            - Not Found
-        timestamp:
-          type: string
-          format: date-time
-
+      $ref: BaseResponse.yaml
     example:
       status_code: 404
       status_message: Not Found

diff --git a/openapi/components/responses/OneTokenResponse.yaml b/openapi/components/responses/OneTokenResponse.yaml
@@ -2,21 +2,8 @@ description: Tokens GET Response with one Token object.
 content:
   application/json:
     schema:
-      type: object
-      required:
-        - status_code
-        - timestamp
-      properties:
-        data:
-          $ref: ../schemas/Token.yaml
-        status_code:
-          type: integer
-          enum:
-            - 1000
-        status_message:
-          type: string
-          enum:
-            - Success
-        timestamp:
-          type: string
-          format: date-time
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Token.yaml
diff --git a/openapi/components/responses/SessionResponse.yaml b/openapi/components/responses/SessionResponse.yaml
@@ -2,20 +2,8 @@ description: Success
 content:
   application/json:
     schema:
-      required:
-        - status_code
-        - timestamp
-      type: object
-      properties:
-        data:
-          $ref: ../schemas/Session.yaml
-        status_code:
-          type: integer
-          format: int32
-          example: 1000
-        status_message:
-          type: string
-          example: Success
-        timestamp:
-          type: string
-          example: "2020-01-01T00:00:00Z"
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Session.yaml
diff --git a/openapi/components/responses/SessionsResponse.yaml b/openapi/components/responses/SessionsResponse.yaml
@@ -9,20 +9,8 @@ headers:
 content:
   application/json:
     schema:
-      required:
-        - status_code
-        - timestamp
-      type: object
-      properties:
-        data:
-          $ref: ../schemas/Sessions.yaml
-        status_code:
-          type: integer
-          format: int32
-          example: 1000
-        status_message:
-          type: string
-          example: Success
-        timestamp:
-          type: string
-          example: "2020-01-01T00:00:00Z"
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Sessions.yaml
diff --git a/openapi/paths/sessions_{country_code}_{party_id}_{session_id}.yaml b/openapi/paths/sessions_{country_code}_{party_id}_{session_id}.yaml
@@ -14,6 +14,8 @@ get:
   responses:
     "200":
       $ref: ../components/responses/SessionResponse.yaml
+    "401":
+      $ref: ../components/responses/Unauthorized.yaml
 
 put:
   tags:

diff --git a/openapi/paths/sessions_{session_id}_charging_preferences.yaml b/openapi/paths/sessions_{session_id}_charging_preferences.yaml
@@ -18,11 +18,7 @@ put:
 
   responses:
     "200":
-      description: Success
-      content:
-        application/json:
-          schema:
-            $ref: ../components/responses/ChargingPreferencesResponse.yaml
+      $ref: ../components/responses/ChargingPreferencesResponse.yaml
     "403":
       description: Forbidden
       $ref: ../components/responses/Problem.yaml