[PAPI-DEV] Update link references for meta object (#195)

personio · Aug 28, 2024 · 7a51f2b · 7a51f2b
1 parent c9f1ee9
commit 7a51f2b
Showing 1 changed file with 21 additions and 18 deletions.
diff --git a/common-components-v2.json b/common-components-v2.json
@@ -10,7 +10,7 @@
       "url": "https://api.personio.de"
     }
   ],
-  "paths": null,
+  "paths": {},
   "components": {
     "responses": {
       "NotFoundResponse": {
@@ -33,10 +33,14 @@
           "links": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
-            },
+              "$ref": "#/components/schemas/LinkObject"
+          },
             "example": {
-              "self": "https://api.personio.de/v2/person?cursor=<current-cursor>"
+              "links": {
+                "self": {
+                  "href": "https://api.personio.de/v2/person?cursor=<current-cursor>"
+                }
+              }
             }
           }
         }
@@ -51,20 +55,7 @@
             "description": "The id of the created resource."
           },
           "_meta": {
-            "readOnly": true,
-            "type": "object",
-            "properties": {
-              "links": {
-                "type": "object",
-                "properties": {
-                  "self": {
-                    "type": "string",
-                    "format": "uri",
-                    "example": "https://api.personio.de/v2/persons/some-person-id"
-                  }
-                }
-              }
-            }
+            "$ref": "#/components/schemas/MetaObject"
           }
         }
       },
@@ -206,6 +197,18 @@
             }
           }
         ]
+      },
+      "LinkObject": {
+        "description": "This objects represents a hyperlink.",
+        "type": "object",
+        "readOnly": true,
+        "properties": {
+          "href": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "additionalProperties": true
       }
     },
     "parameters": {