Skip to content

Commit 61c34bb

Browse files
authoredJun 12, 2019
Introduce stability description to the REST API specification (#38413)
* introduce state to the REST API specification * change state over to stability * CCR is no GA updated to stable * SQL is now GA so marked as stable * Introduce `internal` as state for API's, marks stable in terms of lifetime but unstable in terms of guarantees on its output format since it exposes internal representations * make setting a wrong stability value, or not setting it at all an error that causes the YAML test suite to fail * update spec files to be explicit about their stability state * Document the fact that stability needs to be defined Otherwise the YAML test runner will fail (with a nice exception message) * address check style violations * update rest spec unit tests to include stability * found one more test spec file not declaring stability, made sure stability appears after documentation everywhere * cluster.state is stable, mark response in some way to denote its a key value format that can be changed during minors * mark data frame API's as beta * remove internal and private as states for an API * removed the wrong enum values in the Stability Enum in the previous commit
1 parent ef8f90c commit 61c34bb

File tree

266 files changed

+326
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+326
-8
lines changed
 

‎modules/lang-painless/src/test/resources/rest-api-spec/api/scripts_painless_context.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"scripts_painless_context": {
3+
"stability": "experimental",
34
"methods": ["GET"],
45
"url": {
56
"paths": ["/_scripts/painless/_context"],

‎plugins/examples/rest-handler/src/test/resources/rest-api-spec/api/cat.example.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"cat.example": {
33
"documentation": "",
4+
"stability" : "stable",
45
"methods": ["GET"],
56
"url": {
67
"paths": ["/_cat/example"],

0 commit comments

Comments
 (0)
Please sign in to comment.