[draft] Use a git submodule to include the OpenSearch.openapi.json file

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "specifications/opensearch-api-specification"]
+	path = specifications/opensearch-api-specification
+	url = https://github.com/opensearch-project/opensearch-api-specification.git/

CHANGELOG.md

@@ -8,6 +8,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added a log collection guide ([#579](https://github.com/opensearch-project/opensearch-py/pull/579))
 - Added GHA release ([#614](https://github.com/opensearch-project/opensearch-py/pull/614))
 ### Changed
+- Read the `OpenSearch.openapi.json` API specification file from a `git` submodule checkout instead of making an HTTP request. ([#627](https://github.com/opensearch-project/opensearch-py/pull/627))
 ### Deprecated
 ### Removed
 - Removed unnecessary `# -*- coding: utf-8 -*-` headers from .py files ([#615](https://github.com/opensearch-project/opensearch-py/pull/615), [#617](https://github.com/opensearch-project/opensearch-py/pull/617))

dev-requirements.txt

@@ -1,4 +1,3 @@
-requests>=2, <3
 pytest
 pytest-cov
 coverage

noxfile.py

@@ -118,6 +118,8 @@ def docs(session: Any) -> None:
 
 @nox.session()  # type: ignore
 def generate(session: Any) -> None:
+    session.run("git", "submodule", "init", external=True)
+    session.run("git", "submodule", "update", external=True)
     session.install("-rdev-requirements.txt")
     session.run("python", "utils/generate_api.py")
     format(session)

utils/generate_api.py

@@ -41,7 +41,6 @@
 
 import black
 import deepmerge
-import requests
 import unasync
 import urllib3
 from click.testing import CliRunner
@@ -429,10 +428,9 @@ def read_modules() -> Any:
     modules = {}
 
     # Load the OpenAPI specification file
-    response = requests.get(
-        "https://raw.githubusercontent.com/opensearch-project/opensearch-api-specification/main/OpenSearch.openapi.json"
-    )
-    data = response.json()
+    path = "specifications/opensearch-api-specification/OpenSearch.openapi.json"
+    with open(path) as f:
+        data = json.loads(f.read())
 
     list_of_dicts = []