Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add version as an OpenAPI extension, cleanup obsolete properties and versions 0.0.0 #2655

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Add version as an OpenAPI extension, cleanup obsolete properties and versions 0.0.0 #2655

merged 2 commits into from
Jul 11, 2024

Conversation

swallez
Copy link
Member

@swallez swallez commented Jun 26, 2024

Fixes #2609

Adds the "since" version information as an x-availability-since extension property to OpenAPI operations and schema properties.

Also cleans up the API specification where we had a lot of since=0.0.0 that didn't make sense.

Also removes some obsolete metamodel properties that have for long been moved to the Availability structure.

/cc @lcawl

@swallez swallez requested a review from Anaethelion June 26, 2024 17:09
@github-actions GitHub Actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
bulk 🟢 402/402 420/420
cat.aliases 🟢 30/30 30/30
cat.allocation 🔴 12/12 4/12
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 5/5 5/5
cat.help ⚪ Missing test Missing test
cat.indices 🔴 35/35 24/34
cat.master 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🔴 11/11 7/11
cat.thread_pool 🟢 9/9 9/9
clear_scroll 🟢 17/17 17/17
cluster.get_settings 🟢 7/7 7/7
cluster.pending_tasks 🟢 3/3 3/3
cluster.put_settings 🟢 58/58 57/57
count 🟢 33/33 33/33
delete_script 🟢 8/8 8/8
delete 🟢 37/37 37/37
exists 🟢 19/19 19/19
explain 🟢 14/14 14/14
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
get_script 🟢 12/12 12/12
get_source 🟢 18/18 18/18
get 🔴 266/281 276/278
graph.explore 🟢 4/4 4/4
index 🔴 1006/1022 1024/1024
indices.analyze 🟢 20/20 20/20
indices.clear_cache 🟢 4/4 4/4
indices.close 🟢 49/49 49/49
indices.create 🔴 908/945 945/945
indices.delete_alias 🔴 15/15 5/15
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.exists_alias 🟢 36/36 36/36
indices.exists_index_template ⚪ Missing test Missing test
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.flush 🟢 30/30 30/30
indices.get_alias 🔴 83/83 71/83
indices.get_field_mapping 🔴 15/15 14/15
indices.get_mapping 🔴 120/120 108/120
indices.get_settings 🔴 61/61 59/61
indices.get_template 🟢 30/30 30/30
indices.get 🟢 53/53 53/53
indices.open 🟢 18/18 18/18
indices.put_alias 🔴 59/59 20/59
indices.put_mapping 🔴 75/103 103/103
indices.put_settings 🔴 54/57 57/57
indices.put_template 🔴 44/49 49/49
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 264/264 264/264
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_template 🔴 5/5 4/5
info 🟢 5/5 5/5
license.delete 🟢 3/3 3/3
license.get 🟢 6/6 6/6
license.post 🟢 1/1 1/1
mtermvectors 🟢 10/10 10/10
nodes.hot_threads 🔴 5/5 0/5
nodes.stats 🔴 49/49 15/49
ping 🟢 1/1 1/1
put_script 🟢 41/41 41/41
render_search_template 🟢 1/1 1/1
scroll 🟢 69/69 20/20
search_shards 🔴 8/8 2/8
search 🔴 2072/2143 2077/2125
security.change_password 🟢 9/9 9/9
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_service_token 🟢 3/3 3/3
security.delete_role 🟢 8/8 8/8
security.delete_user 🟢 9/9 9/9
security.disable_user 🟢 3/3 3/3
security.enable_user 🟢 4/4 4/4
security.get_role 🔴 22/22 20/22
security.get_user 🟢 25/25 25/25
security.put_role 🔴 38/40 39/39
security.put_user 🟢 49/49 48/48
snapshot.delete 🔴 21/23 23/23
termvectors 🟢 7/7 7/7
update 🟢 36/36 36/36
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.put_watch 🔴 29/38 38/38
watcher.start 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
xpack.info 🔴 8/8 1/4
xpack.usage 🔴 28/28 1/24

