Prepare opensearch-py for 3.0.0 release (#907)

* Updated opensearch-py to reflect the latest OpenSearch API spec

Signed-off-by: saimedhi <[email protected]>

* Updated opensearch-py to reflect the latest OpenSearch API spec

Signed-off-by: saimedhi <[email protected]>

* Version bump changes

Signed-off-by: saimedhi <[email protected]>

* Enforce keyword-only arguments in opensearch-py to prevent usage of positional arguments.

Signed-off-by: saimedhi <[email protected]>

* Fixing failing unit tests

Signed-off-by: saimedhi <[email protected]>

* Fixing failing integ tests

Signed-off-by: saimedhi <[email protected]>

* Fixing lint errors

Signed-off-by: saimedhi <[email protected]>

* Fixed API Generator as needed for the latest spec changes

Signed-off-by: saimedhi <[email protected]>

* Removing deprecated APIS and corresponding tests

Signed-off-by: saimedhi <[email protected]>

* Update guides and samples to use keyword arguments instead of positional arguments

Signed-off-by: saimedhi <[email protected]>

* Removing deprecated API tests

Signed-off-by: saimedhi <[email protected]>

* skiping test

Signed-off-by: saimedhi <[email protected]>

* Updated search_shards api as per latest spec

Signed-off-by: saimedhi <[email protected]>

* Removing tests related to APIs that are no longer supported

Signed-off-by: saimedhi <[email protected]>

* Temporarily disabling codecov

Signed-off-by: saimedhi <[email protected]>

* skipping paginated wlm/stats api tests until spec is added

Signed-off-by: saimedhi <[email protected]>

---------

Signed-off-by: saimedhi <[email protected]>

Author: saimedhi

.github/workflows/integration-unreleased.yml

@@ -11,7 +11,7 @@ jobs:
         entry:
           - { branch: "1.x", java-version: "11" }
           - { branch: "2.x", java-version: "17" }
-          - { branch: "main", java-version: "17" }
+          - { branch: "main", java-version: "21" }
 
     steps:
       - name: Checkout OpenSearch

.github/workflows/integration.yml

@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        opensearch_version: [ '2.14.0', '2.16.0' ]
+        opensearch_version: [  '2.18.0', '2.19.2', '3.0.0' ]
         secured: [ "true", "false" ]
 
     steps:

.github/workflows/test.yml

@@ -36,8 +36,8 @@ jobs:
       - name: Run Tests
         run: |
           python -m nox -rs test-${{ matrix.entry.python-version }}
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./junit/opensearch-py-codecov.xml
+      # - name: Upload coverage to Codecov
+      #   uses: codecov/codecov-action@v4
+      #   with:
+      #     token: ${{ secrets.CODECOV_TOKEN }}
+      #     files: ./junit/opensearch-py-codecov.xml

.github/workflows/unified-release.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        stack_version: ["2.8.1"]
+        stack_version: ["3.0.0"]
 
     steps:
       - name: Checkout

CHANGELOG.md

@@ -3,9 +3,21 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 ### Added
+### Updated APIs
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+### Dependencies
+
+## [3.0.0]
+### Added
 - Added option to pass custom headers to 'AWSV4SignerAsyncAuth' ([863](https://github.com/opensearch-project/opensearch-py/pull/863))
 - Added sync and async sample that uses `search_after` parameter ([859](https://github.com/opensearch-project/opensearch-py/pull/859))
+- Enforced mandatory keyword-only arguments for calling auto-generated OpenSearch-py APIs ([#907](https://github.com/opensearch-project/opensearch-py/pull/907))
 ### Updated APIs
+- Updated opensearch-py APIs to reflect [opensearch-api-specification@d4eab1a](https://github.com/opensearch-project/opensearch-api-specification/commit/d4eab1a2e59db2b28e58a83df29bd72fc99c71b4)
 ### Changed
 - Small refactor of AWS Signer classes for both sync and async clients ([866](https://github.com/opensearch-project/opensearch-py/pull/866))
 - Small refactor to fix overwriting the module files when generating apis ([874](https://github.com/opensearch-project/opensearch-py/pull/874))
@@ -266,7 +278,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed link checker failing due to relative link ([#760](https://github.com/opensearch-project/opensearch-py/pull/760))
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/opensearch-py/compare/v2.8.0...HEAD
+[Unreleased]: https://github.com/opensearch-project/opensearch-py/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.8.0...v3.0.0
 [2.8.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.7.1...v2.8.0
 [2.7.1]: https://github.com/opensearch-project/opensearch-py/compare/v2.7.0...v2.7.1
 [2.7.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.6.0...v2.7.0

COMPATIBILITY.md

@@ -10,6 +10,7 @@ The below matrix shows the compatibility of the [`opensearch-py`](https://pypi.o
 | 1.0.0 | 1.0.0-1.2.4 | |
 | 1.1.0 | 1.3.0-1.3.7 | |
 | 2.x.x | 1.0.0-2.x | client works against OpenSearch 1.x as long as features removed in 2.0 are not used |
+| 3.x.x | 1.0.0-3.x | client works against OpenSearch 1.x, 2.x as long as features removed in 3.0 are not used |
 
 ## Upgrading
 

benchmarks/poetry.lock

@@ -45,7 +45,7 @@ data = [
     { "name": "baz"}
 ]
 
-response = client.bulk(data)
+response = client.bulk(body=data)
 if response["errors"]:
     print(f"There were errors!")
     for item in response["items"]:
@@ -127,3 +127,4 @@ if len(failed) > 0:
 if len(succeeded) > 0:
     print(f"Bulk-inserted {len(succeeded)} items (streaming_bulk).")
 ```
+

guides/bulk.md

@@ -45,7 +45,7 @@ print(response)
 user_name = "test-user"
 user_content = {"password": "test_password", "opendistro_security_roles": []}
 
-response = client.security.create_user(user_name, body=user_content)
+response = client.security.create_user(username=user_name, body=user_content)
 print(response)
 ```
 

guides/plugins/security.md

@@ -1,53 +1,11 @@
-- [Point-in-Time - Deprecated Implementation Examples](#point-in-time---deprecated-implementation-examples)
-- [Point-in-Time - Updated Implementation Examples](#point-in-time---updated-implementation-examples)
+- [Point-in-Time](#point-in-time)
 
-### Point-in-Time - Deprecated Implementation Examples
+### Point-in-Time
 
 [Point in Time (PIT)](https://opensearch.org/docs/latest/search-plugins/point-in-time/) lets you run different queries against a dataset that is fixed in time.
 
 Create a point in time on an index.
 
-```python
-index_name = "test-index"
-response = client.create_point_in_time(
-    index=index_name,
-    keep_alive="1m"
-)
-
-pit_id = response.get("pit_id")
-print('\n Point in time ID:')
-print(pit_id)
-```
-
-List all point in time which are alive in the cluster.
-
-```python
-response = client.list_all_point_in_time()
-print(response)
-```
-
-Delete a point in time.
-
-```python
-pit_body = {
-    "pit_id": [pit_id]
-}
-response = client.delete_point_in_time(body=pit_body)
-print(response)
-```
-
-Delete all point in time.
-
-```python
-response = client.delete_point_in_time(body=None, all=True)
-print(response)
-```
-
-
-### Point-in-Time - Updated Implementation Examples
-
-Create a point in time on an index.
-
 ```python
 index_name = "test-index"
 response = client.create_pit(