Skip to content

Commit 32e70a4

Browse files
committed
Some documentation readjustments
1 parent 87e037c commit 32e70a4

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

doc/src/user_guide/appendix_a.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
223223
- Yes - No callback
224224
* - Transaction Guard (TG)
225225
- No
226-
- Yes
226+
- No
227227
* - Data Guard (DG) and Active Data Guard (ADG)
228228
- Yes
229229
- Yes

doc/src/user_guide/connection_handling.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2601,9 +2601,9 @@ for token generation. This hook function sets the ``accessToken`` parameter of
26012601
the connection methods to a callback function which uses the configuration
26022602
parameters to generate OAuth 2.0 tokens.
26032603
2604-
The plugin implementation can be seen in `plugins/tokens/extensionAzure/
2605-
index.js <https://github.com/oracle/node-oracledb/tree/main/plugins/tokens/
2606-
extensionAzure/index.js>`__.
2604+
The ``extensionAzure`` plugin is available as part of the `plugins/tokens
2605+
<https://github.com/oracle/node-oracledb/tree/main/plugins/tokens/
2606+
extensionAzure/index.js>`__ directory in the node-oracledb package.
26072607
26082608
For OAuth 2.0 token-based authentication with the ``extensionAzure`` plugin,
26092609
the ``tokenAuthConfigAzure`` connection parameter must be specified. This
@@ -3086,9 +3086,9 @@ for token generation. This hook function sets the ``accessToken`` parameter of
30863086
the connection methods to a callback function which uses the configuration
30873087
parameters to generate IAM tokens.
30883088
3089-
The plugin implementation can be seen in `plugins/tokens/extensionOci/
3090-
index.js <https://github.com/oracle/node-oracledb/tree/main/plugins/tokens/
3091-
extensionOci/index.js>`__.
3089+
The ``extensionOci`` plugin is available as part of the `plugins/tokens
3090+
<https://github.com/oracle/node-oracledb/tree/main/plugins/tokens/
3091+
extensionOci/index.js>`__ directory in the node-oracledb package.
30923092
30933093
For OCI IAM token-based authentication with the :ref:`extensionOci
30943094
<extensionociplugin>` plugin, the ``tokenAuthConfigOci`` connection parameter

doc/src/user_guide/extensions.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,10 @@ Extending node-oracledb
99
You can extend the functionalities of node-oracledb by using plugins. The
1010
plugins provided by node-oracledb are listed in this section.
1111

12-
.. _extensionazureplugin:
13-
14-
Azure Cloud Native Authentication Plugin
15-
========================================
16-
17-
Node-oracledb's ``extensionAzure`` plugin enables token generation using `Azure
18-
Software Development Kit (SDK) <https://www.npmjs.com/~azure-sdk>`__ when
19-
authenticating with OAuth 2.0 token-based authentication.
20-
21-
The ``extensionAzure`` plugin implementation is available as part of the
22-
`plugins/tokens <https://github.com/oracle/node-oracledb/tree/main/plugins/
23-
tokens/extensionAzure/index.js>`__ directory in the node-oracledb package.
24-
This plugin requires the minimum Node.js version supported by Azure SDK.
25-
26-
Adding this plugin to your code defines and registers a built-in hook function
27-
that generates OAuth 2.0 tokens. This function is internally invoked when the
28-
``tokenAuthConfigAzure`` property is specified in the
29-
:meth:`oracledb.getConnection()` or :meth:`oracledb.createPool()`.
30-
31-
See :ref:`cloudnativeauthoauth` for more information.
32-
3312
.. _extensionociplugin:
3413

35-
extensionOci Plugin
36-
===================
14+
Oracle Cloud Infrastructure (OCI) Cloud Native Authentication Plugin
15+
====================================================================
3716

3817
Node-oracledb's ``extensionOci`` plugin enables token generation using `OCI
3918
Software Development Kit (SDK) <https://www.npmjs.com/package/oci-sdk>`__ when
@@ -52,3 +31,24 @@ that generates IAM tokens. This function is internally invoked when the
5231
:meth:`oracledb.getConnection()` or :meth:`oracledb.createPool()`.
5332

5433
See :ref:`cloudnativeauthoci` for more information.
34+
35+
.. _extensionazureplugin:
36+
37+
Azure Cloud Native Authentication Plugin
38+
========================================
39+
40+
Node-oracledb's ``extensionAzure`` plugin enables token generation using `Azure
41+
Software Development Kit (SDK) <https://www.npmjs.com/~azure-sdk>`__ when
42+
authenticating with OAuth 2.0 token-based authentication.
43+
44+
The ``extensionAzure`` plugin implementation is available as part of the
45+
`plugins/tokens <https://github.com/oracle/node-oracledb/tree/main/plugins/
46+
tokens/extensionAzure/index.js>`__ directory in the node-oracledb package.
47+
This plugin requires the minimum Node.js version supported by Azure SDK.
48+
49+
Adding this plugin to your code defines and registers a built-in hook function
50+
that generates OAuth 2.0 tokens. This function is internally invoked when the
51+
``tokenAuthConfigAzure`` property is specified in the
52+
:meth:`oracledb.getConnection()` or :meth:`oracledb.createPool()`.
53+
54+
See :ref:`cloudnativeauthoauth` for more information.

0 commit comments

Comments
 (0)