Add sample config for openapi spec to rtd

openxpki · Jan 26, 2021 · 224a569 · 224a569
1 parent 2c5eb14
commit 224a569
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/subsystems/rpc-openapi.rst b/doc/subsystems/rpc-openapi.rst
@@ -7,6 +7,12 @@ This is not really an own subsystem but it offers an auto-generated `OpenAPI <ht
 
 To generate the OpenAPI spec according to your current RPC configuration see :ref:`openapi-rpc-method`.
 
-The `info` block of the specification is by default set to contain a generic `title` and inherits the `version` number from `system.config.api` (as obtained by the `version` API call). To provide your own values for the info block, add a section `[openapi]` to the RPC wrapper configuration and set the expected values.
+The `info` block of the specification is by default set to contain a generic `title` and inherits the `version` number from `system.config.api` (as obtained by the `version` API call). To provide your own values for the info block, add a section `[openapi]` to the RPC wrapper configuration and set the expected values::
+
+    [openapi]
+    title = Public Certificate Reqest API
+    description = Request, Renew and Revoke your Certificates her
+    version = 42.1
+
 
 The data types of all relevant input/output parameters of those workflows exposed via RPC must be defined (in the workflow config) to be able to generate the OpenAPI spec. For details see :ref:`openapi-workflow-field-param`.
diff --git a/doc/subsystems/rpc.rst b/doc/subsystems/rpc.rst
@@ -137,7 +137,7 @@ code set in the return structure. The error codes consist of five digits,
 the first three digits are derived from the HTTP status codes followed by
 two digits for unambiguousness.
 
-To let the wrapper send the error code on HTTP layer, you need to set
+To let the wrapper send the error code on HTTP layer, you need to set::
 
   [output]
   use_http_status_codes=1