]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: Fix RST syntax rendeded as text in oidc.rst 62988/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Sat, 26 Apr 2025 04:17:16 +0000 (11:17 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Sat, 26 Apr 2025 04:17:16 +0000 (11:17 +0700)
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

index de3725a9b3701c5fb5e12daf516873b315a6eaca..c7516d65fc1d87282fa71b926826d756bafc15e2 100644 (file)
@@ -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 "<hostname>?Action=Action=CreateOpenIDConnectProvider
     &ThumbprintList.list.1=F7D7B3515DD0D319DD219A43A9EA727AD6065287
     &ClientIDList.list.1=app-profile-jsp
@@ -62,6 +63,7 @@ Request Parameters
 :Type: String
 
 Example::
+
   POST "<hostname>?Action=Action=DeleteOpenIDConnectProvider
     &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart"
 
@@ -80,6 +82,7 @@ Request Parameters
 :Type: String
 
 Example::
+
   POST "<hostname>?Action=Action=GetOpenIDConnectProvider
     &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart"
 
@@ -94,6 +97,7 @@ Request Parameters
 None
 
 Example::
+
   POST "<hostname>?Action=Action=ListOpenIDConnectProviders
 
 AddClientIDToOpenIDConnectProvider
@@ -115,6 +119,7 @@ Request Parameters
 :Type: String
 
 Example::
+
   POST "<hostname>?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 "<hostname>?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 "<hostname>?Action=Action=UpdateOpenIDConnectProviderThumbprint
     &OpenIDConnectProviderArn=arn:aws:iam:::oidc-provider/localhost:8080/auth/realms/quickstart
     &&ThumbprintList.list.1=ABCDB3515DD0D319DD219A43A9EA727AD6061234"