Skip to content

CatCommonQueryParameters not recognized by validation-errors #2136

Open
@lcawl

Description

@lcawl

In #2124 where descriptions were added to some cat APIs, the following behaviour was discovered:

The validation-errors.json contains entries that seem to imply that the CommCatQueryParameters are not being resolved. For example:

    "cat.aliases": {
      "request": [
        "Request: missing json spec query parameter 'format'",
        "Request: missing json spec query parameter 'local'",
        "Request: missing json spec query parameter 'h'",
        "Request: missing json spec query parameter 'help'",
        "Request: missing json spec query parameter 's'",
        "Request: missing json spec query parameter 'v'",
        "request definition cat.aliases:Request / body - A request with inherited properties must have a PropertyBody"
      ],

However, the places where we did explicitly call out those query parameters generate a different kind of redundancy message. For example:

 "cat.ml_data_frame_analytics": {
      "request": [
...
        "request definition cat.ml_data_frame_analytics:Request / query - Property 'h' is already defined in an ancestor class",
        "request definition cat.ml_data_frame_analytics:Request / query - Property 's' is already defined in an ancestor class",
        "request definition cat.ml_data_frame_analytics:Request / body - A request with inherited properties must have a PropertyBody"
      ],

And the parameters seem to appear correctly in the output in https://github.com/elastic/elasticsearch-openapi/blob/main/openapi.json, so this seems to be an incorrect validation check.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions