DOCSP-11926 - Fix capitalization for BlockList and AllowList. (#37)

* DOCSP-11926 - Fix capitalization for BlockList and AllowList.

Author: jdestefano-mongo

source/kafka-sink-postprocessors.txt

@@ -44,26 +44,26 @@ class:
 
        .. seealso:: :ref:`Strategy options and configuration <config-document-id-adder>`.
 
-   * - BlocklistKeyProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistKeyProjector``
+   * - BlockListKeyProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListKeyProjector``
        | Removes matching key fields from the sink record.
 
        .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
 
-   * - BlocklistValueProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector``
+   * - BlockListValueProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListValueProjector``
        | Removes matching value fields from the sink record.
 
        .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
 
-   * - AllowlistKeyProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistKeyProjector``
+   * - AllowListKeyProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListKeyProjector``
        | Includes only matching key fields from the sink record.
 
        .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
 
-   * - AllowlistValueProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector``
+   * - AllowListValueProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListValueProjector``
        | matching value fields from the sink record.
 
        .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
@@ -90,7 +90,7 @@ comma separated list of fully-qualified ``PostProcessor`` class names:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.AllowListValueProjector
 
 .. note::
 
@@ -148,12 +148,12 @@ provided with this connector:
 
    * - PartialKeyStrategy
      - | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialKeyStrategy``
-       | Uses a blocklist or allowlist projection of the key structure of the ``SinkDocument``.
+       | Uses a block list or allow list projection of the key structure of the ``SinkDocument``.
        | Defaults to a blank document if no key exists.
 
    * - PartialValueStrategy
      - | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy``
-       | Uses a blocklist or allowlist projection of the value structure of the ``SinkDocument``.
+       | Uses a block list or allow list projection of the value structure of the ``SinkDocument``.
        | Defaults to a blank document if no value exists.
 
    * - UuidProvidedInKeyStrategy
@@ -190,7 +190,7 @@ setting.
 
 .. _config-blocklist-allowlist:
 
-Blocklist / Allowlist Projector
+Block List / Allow List Projector
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This section provides example projection configurations to show how they
@@ -235,16 +235,16 @@ filter the following sample record:
 
 .. _blocklist-example:
 
-Blocklist Projection Example
+Block List Projection Example
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In the following example sink configuration, we specify a blocklist
+In the following example sink configuration, we specify a block list
 projection and the specific fields to omit from the record:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Blocklist[Key|Value]Projector
-   [key|value].projection.type=blocklist
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.BlockList[Key|Value]Projector
+   [key|value].projection.type=BlockList
    [key|value].projection.list=age,address.city,lut.key2,data.v
 
 .. note::
@@ -283,16 +283,16 @@ The record contains the following data after applying the projection:
 
 .. _allowlist-example:
 
-Allowlist Projection Example
+Allow List Projection Example
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In the following example sink configuration, we specify a allowlist
+In the following example sink configuration, we specify an allow list
 projection and the specific fields to include in the record:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Allowlist[Key|Value]Projector
-   [key|value].projection.type=allowlist
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.AllowList[Key|Value]Projector
+   [key|value].projection.type=AllowList
    [key|value].projection.list=age,address.city,lut.key2,data.v
 
 .. note::
@@ -359,15 +359,15 @@ projection output from the following sample record:
      }
    }
 
-**Allowlist Wildcard Examples**
+**Allow List Wildcard Examples**
 
 The ``*`` wildcard pattern in the example below matches all the keys named
 ``temp`` in the ``forecast`` array and all fields nested a single level
 below it.
 
 .. code-block:: properties
 
-   [key|value].projection.type=allowlist
+   [key|value].projection.type=AllowList
    [key|value].projection.list=city,forecast.temp.*
 
 The record contains the following data after applying the projection:
@@ -395,7 +395,7 @@ all levels that contain the field ``scale``.
 
 .. code-block:: properties
 
-   [key|value].projection.type=allowlist
+   [key|value].projection.type=AllowList
    [key|value].projection.list=**.scale
 
 The record contains the following data after applying the projection:
@@ -410,15 +410,15 @@ The record contains the following data after applying the projection:
      }
    }
 
-**Blocklist Wildcard Examples**
+**Block List Wildcard Examples**
 
 The wildcard character can also be used to match all field names at
-specific levels as demonstrated in the following blocklist projection
+specific levels as demonstrated in the following block list projection
 configuration example:
 
 .. code-block:: properties
 
-   [key|value].projection.type=blocklist
+   [key|value].projection.type=BlockList
    [key|value].projection.list=population,forecast.*.*
 
 The record contains the following data after applying the projection:
@@ -442,7 +442,7 @@ specified.
 
 .. code-block:: properties
 
-   [key|value].projection.type=blocklist
+   [key|value].projection.type=BlockList
    [key|value].projection.list=**.high
 
    {
@@ -724,7 +724,7 @@ file:
 
    document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy
    value.projection.list=flight_no,airport_code
-   value.projection.type=allowlist
+   value.projection.type=AllowList
    writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy"
 
 The sample data inserted into the collection contains the following:
@@ -765,7 +765,7 @@ values without changing the ``_id`` field.
    The ``PartialValueStrategy`` id strategy uses the
    ``[key|value].projection.type`` and ``[key|value].projection.list``
    settings to define which fields are used to form the ``_id`` field.
-   Since the Blocklist and Allowlist post processors use the same
+   Since the Block List and Allow List post processors use the same
    projection settings, they cannot be specified separately. Use a `Single
    Message Transform (SMT)
    <https://docs.confluent.io/current/connect/transforms/index.html>`_

source/kafka-sink-properties.txt

@@ -173,7 +173,7 @@ data to sink to MongoDB. For an example configuration file, see
      - | The type of key projection to use.
        |
        | **Default**: ``none``
-       | **Accepted Values**:  ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
+       | **Accepted Values**:  ``none``, ``BlockList``, or ``AllowList`` (*Deprecated: blacklist, whitelist*)
 
    * - post.processor.chain
      - list
@@ -208,7 +208,7 @@ data to sink to MongoDB. For an example configuration file, see
      - | The type of value projection to use.
        |
        | **Default**: ``none``
-       | **Accepted Values**: ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
+       | **Accepted Values**: ``none``, ``BlockList``, or ``AllowList`` (*Deprecated: blacklist, whitelist*)
 
    * - writemodel.strategy
      - string
@@ -269,8 +269,8 @@ Example: Override Connector Sink Settings on TopicA
    topic.override.topicA.collection=collectionA
    topic.override.topicA.max.batch.size=100
    topic.override.topicA.document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.UuidStrategy
-   topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector
-   topic.override.topicA.value.projection.type=blocklist
+   topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlockListValueProjector
+   topic.override.topicA.value.projection.type=BlockList
    topic.override.topicA.value.projection.list=k2,k4
 
 The sink connector topic override settings instruct the connector to apply
@@ -279,7 +279,8 @@ the following behavior for data consumed from ``topicA``:
 - Write documents to the MongoDB collection ``collectionA`` in batches of
   up to 100.
 - Generate a UUID to be stored in the ``_id`` field for each new document.
-- Omit fields ``k2`` and ``k4`` from the value projection using a blocklist.
+- Omit fields ``k2`` and ``k4`` from the value projection using the
+  ``BlockList`` projection type.
 
 
 Dead Letter Queue Configuration Settings