Skip to content

[DOCS] Remove unsupported local and master_timeout parms from cat API docs #47933

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

Merged
merged 2 commits into from
Oct 14, 2019
Merged

[DOCS] Remove unsupported local and master_timeout parms from cat API docs #47933

merged 2 commits into from
Oct 14, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 11, 2019

Removes documentation for the local parameter from the following cat APIs:

  • cat count (docs + API spec)
  • cat fielddata (docs + API spec)
  • cat health (docs + API spec)
  • cat recovery (docs only)
  • cat snapshots (docs only)

Removes the master_timeout parameter from the following cat APIs:

  • cat alias (docs + API spec)
  • cat count (docs + API spec)
  • cat fielddata (docs + API spec)
  • cat health (docs + API spec)
  • cat recovery (docs + API spec)
  • cat tasks (docs only)

These parameters are unsupported in the listed APIs.

Closes #45843

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/CAT APIs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@jrodewig jrodewig requested a review from dakrone October 11, 2019 16:38
@jrodewig jrodewig changed the title [DOCS] Remove local parm from several cat APIs [DOCS] Remove local and master_timeout parms from unsupported cat APIs Oct 11, 2019
@jrodewig jrodewig changed the title [DOCS] Remove local and master_timeout parms from unsupported cat APIs [DOCS] Remove unsupported local and master_timeout parms from cat APIs Oct 11, 2019
@jrodewig jrodewig changed the title [DOCS] Remove unsupported local and master_timeout parms from cat APIs [DOCS] Remove unsupported local and master_timeout parms from cat API docs Oct 11, 2019
Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but actually pushing the right button this time.

@jrodewig jrodewig merged commit 64c1dfa into elastic:master Oct 14, 2019
@jrodewig jrodewig deleted the remove-cat-local-parm branch October 14, 2019 15:38
jrodewig added a commit that referenced this pull request Oct 14, 2019
jrodewig added a commit that referenced this pull request Oct 14, 2019
jrodewig added a commit that referenced this pull request Oct 14, 2019
Mpdreamz added a commit to elastic/elasticsearch-net that referenced this pull request Nov 19, 2019
And document them as deprecated

relates: elastic/elasticsearch#47933
Mpdreamz added a commit to elastic/elasticsearch-net that referenced this pull request Nov 20, 2019
* update specs

* update ignore list

* sync docgen changes from master, ignore time enum for now since its values are descriptions and we already have a Time type

* codegen line ending changes

* Add back local/master_timeout

And document them as deprecated

relates: elastic/elasticsearch#47933

* do not generate time and byte querystring parameters

* patch now also hoists params over, we can no longer rely on simple merge since we temporarily still rework the spec files in memory to the old format

* add changes and remove bytes for now

* Add back force as option for version_type

Mark as obsolete to warn the user but without breaking backwards
compatibily. The 7.5 client should be able to be used against < 7.5
server.

relates: github.com/elastic/elasticsearch/pull/47228

* codegen for enums can now pragma disable obsolete members in generated GetString()

* Generated pragma disable for obsolete enum members
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Elasticsearch 7.3.0: _cat/count?h=dc&local throws a 400
4 participants