honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/ml/put-calendar.asciidoc

36 lines
963 B
Plaintext
Raw Normal View History

Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
--
:api: put-calendar
:request: PutCalendarRequest
:response: PutCalendarResponse
--
[id="{upid}-{api}"]
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
=== Put calendar API
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
Creates a new {ml} calendar.
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
The API accepts a +{request}+ and responds
with a +{response}+ object.
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-request"]
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
==== Put calendar request
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
A +{request}+ is constructed with a calendar object
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-request]
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
--------------------------------------------------
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
<1> Create a request with the given calendar.
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-response"]
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
==== Put Calendar Response
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
The returned +{response}+ contains the created calendar:
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-response]
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
--------------------------------------------------
[DOCS] Updates terms in machine learning calendar APIs (#44866)
2019-07-25 14:20:42 -04:00
<1> The created calendar.
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include::../execution.asciidoc[]