openapi: make explicit types for returned IDs

2025-04-02 13:57:41 -07:00 · 2025-04-02 13:57:41 -07:00 · 54b4cf2d13
commit 54b4cf2d13
parent 91ac3a5e36
2 changed files with 49 additions and 17 deletions
--- a/openapi-internal.yaml
+++ b/openapi-internal.yaml
@ -27,7 +27,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/MapfixID"
        default:
          description: General Error
          content:
@ -163,7 +163,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/SubmissionID"
        default:
          description: General Error
          content:
@ -320,7 +320,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/ScriptPolicyID"
        default:
          description: General Error
          content:
@ -394,7 +394,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/ScriptID"
        default:
          description: General Error
          content:
@ -474,12 +474,36 @@ components:
        minimum: 1
        maximum: 100
  schemas:
-    Id:
+    MapfixID:
      required:
-      - ID
+      - MapfixID
      type: object
      properties:
-        ID:
+        MapfixID:
+          type: integer
+          format: int64
+    SubmissionID:
+      required:
+      - SubmissionID
+      type: object
+      properties:
+        SubmissionID:
+          type: integer
+          format: int64
+    ScriptID:
+      required:
+      - ScriptID
+      type: object
+      properties:
+        ScriptID:
+          type: integer
+          format: int64
+    ScriptPolicyID:
+      required:
+      - ScriptPolicyID
+      type: object
+      properties:
+        ScriptPolicyID:
          type: integer
          format: int64
    MapfixCreate:
--- a/openapi.yaml
+++ b/openapi.yaml
@ -831,7 +831,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/ScriptPolicyID"
        default:
          description: General Error
          content:
@ -966,7 +966,7 @@ paths:
          content:
            application/json:
              schema:
-                $ref: "#/components/schemas/Id"
+                $ref: "#/components/schemas/ScriptID"
        default:
          description: General Error
          content:
@ -1106,14 +1106,6 @@ components:
        minimum: 1
        maximum: 100
  schemas:
-    Id:
-      required:
-      - ID
-      type: object
-      properties:
-        ID:
-          type: integer
-          format: int64
    OperationID:
      required:
      - OperationID
@ -1122,6 +1114,22 @@ components:
        OperationID:
          type: integer
          format: int32
+    ScriptID:
+      required:
+      - ScriptID
+      type: object
+      properties:
+        ScriptID:
+          type: integer
+          format: int64
+    ScriptPolicyID:
+      required:
+      - ScriptPolicyID
+      type: object
+      properties:
+        ScriptPolicyID:
+          type: integer
+          format: int64
    Roles:
      required:
      - Roles