fix: swagger validation errors

Signed-off-by: Sownak Roy <[email protected]>
cheqd · Dec 9, 2024 · c409fe9 · c409fe9
1 parent d311fb9
commit c409fe9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 28 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/static/swagger.json b/src/static/swagger.json
@@ -563,7 +563,6 @@
                         "type": "object",
                         "properties": {
                             "didDocument": {
-                                "description": "This input field contains the DID document to be used for the DID create operation. See <a href=\"https://identity.foundation/did-registration/#diddocument\">https://identity.foundation/did-registration/#diddocument</a>.",
                                 "$ref": "#/components/schemas/DidDocument"
                             }
                         }
@@ -808,14 +807,10 @@
                 "type": "object",
                 "properties": {
                     "id": {
-                        "$ref": "#/components/schemas/String",
-                        "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09"
+                        "$ref": "#/components/schemas/String"
                     },
                     "controller": {
-                        "$ref": "#/components/schemas/DidDocumentController",
-                        "example": [
-                            "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09"
-                        ]
+                        "$ref": "#/components/schemas/DidDocumentController"
                     },
                     "authentication": {
                         "type": "array",
@@ -886,7 +881,10 @@
                 "type": "array",
                 "items": {
                     "type": "string"
-                }
+                },
+                "example": [
+                    "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09"
+                ]
             },
             "DidDocumentVerificationMethod": {
                 "type": "array",
@@ -1033,12 +1031,11 @@
                 },
                 "properties": {
                     "state": {
-                        "$ref": "#/components/schemas/String",
-                        "example": "finished"
+                        "example": "finished",
+                        "$ref": "#/components/schemas/String"
                     },
                     "did": {
-                        "$ref": "#/components/schemas/String",
-                        "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09"
+                        "$ref": "#/components/schemas/String"
                     },
                     "secret": {
                         "$ref": "#/components/schemas/DidStateSecret"
@@ -1066,12 +1063,10 @@
                 },
                 "properties": {
                     "state": {
-                        "$ref": "#/components/schemas/String",
-                        "example": "finished"
+                        "$ref": "#/components/schemas/String"
                     },
                     "didUrl": {
-                        "$ref": "#/components/schemas/String",
-                        "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09"
+                        "$ref": "#/components/schemas/String"
                     },
                     "secret": {
                         "$ref": "#/components/schemas/DidStateSecret"
@@ -1261,16 +1256,18 @@
                         }
                     ]
                 },
-                "example": [{
-                    "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1",
-                    "type": "JsonWebKey2020",
-                    "privateKeyJwk": {
-                        "kty": "OKP",
-                        "crv": "Ed25519",
-                        "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
-                        "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
-                    }
-                }]
+                "example": [
+                    {
+                        "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1",
+                        "type": "JsonWebKey2020",
+                        "privateKeyJwk": {
+                            "kty": "OKP",
+                            "crv": "Ed25519",
+                            "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
+                            "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
+                        }
+                    }
+                ]
             },
             "SecretVerificationMethodVerificationMethodTemplate": {
                 "type": "array",