You can validate these APIs yourself by using the make validate target.

@github-actions GitHub Actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
bulk 🟢 411/411 429/429
cat.aliases 🟢 30/30 30/30
cat.allocation 🔴 12/12 2/12
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 5/5 5/5
cat.help ⚪ Missing test Missing test
cat.indices 🔴 35/35 24/34
cat.master 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🔴 11/11 7/11
cat.thread_pool 🟢 9/9 9/9
clear_scroll 🟢 17/17 17/17
cluster.get_settings 🟢 7/7 7/7
cluster.pending_tasks 🟢 3/3 3/3
cluster.put_settings 🟢 58/58 57/57
count 🟢 33/33 33/33
delete_script 🟢 8/8 8/8
delete 🟢 37/37 37/37
exists 🟢 19/19 19/19
explain 🟢 14/14 14/14
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
get_script 🟢 12/12 12/12
get_source 🟢 18/18 18/18
get 🔴 268/283 278/280
graph.explore 🟢 4/4 4/4
index 🔴 1009/1025 1027/1027
indices.analyze 🟢 20/20 20/20
indices.clear_cache 🟢 4/4 4/4
indices.close 🟢 50/50 50/50
indices.create 🔴 916/957 957/957
indices.delete_alias 🔴 15/15 5/15
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.exists_alias 🟢 38/38 38/38
indices.exists_index_template ⚪ Missing test Missing test
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.flush 🟢 30/30 30/30
indices.get_alias 🔴 86/86 74/86
indices.get_field_mapping 🔴 15/15 14/15
indices.get_mapping 🔴 121/121 109/121
indices.get_settings 🔴 61/61 59/61
indices.get_template 🟢 30/30 30/30
indices.get 🟢 53/53 53/53
indices.open 🟢 18/18 18/18
indices.put_alias 🔴 59/59 20/59
indices.put_mapping 🔴 75/103 103/103
indices.put_settings 🔴 54/57 57/57
indices.put_template 🔴 44/49 49/49
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 265/265 265/265
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_template 🔴 5/5 4/5
info 🟢 5/5 5/5
license.delete 🟢 3/3 3/3
license.get 🟢 6/6 6/6
license.post 🟢 1/1 1/1
mtermvectors 🟢 10/10 10/10
nodes.hot_threads 🔴 5/5 0/5
nodes.stats 🔴 49/49 15/49
ping 🟢 1/1 1/1
put_script 🟢 41/41 41/41
render_search_template 🟢 1/1 1/1
scroll 🟢 69/69 20/20
search_shards 🔴 8/8 2/8
search 🔴 2124/2205 2139/2187
security.change_password 🟢 9/9 9/9
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_service_token 🟢 3/3 3/3
security.delete_role 🟢 8/8 8/8
security.delete_user 🟢 9/9 9/9
security.disable_user 🟢 3/3 3/3
security.enable_user 🟢 4/4 4/4
security.get_role 🔴 24/24 21/24
security.get_user 🟢 25/25 25/25
security.put_role 🔴 39/40 39/39
security.put_user 🟢 49/49 48/48
snapshot.delete 🔴 21/23 23/23
termvectors 🟢 7/7 7/7
update 🟢 36/36 36/36
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.put_watch 🔴 29/38 38/38
watcher.start 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
xpack.info 🔴 8/8 1/4
xpack.usage 🔴 35/35 2/31

You can validate these APIs yourself by using the make validate target.

@Anaethelion Anaethelion merged commit da6edd4 into main Jul 11, 2024
6 checks passed
@Anaethelion Anaethelion deleted the openapi-add-since branch July 11, 2024 15:17
This was referenced Jul 12, 2024
Closed
Closed
@jloleysens jloleysens mentioned this pull request Jul 23, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Anaethelion Anaethelion Anaethelion approved these changes

Assignees
No one assigned
Labels
compiler specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add x-availability-since to OpenAPI output
2 participants
@swallez @Anaethelion