Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 7, 2021

Related to elastic/elasticsearch-specification#852

This PR fixes the get scheduled events API docs. It:

  • adds the missing query parameters section,
  • adds a missing "job_id" option,
  • adds the missing "page" object for the "from" and "size" options,
  • adds an example that shows the use of some query parameters
  • removes phrase about "omitting the <calendar_id>", since this results in an error

Preview

https://elasticsearch_78809.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ml-get-calendar-event.html

@lcawl lcawl added :ml Machine learning >docs General docs changes labels Oct 7, 2021
@lcawl lcawl marked this pull request as ready for review October 7, 2021 01:56
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Oct 7, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

Copy link
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl merged commit bcd75c3 into elastic:master Oct 7, 2021
@lcawl lcawl deleted the get-scheduled-events branch October 7, 2021 15:35
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Oct 7, 2021
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Oct 7, 2021
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Oct 7, 2021
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Oct 7, 2021
wjp719 added a commit to wjp719/elasticsearch that referenced this pull request Oct 9, 2021
* master:
  Fix DataTierTests package and add a validation test (elastic#78880)
  Fix split package org.elasticsearch.common.xcontent (elastic#78831)
  Store DataTier Preference directly on IndexMetadata (elastic#78668)
  [DOCS] Fixes typo in calendar API example (elastic#78867)
  Improve Node Shutdown Observability (elastic#78727)
  Convert encrypted snapshot license object to LicensedFeature (elastic#78731)
  Revert "Make nodePaths() singular (elastic#72514)" (elastic#78801)
  Fix incorrect generic type in PolicyStepsRegistry (elastic#78628)
  [DOCS] Fixes ML get calendars API (elastic#78808)
  Implement GET API for System Feature Upgrades (elastic#78642)
  [TEST] More MetadataStateFormat tests (elastic#78577)
  Add support for rest compatibility headers to the HLRC (elastic#78490)
  Un-ignoring tests after backporting fix (elastic#78830)
  Add node REPLACE shutdown implementation (elastic#76247)
  Wrap VersionPropertiesLoader in a BuildService to decouple build logic projects (elastic#78704)
  Adjust /_cat/templates not to request all metadata (elastic#78829)
  [DOCS] Fixes ML get scheduled events API (elastic#78809)
  Enable exit on out of memory error (elastic#71542)

# Conflicts:
#	server/src/main/java/org/elasticsearch/cluster/metadata/DataStream.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v6.8.20 v7.14.3 v7.15.1 v7.16.0 v8.0.0-beta1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants