Skip to content

update ES env variable documentation #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

BBrixen
Copy link

@BBrixen BBrixen commented Jul 2, 2025

fixes incorrect or missing documentation for ES_USE_SSL, ES_VERIFY_CERTS, and ES_API_KEY

Description:

  • README.md documentation has incorrect default values for ES_USE_SSL and ES_VERIFY_CERTS
  • The default values that are used can be found at: ./stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/config.py and ./stac_fastapi/opensearch/stac_fastapi/opensearch/config.py
  • Adds documentation for ES_API_KEY

PR Checklist:

  • Code is formatted and linted (run pre-commit run --all-files)
  • Tests pass (run make test)
  • Documentation has been updated to reflect changes, if applicable
  • Changes are added to the changelog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant