Skip to content
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

Common query parameters omitted from OpenAPI #3551

Open
lcawl opened this issue Jan 17, 2025 · 0 comments
Open

Common query parameters omitted from OpenAPI #3551

lcawl opened this issue Jan 17, 2025 · 0 comments

Comments

@lcawl
Copy link
Contributor

lcawl commented Jan 17, 2025

There are common query parameters that are applicable to all the CAT APIs, for example the verbose, format, sort, help etc covered in https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html#common-parameters

I can see that they're defined in the specification in

export interface CommonCatQueryParameters {

However, they don't show up in the OpenAPI output.

For example, in https://github.com/elastic/elasticsearch-specification/blob/main/output/openapi/elasticsearch-openapi.json the "cat aliases" operation shows only the parameters that are defined explicitly in https://github.com/elastic/elasticsearch-specification/blob/main/specification/cat/aliases/CatAliasesRequest.ts

 "operationId": "cat-aliases",
        "parameters": [
          {
            "$ref": "#/components/parameters/cat.aliases#expand_wildcards"
          },
          {
            "$ref": "#/components/parameters/cat.aliases#master_timeout"
          }
        ],

Do we need to add them to all the request definitions? Or is there a simple fix to get the CommonCatQueryParameters to resolve?

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

No branches or pull requests

1 participant