ausdigital/ausdigital-dcl:1.0

ausdigital · Jan 30, 2017 · da4fee0 · da4fee0
1 parent fb472f1
commit da4fee0
Showing 1 changed file with 72 additions and 2 deletions.
diff --git a/APIs/swagger.json b/APIs/swagger.json
@@ -3,7 +3,77 @@
   "info" : {
     "version" : "1.0",
     "title" : "Digital Capability Locator (DCL) interface specification",
-    "description" : "The \"Digital Capability Lookup\" (DCL) specification defines a DNS based method to discover which DCP(SMP) is the authoritative source for a given business"
+    "description" : "The \"Digital Capability Lookup\" (DCL) specification defines a DNS based method to discover which DCP(SMP) is the authoritative source for a given business\n\nAPI uses JWT authorization, JWT issuer must be added to whitelist on DCL implementation. It's passed as a header `Authorization: JWT XXX`, where XXX value provided by your IDP.\n"
   },
-  "paths" : { }
+  "host" : "dcp.testpoint.io",
+  "schemes" : [ "https" ],
+  "basePath" : "/api/v0",
+  "produces" : [ "application/json" ],
+  "parameters" : {
+    "participantIdUrlParameter" : {
+      "name" : "participant_id",
+      "in" : "path",
+      "description" : "string representation",
+      "required" : true,
+      "type" : "string",
+      "default" : "urn:oasis:names:tc:ebcore:partyid-type:iso6523:0151::22341388307"
+    }
+  },
+  "paths" : {
+    "/demo_auth/" : {
+      "get" : {
+        "tags" : [ "auth" ],
+        "summary" : "Get base user information with authentication enabled",
+        "description" : "Check if OIDC JWT token is correct",
+        "operationId" : "DemoAuth",
+        "responses" : {
+          "200" : {
+            "description" : "The JWT is correct"
+          },
+          "401" : {
+            "description" : "Wrong auth parameters"
+          }
+        }
+      }
+    },
+    "/dcl/{participant_id}" : {
+      "put" : {
+        "tags" : [ "DCL" ],
+        "summary" : "Update DCP value",
+        "description" : "Updates DNS NAPTR record with new DCP value for given business/participant",
+        "operationId" : "DclPut",
+        "parameters" : [ {
+          "$ref" : "#/parameters/participantIdUrlParameter"
+        }, {
+          "description" : "New DCP info",
+          "in" : "body",
+          "name" : "body",
+          "required" : true,
+          "schema" : {
+            "properties" : {
+              "dcp" : {
+                "description" : "new DCP hostname (for example, dcp.testpoint.io)",
+                "type" : "string",
+                "format" : "string"
+              }
+            }
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "Success"
+          },
+          "401" : {
+            "description" : "Wrong Auth Header"
+          },
+          "404" : {
+            "description" : "Participant Not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        }
+      }
+    }
+  }
 }