Merge pull request #10 from plugoinc/feat/OCPI-61

fix: response_format
plugoinc · Aug 15, 2023 · 94fbe98 · 94fbe98
2 parents 3703f0b + 1631495
commit 94fbe98
Show file tree

Hide file tree

Showing 15 changed files with 97 additions and 123 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
@@ -1,16 +1,9 @@
-required:
-  - result
-  - timeout
-type: object
-properties:
-  result:
-    type: string
-    enum:
-      - NOT_SUPPORTED
-      - REJECTED
-      - UNKNOWN_SESSION
-      - ACCEPTED
-  timeout:
-    type: integer
-  message:
-    $ref: ../schemas/DisplayText.yaml
+description: Success
+content:
+  application/json:
+    schema:
+      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
@@ -0,0 +1,9 @@
+description: Success
+content:
+  application/json:
+    schema:
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Session.yaml
diff --git a/openapi/components/responses/SessionsResponse.yaml b/openapi/components/responses/SessionsResponse.yaml
@@ -0,0 +1,16 @@
+description: Success
+headers:
+  Link:
+    $ref: ../headers/Link.yaml
+  X-Total-Count:
+    $ref: ../headers/X-Total-Count.yaml
+  X-Limit:
+    $ref: ../headers/X-Limit.yaml
+content:
+  application/json:
+    schema:
+      allOf:
+        - $ref: ./BaseResponse.yaml
+        - properties:
+            data:
+              $ref: ../schemas/Sessions.yaml
diff --git a/openapi/components/responses/Unauthorized.yaml b/openapi/components/responses/Unauthorized.yaml
@@ -1 +1 @@
-description: Unauthorized status code
+description: Unauthorized
diff --git a/openapi/components/schemas/CommandResponse.yaml b/openapi/components/schemas/CommandResponse.yaml
@@ -0,0 +1,17 @@
+required:
+  - result
+  - timeout
+type: object
+properties:
+  result:
+    type: string
+    enum:
+      - NOT_SUPPORTED
+      - REJECTED
+      - UNKNOWN_SESSION
+      - ACCEPTED
+    example: ACCEPTED
+  timeout:
+    type: integer
+  message:
+    $ref: ../schemas/DisplayText.yaml
diff --git a/openapi/paths/commands_start_session.yaml b/openapi/paths/commands_start_session.yaml
@@ -14,11 +14,7 @@ post:
           $ref: ../components/schemas/StartSession.yaml
   responses:
     200:
-      description: OK
-      content:
-        application/json:
-          schema:
-            $ref: ../components/responses/CommandResponse.yaml
+      $ref: ../components/responses/CommandResponse.yaml
+
     401:
-      description: Unauthorized
       $ref: ../components/responses/Unauthorized.yaml
diff --git a/openapi/paths/commands_stop_session.yaml b/openapi/paths/commands_stop_session.yaml
@@ -13,10 +13,8 @@ post:
   responses:
     200:
       description: OK
-      content:
-        application/json:
-          schema:
-            $ref: ../components/responses/CommandResponse.yaml
+      $ref: ../components/responses/CommandResponse.yaml
+
     401:
       description: Unauthorized
       $ref: ../components/responses/Unauthorized.yaml
diff --git a/openapi/paths/sessions.yaml b/openapi/paths/sessions.yaml
@@ -14,18 +14,7 @@ get:
     - $ref: ../components/parameters/collectionLimit.yaml
   responses:
     "200":
-      description: Success
-      headers:
-        Link:
-          $ref: ../components/headers/Link.yaml
-        X-Total-Count:
-          $ref: ../components/headers/X-Total-Count.yaml
-        X-Limit:
-          $ref: ../components/headers/X-Limit.yaml
-      content:
-        application/json:
-          schema:
-            $ref: ../components/schemas/Sessions.yaml
+      $ref: ../components/responses/SessionsResponse.yaml
     "401":
       description: Unauthorized
       $ref: ../components/responses/Unauthorized.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
@@ -13,14 +13,9 @@ get:
     - $ref: ../components/parameters/sessionId.yaml
   responses:
     "200":
-      description: Success
-      content:
-        application/json:
-          schema:
-            $ref: ../components/schemas/Session.yaml
-    "403":
-      description: Forbidden
-      $ref: ../components/responses/Problem.yaml
+      $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