Skip to content

Conversation

@jordanpadams
Copy link
Member

Summary

This PR adds comprehensive documentation for the new EXISTS operator feature in the PDS Search API. The EXISTS operator allows users to query products based on field presence or absence in the OpenSearch index.

Changes

  • Added new section "Search by Field Existence" to the Search API Cookbook (docs/source/guides/search/cookbook.rst)
  • Documented four key use cases:
    1. Basic field existence: Finding products with specific fields (e.g., bounding box coordinates)
    2. Negation: Finding products missing fields (e.g., ongoing investigations without stop dates)
    3. Pattern matching: Using regex patterns to match multiple fields
    4. Combining operators: Using EXISTS with other query operators

Documentation includes

  • Clear explanation of when EXISTS returns true (field present, non-null value, multi-valued field handling)
  • Practical curl examples following the existing cookbook format
  • Note about error handling when regex patterns match zero fields

Related Issues

Test Plan

  • Documentation builds successfully with sphinx-build
  • No new errors or warnings introduced
  • Examples follow existing cookbook style and formatting
  • Generated HTML renders correctly

jordanpadams and others added 2 commits December 22, 2025 11:28
Documents the new EXISTS operator feature that allows querying for products
based on field presence or absence. Includes examples for:
- Basic field existence checking
- Negation (finding missing fields)
- Pattern matching with regex
- Combining with other operators

References NASA-PDS/registry-api#406
Implemented in NASA-PDS/registry-api#700
@jordanpadams jordanpadams force-pushed the doc/add-exists-operator-documentation branch from e25867e to 753bcfa Compare December 22, 2025 19:28
@sonarqubecloud
Copy link

@jordanpadams
Copy link
Member Author

Merging into develop since we do not want this to be pushed online yet.

@jordanpadams jordanpadams changed the base branch from main to develop December 26, 2025 19:02
@jordanpadams jordanpadams merged commit 6bbd829 into develop Dec 26, 2025
2 checks passed
@jordanpadams jordanpadams deleted the doc/add-exists-operator-documentation branch December 26, 2025 19:02
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.

3 participants