feat: Add linted swagger docs

cheqd · Dec 2, 2022 · fee09d6 · fee09d6
1 parent 2fe76ff
commit fee09d6
Show file tree

Hide file tree

Showing 5 changed files with 1,067 additions and 28 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -43,8 +43,7 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "example": "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY",
-                        "description": "DID Doc Id",
+                        "description": "did",
                         "name": "did",
                         "in": "path",
                         "required": true
@@ -97,18 +96,12 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "example": "did:cheqd:testnet:MjYxNzYKMjYxNzYK",
                         "description": "Resource collection id. DID Doc Id",
                         "name": "did",
                         "in": "path",
                         "required": true
                     },
                     {
-                        "enum": [
-                            "application/did+ld+json",
-                            "application/ld+json",
-                            "application/did+json"
-                        ],
                         "type": "string",
                         "description": "The requested media type of the DID document representation or DID resolution result. ",
                         "name": "accept",
@@ -162,15 +155,13 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "example": "did:cheqd:testnet:MjYxNzYKMjYxNzYK",
                         "description": "Resource collection id. DID Doc Id",
                         "name": "did",
                         "in": "path",
                         "required": true
                     },
                     {
                         "type": "string",
-                        "example": "60ad67be-b65b-40b8-b2f4-3923141ef382",
                         "description": "DID Resource identifier",
                         "name": "resourceId",
                         "in": "path",
@@ -238,16 +229,14 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "example": "did:cheqd:testnet:MjYxNzYKMjYxNzYK",
                         "description": "Resource collection id. DID Doc Id",
                         "name": "did",
                         "in": "path",
                         "required": true
                     },
                     {
                         "type": "string",
-                        "example": "60ad67be-b65b-40b8-b2f4-3923141ef382",
-                        "description": "DID Resource identifier",
+                        "description": "Resource identifier",
                         "name": "resourceId",
                         "in": "path",
                         "required": true
@@ -318,22 +307,20 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "example": "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY",
-                        "description": "DID Doc Id",
+                        "description": "did",
                         "name": "did",
                         "in": "path",
                         "required": true
                     },
                     {
                         "type": "string",
-                        "example": "#key1",
                         "description": "` + "`" + `#` + "`" + ` + DID Doc Verification Method or Service identifier",
                         "name": "fragmentId",
-                        "in": "path"
+                        "in": "path",
+                        "required": true
                     },
                     {
                         "type": "string",
-                        "example": "\"service1\"",
                         "description": "Service id",
                         "name": "service",
                         "in": "query"