mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-11-10 06:43:58 +00:00
2d65c380f1
* Add pre-commit config * update contributing guidelines * try failing the workflow * add pre-commit to the deps * updating uninstall instructions * separate jobs in CI * make tutorials check fail * make black check fail * make openapi check fail * make yaml schema and api docs checks fail * highlight the instructions * Update .pre-commit-config.yaml Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Use black --check * Add images of the CI * title level * feedback Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>
40 lines
1.2 KiB
Python
Executable File
40 lines
1.2 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
import json
|
|
from pathlib import Path
|
|
import os
|
|
import sys
|
|
import shutil
|
|
|
|
sys.path.append(".")
|
|
from rest_api.utils import get_openapi_specs, get_app, get_pipelines # pylint: disable=wrong-import-position
|
|
from haystack import __version__ # pylint: disable=wrong-import-position
|
|
|
|
REST_PATH = Path("./rest_api").absolute()
|
|
PIPELINE_PATH = str(REST_PATH / "pipeline" / "pipeline_empty.haystack-pipeline.yml")
|
|
APP_PATH = str(REST_PATH / "application.py")
|
|
DOCS_PATH = Path("./docs") / "_src" / "api" / "openapi"
|
|
|
|
os.environ["PIPELINE_YAML_PATH"] = PIPELINE_PATH
|
|
|
|
print(f"Loading OpenAPI specs from {APP_PATH} with pipeline at {PIPELINE_PATH}")
|
|
|
|
# To initialize the app and the pipelines
|
|
get_app()
|
|
get_pipelines()
|
|
|
|
# Generate the openapi specs
|
|
specs = get_openapi_specs()
|
|
|
|
# Dump the specs into a JSON file
|
|
with open(DOCS_PATH / "openapi.json", "w") as f:
|
|
json.dump(specs, f, indent=4)
|
|
|
|
# Remove rc versions of the specs from the folder
|
|
for specs_file in os.listdir():
|
|
if os.path.isfile(specs_file) and "rc" in specs_file and Path(specs_file).suffix == ".json":
|
|
os.remove(specs_file)
|
|
|
|
# Add versioned copy
|
|
shutil.copy(DOCS_PATH / "openapi.json", DOCS_PATH / f"openapi-{__version__}.json")
|