[BUG] missing definition in termsQuery

[amberzsy]

What is the bug?

termsQuery has Object without properties defined

[prudhvigodithi]

[Triage]
Going over this link https://opensearch.org/docs/latest/query-dsl/term/terms/ and seeing the https://github.com/opensearch-project/opensearch-api-specification code, does adding the following make sense?

TermsQuery:
  allOf:
    - $ref: '#/components/schemas/QueryBase'
    - type: object
      properties:
        terms:
          type: object
          description: A JSON object containing the field name and either an array of terms or an object for term lookup.
          additionalProperties:
            oneOf:
              - type: array
                items:
                  type: string
                description: Array of terms you wish to find in the specified field.
              - type: object
                properties:
                  index:
                    $ref: '_common.yaml#/components/schemas/IndexName'
                  id:
                    $ref: '_common.yaml#/components/schemas/Id'
                  path:
                    $ref: '_common.yaml#/components/schemas/Field'
                  routing:
                    $ref: '_common.yaml#/components/schemas/Routing'
                description: Object for fetching terms.
      required:
        - terms

The QueryBase already has boost so dont need to add again to properties.

Thank you
@amberzsy @dblock @getsaurabh02.

[dblock]

I would introduce a Term for parts of this.

Either way start by writing a test that exercises this API and then the schema.

[prudhvigodithi]

Sure, I will raise a PR adding some tests to TermQuery, TermsQuery and TermsSetQuery, I assume there are no tests for these queries as I dint find anything in https://github.com/opensearch-project/opensearch-api-specification/tree/main/tests/default/_core/search.

Ref:
https://opensearch.org/docs/latest/query-dsl/term/term/
https://opensearch.org/docs/latest/query-dsl/term/terms/
https://opensearch.org/docs/latest/query-dsl/term/terms-set/

[amberzsy]

I would introduce a Term for parts of this.

+1

[nhtruong]

Seems like the Search API has a lot of holes to patch. This one is related: #529

I'll look into the old ES spec (right before OS was forked) to see what's missing and cross check with the new features of this API that are unique to OS.

[prudhvigodithi]

Thanks @nhtruong, since the PR to add the missing definition for termsQuery is merged can we close this issue and open a new ones for patches that has to be added to Search API?
@dblock @amberzsy

[dblock]

Yes, please. Closing this one.

[amberzsy]

@prudhvigodithi @dblock

why we use different definition from #540 (comment) in the PR.

I did quick testing on

TermsQuery:
  allOf:
    - $ref: '#/components/schemas/QueryBase'
    - type: object
      properties:
        terms:
          type: object
          description: A JSON object containing the field name and either an array of terms or an object for term lookup.
          additionalProperties:
            oneOf:
              - type: array
                items:
                  type: string
                description: Array of terms you wish to find in the specified field.
              - type: object
                properties:
                  index:
                    $ref: '_common.yaml#/components/schemas/IndexName'
                  id:
                    $ref: '_common.yaml#/components/schemas/Id'
                  path:
                    $ref: '_common.yaml#/components/schemas/Field'
                  routing:
                    $ref: '_common.yaml#/components/schemas/Routing'
                description: Object for fetching terms.
      required:
        - terms

the JSON will be as below, which looks correct.

{
    "terms": 
             "string_key": {
                    "index": "something", 
                    "id": "id_1",
                    ...
               }

}

however with what defined in PR, here

Terms: 
  oneOf:
        - type: array
          items:
            type: string
        - type: object
          properties:
            index:
              $ref: '_common.yaml#/components/schemas/IndexName'
            id:
              $ref: '_common.yaml#/components/schemas/Id'
            path:
              $ref: '_common.yaml#/components/schemas/Field'
            routing:
              $ref: '_common.yaml#/components/schemas/Routing'
          additionalProperties: true
          description: Object for fetching terms.

the JSON will be missing <field_name>

[prudhvigodithi]

Hey @amberzsy only difference from my comment and PR is is just created a new schema Terms so that both the TermsQuery and TermsSetQuery can leverage the Terms schema.

[Xtansia]

@amberzsy @prudhvigodithi I've just made a fix to correct the position of the additionalProperties and anyOf/oneOf on the terms query in #564