Skip to content

[DOCS] Rewrite range query #43282

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
Jun 25, 2019
Merged

[DOCS] Rewrite range query #43282

merged 2 commits into from
Jun 25, 2019

Conversation

jrodewig
Copy link
Contributor

Changes

  • Rewrites description of range query
  • Adds example request section
  • Adds parameters sections
  • Adds notes section

This is part of #40977, an effort to standardize documentation for query types.

Before

Before image Before image

After

After image After image

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.2.0 v7.0.2 v7.1.2 labels Jun 17, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

https://en.wikipedia.org/wiki/List_of_UTC_time_offsets[Coordinated Universal Time
(UTC) offset] used to convert `date` values in the query to UTC. Optional.

Valid values are ISO 8601 UTC offsets, such as `+01:00` or -`08:00`.
Copy link
Member

Choose a reason for hiding this comment

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

I think ISO 8601 does not include all the time zone ids that are possible here, especially not the ones with time zone changes on e.g. summer time (like "Europe/Berlin", "America/Toronto" etc...). Since its not obvious that those are allowed here, I think we should mention at least one of them. I don't know if there is a comprehensive list of all the IANA time zone ids that Java allows, but maybe https://en.wikipedia.org/wiki/List_of_tz_database_time_zones is a good enough link? Will check if those are mostly accurate in terms of what Javas time library allows.

Copy link
Member

Choose a reason for hiding this comment

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

Just did some random checks between what ZoneId.getAvailableZoneIds() (should be what the java time library accepts) reports and whats on the liked wikipedia list, seems quite accurate to me atm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review @cbuescher. I documented support for IANA time zone IDs with d508e2d.

Copy link
Member

@cbuescher cbuescher left a comment

Choose a reason for hiding this comment

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

Looks good to me, I left a small comment regarding the supported range of time zone ids. Maybe that part could be extended a little bit.

Copy link
Member

@cbuescher cbuescher left a comment

Choose a reason for hiding this comment

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

Thanks for including the IANA ids.

@jrodewig jrodewig merged commit 5f6321a into elastic:master Jun 25, 2019
@jrodewig jrodewig deleted the range-query-rewrite branch June 25, 2019 19:25
jrodewig added a commit that referenced this pull request Jun 25, 2019
jrodewig added a commit that referenced this pull request Jun 25, 2019
jrodewig added a commit that referenced this pull request Jun 25, 2019
jrodewig added a commit that referenced this pull request Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.0.2 v7.1.2 v7.3.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants