Provide Doc sample curl for SAML provider metadata url

[#138172103] https://www.pivotaltracker.com/story/show/138172103 Signed-off-by: Bharath Sekar <bharath.sekar@ge.com>
cloudfoundry · Aug 11, 2017 · a5caca9 · a5caca9
1 parent 66f3672
commit a5caca9
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/uaa/slateCustomizations/source/index.html.md.erb b/uaa/slateCustomizations/source/index.html.md.erb
@@ -763,6 +763,10 @@ _Error Codes_
 <%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProvider/http-request.md")).result(binding) %>
 <%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProvider/http-response.md")).result(binding) %>
 
+<%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProviderMetadataUrl/curl-request.md")).result(binding) %>
+<%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProviderMetadataUrl/http-request.md")).result(binding) %>
+<%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProviderMetadataUrl/http-response.md")).result(binding) %>
+
 _Request Headers_
 
 <%= ERB.new(File.read("../../build/generated-snippets/IdentityProviderEndpointsDocs/createSAMLIdentityProvider/request-headers.md")).result(binding) %>

diff --git a/...test/java/org/cloudfoundry/identity/uaa/mock/providers/IdentityProviderEndpointsDocs.java b/...test/java/org/cloudfoundry/identity/uaa/mock/providers/IdentityProviderEndpointsDocs.java
@@ -394,14 +394,42 @@ public void createSAMLIdentityProvider() throws Exception {
             fieldWithPath("config.zoneId").type(STRING).description("This will be set to the ID of the zone where the provider is being created")
         }));
 
-        ResultActions resultActions = getMockMvc().perform(post("/identity-providers")
+        ResultActions resultActionsMetadata = getMockMvc().perform(post("/identity-providers")
             .param("rawConfig", "true")
             .header("Authorization", "Bearer " + adminToken)
             .contentType(APPLICATION_JSON)
             .content(serializeExcludingProperties(identityProvider, "id", "version", "created", "last_modified", "identityZoneId", "config.zoneId", "config.idpEntityAlias", "config.additionalConfiguration")))
             .andExpect(status().isCreated());
 
-        resultActions.andDo(document("{ClassName}/{methodName}",
+        resultActionsMetadata.andDo(document("{ClassName}/{methodName}",
+            preprocessRequest(prettyPrint()),
+            preprocessResponse(prettyPrint()),
+            requestHeaders(
+                headerWithName("Authorization").description("Bearer token containing `zones.<zone id>.admin` or `uaa.admin` or `idps.write` (only in the same zone that you are a user of)"),
+                headerWithName("X-Identity-Zone-Id").description("May include this header to administer another zone if using `zones.<zone id>.admin` or `uaa.admin` scope against the default UAA zone.").optional()
+            ),
+            commonRequestParams,
+            requestFields,
+            responseFields
+        ));
+
+        SamlIdentityProviderDefinition providerDefinition = new SamlIdentityProviderDefinition()
+            .setMetaDataLocation("http://simplesamlphp.cfapps.io/saml2/idp/metadata.php")
+            .setNameID("urn:oasis:names:tc:SAML:1.1:nameid-format:transient")
+            .setLinkText("IDPEndpointsMockTests Saml Provider:" + identityProvider.getOriginKey())
+            .setZoneId(IdentityZone.getUaa().getId());
+
+        identityProvider.setConfig(providerDefinition);
+        identityProvider.setOriginKey(identityProvider.getOriginKey() + "MetadataUrl");
+
+        ResultActions resultActionsUrl = getMockMvc().perform(post("/identity-providers")
+            .param("rawConfig", "true")
+            .header("Authorization", "Bearer " + adminToken)
+            .contentType(APPLICATION_JSON)
+            .content(serializeExcludingProperties(identityProvider, "id", "version", "created", "last_modified", "identityZoneId", "config.zoneId", "config.idpEntityAlias", "config.additionalConfiguration")))
+            .andExpect(status().isCreated());
+
+        resultActionsUrl.andDo(document("{ClassName}/{methodName}MetadataUrl",
             preprocessRequest(prettyPrint()),
             preprocessResponse(prettyPrint()),
             requestHeaders(