Merge pull request #3 from hmrc/API-1914_openid_context

Updates to API definition:
hmrc · Aug 12, 2016 · f2b5d3c · f2b5d3c
2 parents 838082f + 5e11fe9
commit f2b5d3c
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/views/definition.scala.txt b/app/uk/gov/hmrc/openidconnect/userinfo/views/definition.scala.txt
@@ -7,7 +7,7 @@
     {
       "key":"openid",
       "name":"Confirm HMRC has a record of you",
-      "description":"Access your personal details"
+      "description":"Confirm HMRC has a record of you"
     },
     {
       "key":"profile",
@@ -26,25 +26,25 @@
     }
   ],
   "api":{
-    "name":"OpenID Connect UserInfo",
-    "description":"The OpenID Connect compliant API provides access to user information",
-    "context":"openid-connect-userinfo",
+    "name":"User Information",
+    "description":"The User Information API allows you to retrieve information about the signed-in user, in an OpenID Connect compliant format",
+    "context":"userinfo",
     "versions":[
       {
         "version":"1.0",
         "status":"PROTOTYPED",
         "access" : @Json.toJson(access),
         "endpoints":[
           {
-            "uriPattern":"/userinfo",
+            "uriPattern":"",
             "endpointName":"Get user info",
             "method":"GET",
             "authType":"USER",
             "throttlingTier":"UNLIMITED",
             "scope":"openid"
           },
           {
-            "uriPattern":"/userinfo",
+            "uriPattern":"",
             "endpointName":"Get user info POST",
             "method":"POST",
             "authType":"USER",

diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/views/getUserInfo.scala.xml b/app/uk/gov/hmrc/openidconnect/userinfo/views/getUserInfo.scala.xml
@@ -5,10 +5,10 @@
 
 <endpoint>
     <name>Get User Info</name>
-    <description>Retrieves OpenID Connect compliant user details </description>
+    <description>Retrieves OpenID Connect compliant information about the signed-in user</description>
     <section id="resource">
         <title>Resource</title>
-        <resource>GET /openid-connect-userinfo/userinfo</resource>
+        <resource>GET /userinfo</resource>
     </section>
     <section id="authorisation">
         <title>Authorisation</title>

diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/views/getUserInfoPost.scala.xml b/app/uk/gov/hmrc/openidconnect/userinfo/views/getUserInfoPost.scala.xml
@@ -5,10 +5,10 @@
 
 <endpoint>
     <name>Get User Info POST</name>
-    <description>Retrieves OpenID Connect compliant user details</description>
+    <description>Retrieves OpenID Connect compliant information about the signed-in user</description>
     <section id="resource">
         <title>Resource</title>
-        <resource>POST /openid-connect-userinfo/userinfo</resource>
+        <resource>POST /userinfo</resource>
     </section>
     <section id="authorisation">
         <title>Authorisation</title>

diff --git a/conf/application.conf b/conf/application.conf
@@ -83,7 +83,7 @@ controllers {
     }
 
     uk.gov.hmrc.openidconnect.userinfo.controllers.LiveUserInfoController = {
-        needsAuth = false
+        needsAuth = true
         needsLogging = true
         needsAuditing = false
         authParams.pattern = "/([\\d\\w-]+).*"

diff --git a/conf/live.routes b/conf/live.routes
@@ -1,2 +1,2 @@
-GET /userinfo             uk.gov.hmrc.openidconnect.userinfo.controllers.LiveUserInfoController.userInfo
-POST /userinfo            uk.gov.hmrc.openidconnect.userinfo.controllers.LiveUserInfoController.userInfo
+GET /             uk.gov.hmrc.openidconnect.userinfo.controllers.LiveUserInfoController.userInfo
+POST /            uk.gov.hmrc.openidconnect.userinfo.controllers.LiveUserInfoController.userInfo
diff --git a/conf/sandbox.routes b/conf/sandbox.routes
@@ -1,2 +1,2 @@
-GET /userinfo             uk.gov.hmrc.openidconnect.userinfo.controllers.SandboxUserInfoController.userInfo
-POST /userinfo            uk.gov.hmrc.openidconnect.userinfo.controllers.SandboxUserInfoController.userInfo
+GET /             uk.gov.hmrc.openidconnect.userinfo.controllers.SandboxUserInfoController.userInfo
+POST /            uk.gov.hmrc.openidconnect.userinfo.controllers.SandboxUserInfoController.userInfo