From b4fb5dc4030b4de477942630ebe3b98b882ae978 Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Sat, 26 Apr 2025 11:17:16 +0700 Subject: [PATCH] doc/radosgw: Fix RST syntax rendeded as text in oidc.rst Empty line after starting a pre-formatted block with the double-colon syntax is required, otherwise the double-colon does nothing and is just rendered as-is as "::" and there would be no following pre-formatted block. Add empty lines after the double-colon syntax so that the following block is rendered pre-formatted. Also add bash privileged prompts to a block with 2 example CLI commands. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> --- doc/radosgw/oidc.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/radosgw/oidc.rst b/doc/radosgw/oidc.rst index de3725a9b3701..c7516d65fc1d8 100644 --- a/doc/radosgw/oidc.rst +++ b/doc/radosgw/oidc.rst @@ -11,10 +11,10 @@ The following REST APIs can be used for creating and managing an OpenID Connect In order to invoke the REST admin APIs, a user with admin caps needs to be created. -.. code-block:: javascript +.. prompt:: bash # - radosgw-admin --uid TESTER --display-name "TestUser" --access_key TESTER --secret test123 user create - radosgw-admin caps add --uid="TESTER" --caps="oidc-provider=*" + radosgw-admin --uid TESTER --display-name "TestUser" --access_key TESTER --secret test123 user create + radosgw-admin caps add --uid="TESTER" --caps="oidc-provider=*" CreateOpenIDConnectProvider @@ -42,6 +42,7 @@ Request Parameters Example:: + POST "?Action=Action=CreateOpenIDConnectProvider &ThumbprintList.list.1=F7D7B3515DD0D319DD219A43A9EA727AD6065287 &ClientIDList.list.1=app-profile-jsp @@ -62,6 +63,7 @@ Request Parameters :Type: String Example:: + POST "?Action=Action=DeleteOpenIDConnectProvider &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart" @@ -80,6 +82,7 @@ Request Parameters :Type: String Example:: + POST "?Action=Action=GetOpenIDConnectProvider &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart" @@ -94,6 +97,7 @@ Request Parameters None Example:: + POST "?Action=Action=ListOpenIDConnectProviders AddClientIDToOpenIDConnectProvider @@ -115,6 +119,7 @@ Request Parameters :Type: String Example:: + POST "?Action=Action=AddClientIDToOpenIDConnectProvider &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart &ClientID=app-jee-jsp" @@ -138,6 +143,7 @@ Request Parameters :Type: String Example:: + POST "?Action=Action=RemoveClientIDFromOpenIDConnectProvider &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart &ClientID=app-jee-jsp" @@ -162,6 +168,7 @@ Request Parameters :Type: Array of Strings Example:: + POST "?Action=Action=UpdateOpenIDConnectProviderThumbprint &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart &&ThumbprintList.list.1=ABCDB3515DD0D319DD219A43A9EA727AD6061234" -- 2.39.5