Added distributions/included and excluded. #510

dblock · 2024-08-14T15:01:59Z

Description

Following up on #483, added distributions with included and excluded. I prefer to manage exclusions in tests so that a potential new distribution can run this with all tests enabled the first time, which makes it possible to immediately see what is broken.

Removed undefined values from results, and use an exact comparison in integration tests, making it much easier to see what scenarios failed.

Passing npm run test:spec -- --opensearch-distribution=amazon-managed against Amazon Managed OpenSearch 2.13. The values of ssl_provider_http, ssl_cipher and ssl_protocol are coming back null from sslinfo and most security APIs are disabled.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2024-08-14T15:04:25Z

Changes Analysis

Commit SHA: a11b293
Comparing To SHA: 7dee041

API Changes

Summary

├─┬Paths
│ ├─┬/_opendistro/_security/api/actiongroups/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11294:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11316:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11366:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11342:9)
│ ├─┬/_opendistro/_security/api/user
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12324:9)
│ ├─┬/{index}/_segments
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (10307:9)
│ ├─┬/_opendistro/_security/api/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11413:9)
│ ├─┬/_plugins/_security/api/securityconfig/config
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5689:9)
│ ├─┬/_opendistro/_security/api/tenants/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12223:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12245:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12299:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12273:9)
│ ├─┬/_opendistro/_security/api/migrate
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11628:9)
│ ├─┬/_plugins/_security/api/nodesdn/{cluster_name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5286:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5335:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5262:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5311:9)
│ ├─┬/_plugins/_security/api/_upgrade_perform
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4554:9)
│ ├─┬/_opendistro/_security/authinfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12527:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12550:9)
│ ├─┬/_plugins/_security/authinfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6085:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6106:9)
│ ├─┬/_opendistro/_security/api/securityconfig
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11866:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11887:9)
│ ├─┬/_opendistro/_security/api/cache
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11434:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11471:9)
│ │ ├─┬POST
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11452:9)
│ │ └─┬DELETE
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11490:9)
│ ├─┬/_segments
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (7542:9)
│ ├─┬/_plugins/_security/api/user/{username}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6004:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6022:9)
│ │ └─┬DELETE
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5986:9)
│ ├─┬/_opendistro/_security/api/ssl/http/reloadcerts
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11991:9)
│ ├─┬/_plugins/_security/api/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4880:9)
│ ├─┬/_plugins/_security/api/internalusers/{username}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5106:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5148:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5086:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5126:9)
│ ├─┬/_plugins/_security/api/rolesmapping/{role}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5577:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5621:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5557:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5597:9)
│ ├─┬/_opendistro/_security/api/rolesmapping/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11769:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11791:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11843:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11817:9)
│ ├─┬/_cat/nodeattrs
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (722:9)
│ ├─┬/_opendistro/_security/api/audit/config
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11389:9)
│ ├─┬/_plugins/_security/api/audit
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4817:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4836:9)
│ ├─┬/_plugins/_security/api/ssl/transport/reloadcerts
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5761:9)
│ ├─┬/_plugins/_security/api/account
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4578:9)
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4597:9)
│ ├─┬/_opendistro/_security/api/internalusers/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11512:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11534:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11582:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11558:9)
│ ├─┬/_plugins/_security/api/internalusers/{username}/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5171:9)
│ ├─┬/_plugins/_security/dashboardsinfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6128:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6147:9)
│ ├─┬/_plugins/_security/api/securityconfig
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5646:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5665:9)
│ ├─┬/_opendistro/_security/tenantinfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12662:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12685:9)
│ ├─┬/_plugins/_security/api/tenancy/config
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5785:9)
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5806:9)
│ ├─┬/_plugins/_security/api/user
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5968:9)
│ ├─┬/_plugins/_security/whoamiprotected
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6290:9)
│ ├─┬/_plugins/_security/api/generateonbehalfoftoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5021:9)
│ ├─┬/_settings
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (7566:9)
│ ├─┬/_cache/clear
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (340:9)
│ ├─┬/_plugins/_security/api/ssl/http/reloadcerts
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5737:9)
│ ├─┬/_plugins/_security/api/audit/config
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4858:9)
│ ├─┬/_opendistro/_security/api/ssl/certs
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11939:9)
│ ├─┬/_plugins/_security/api/ssl/certs
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5713:9)
│ ├─┬/_plugins/_security/api/migrate
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5192:9)
│ ├─┬/_opendistro/_security/api/internalusers/{name}/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11605:9)
│ ├─┬/_plugins/_security/api/rolesmapping
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5514:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5533:9)
│ ├─┬/_opendistro/_security/api/user/{name}/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12409:9)
│ ├─┬/_opendistro/_security/health
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12574:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12596:9)
│ ├─┬/_plugins/_security/api/cache
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4918:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4953:9)
│ │ ├─┬POST
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4935:9)
│ │ └─┬DELETE
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4898:9)
│ ├─┬/_plugins/_security/api/roles
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5382:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5401:9)
│ ├─┬/_plugins/_security/api/permissionsinfo
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5362:9)
│ ├─┬/_opendistro/_security/api/securityconfig/config
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11913:9)
│ ├─┬/_plugins/_security/health
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6167:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6187:9)
│ ├─┬/_plugins/_security/api/certificates
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4972:9)
│ ├─┬/_opendistro/_security/api/user/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12344:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12364:9)
│ │ └─┬DELETE
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12388:9)
│ ├─┬/_opendistro/_security/api/validate
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12430:9)
│ ├─┬/_plugins/_security/api/tenants
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5830:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5851:9)
│ ├─┬/_plugins/_security/api/tenants/{tenant}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5897:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5941:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5875:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5917:9)
│ ├─┬/_plugins/_security/api/certificates/{node_id}
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4996:9)
│ ├─┬/_opendistro/_security/api/ssl/transport/reloadcerts
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11965:9)
│ ├─┬/_opendistro/_security/api/permissionsinfo
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11650:9)
│ ├─┬/_opendistro/_security/api/account
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11247:9)
│ │ └─┬PUT
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11268:9)
│ ├─┬/_plugins/_security/api/roles/{role}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5445:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5489:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5425:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5465:9)
│ ├─┬/_opendistro/_security/api/tenants
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12174:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12197:9)
│ ├─┬/_plugins/_security/api/actiongroups
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4621:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4640:9)
│ ├─┬/_plugins/_security/api/nodesdn
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5212:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5236:9)
│ ├─┬/_plugins/_security/whoami
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6251:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6270:9)
│ ├─┬/_forcemerge
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (2354:9)
│ ├─┬/_plugins/_security/api/internalusers
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (5045:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (5064:9)
│ ├─┬/_plugins/_security/tenantinfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (6208:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6229:9)
│ ├─┬/_opendistro/_security/kibanainfo
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12619:9)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12640:9)
│ ├─┬/_plugins/_security/api/_upgrade_check
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4534:9)
│ ├─┬/_plugins/_security/api/validate
│ │ └─┬GET
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6064:9)
│ ├─┬/_opendistro/_security/api/roles/{name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11672:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11694:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (11746:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (11720:9)
│ ├─┬/_plugins/_security/api/allowlist
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4749:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4793:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4770:9)
│ ├─┬/_opendistro/_security/api/allowlist
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12453:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12476:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12501:9)
│ ├─┬/_plugins/_security/api/user/{username}/authtoken
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (6045:9)
│ ├─┬/_plugins/_security/api/actiongroups/{action_group}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4682:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4724:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (4662:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (4702:9)
│ ├─┬/_opendistro/_security/api/nodesdn/{cluster_name}
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12017:9)
│ │ ├─┬PUT
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12044:9)
│ │ ├─┬DELETE
│ │ │ └─┬Extensions
│ │ │   └──[➕] x-distributions-excluded (12098:9)
│ │ └─┬PATCH
│ │   └─┬Extensions
│ │     └──[➕] x-distributions-excluded (12072:9)
│ └─┬/_opendistro/_security/api/tenancy/config
│   ├─┬GET
│   │ └─┬Extensions
│   │   └──[➕] x-distributions-excluded (12125:9)
│   └─┬PUT
│     └─┬Extensions
│       └──[➕] x-distributions-excluded (12148:9)
└─┬Components
  └─┬security._common:SSLInfo
    ├─┬ssl_protocol
    │ └──[🔀] type (50247:13)❌ 
    ├─┬ssl_cipher
    │ └──[🔀] type (50252:13)❌ 
    └─┬ssl_provider_http
      └──[🔀] type (50281:13)❌

Document Element	Total Changes	Breaking Changes
paths	150	0
components	3	3

❌ BREAKING Changes: 3 out of 153
Modifications: 3
Additions: 150
Breaking Modifications: 3

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/10390880736/artifacts/1812191323

API Coverage

	Before	After	Δ
Covered (%)	524 (51.32 %)	524 (51.32 %)	0 (0 %)
Uncovered (%)	497 (48.68 %)	497 (48.68 %)	0 (0 %)
Unknown	26	26	0

Signed-off-by: dblock <[email protected]>

github-actions · 2024-08-14T15:11:37Z

Spec Test Coverage Analysis

Total	Tested
550	216 (39.27 %)

Signed-off-by: dblock <[email protected]>

… against Amazon OpenSearch 2.13. Signed-off-by: dblock <[email protected]>

reta · 2024-08-22T13:22:46Z

spec/namespaces/cat.yaml

@@ -291,6 +291,9 @@ paths:
      operationId: cat.nodeattrs.0
      x-operation-group: cat.nodeattrs
      x-version-added: '1.0'
+      x-distributions-excluded:


@dblock coming from opensearch-project/opensearch-java#1152 (comment), I understand the bias towards supporting AWS, but I honestly believe the spec has to be vendor neutral. I believe it should be feasible to keep the distribution specific details outside of the spec and allow the distribution specific spec to be produced if needed:

For example:

the vendor neutral spec: openapi-oss.yaml

the AWS managed spec: openapi-aws.yaml (would only contain new APIs, excluded APIs or APIs that are tailored)

The final spec for AWS: openapi-oss.yaml + openapi-aws.yaml

I think you can/should open an issue copy-pasting the above about removing x-distribution-excluded.

When I introduced this feature I did not intend it to be biased towards supporting AWS in any way, but I did want to run the tests against Amazon Managed so I annotated some APIs. We would welcome other keywords here, be it oracle-oci, aiven-managed or something platform-specific like community-freebsd in the short term. Therefore I believe the spec is vendor netural today. I think it's ok to mention vendors in the spec this way, but we can talk about it.

What you are looking at is the source for the spec, not the spec. We currently publish the all-versions spec in a release that includes these x- options. But this repo is capable of producing a version-specific spec (e.g. 1.3.x, without APIs added in/after 2.0 for example or vice-versa) (see https://github.com/opensearch-project/opensearch-api-specification/blob/main/DEVELOPER_GUIDE.md#spec-merger), and that could be extended to produce a vendor-less (by stripping x-distribution options), or a vendor-specific spec (e.g. -amazon-managed.yaml).

dblock added the skip-changelog No need to update CHANGELOG. label Aug 14, 2024

dblock requested review from harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners August 14, 2024 15:02

dblock force-pushed the distributions-included-excluded branch from e1d1844 to 68f92ac Compare August 14, 2024 15:03

Added distributions/included and excluded.

fdebe95

Signed-off-by: dblock <[email protected]>

dblock force-pushed the distributions-included-excluded branch from 68f92ac to fdebe95 Compare August 14, 2024 15:08

Test distribution before version.

ba4f0a5

Signed-off-by: dblock <[email protected]>

dblock mentioned this pull request Aug 14, 2024

Adds test for APIs related to security plugin and updates spec to add new APIs. #439

Merged

dblock force-pushed the distributions-included-excluded branch 2 times, most recently from f116d93 to c198ca9 Compare August 14, 2024 15:37

Passing npm run test:spec -- --opensearch-distribution=amazon-managed…

a11b293

… against Amazon OpenSearch 2.13. Signed-off-by: dblock <[email protected]>

dblock force-pushed the distributions-included-excluded branch from c198ca9 to a11b293 Compare August 14, 2024 15:53

Xtansia approved these changes Aug 14, 2024

View reviewed changes

Xtansia merged commit df34927 into opensearch-project:main Aug 14, 2024
17 checks passed

dblock deleted the distributions-included-excluded branch August 14, 2024 23:59

reta reviewed Aug 22, 2024

View reviewed changes

reta mentioned this pull request Aug 22, 2024

[FEATURE] Keep the OpenAPI specification vendor-neutral / vendor-agnostic #522

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added distributions/included and excluded. #510

Added distributions/included and excluded. #510

dblock commented Aug 14, 2024 •

edited

Loading

github-actions bot commented Aug 14, 2024 •

edited

Loading

github-actions bot commented Aug 14, 2024

reta Aug 22, 2024 •

edited

Loading

dblock Aug 22, 2024 •

edited

Loading

Added distributions/included and excluded. #510

Added distributions/included and excluded. #510

Conversation

dblock commented Aug 14, 2024 • edited Loading

Description

github-actions bot commented Aug 14, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Aug 14, 2024

Spec Test Coverage Analysis

reta Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

dblock Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

dblock commented Aug 14, 2024 •

edited

Loading

github-actions bot commented Aug 14, 2024 •

edited

Loading

reta Aug 22, 2024 •

edited

Loading

dblock Aug 22, 2024 •

edited

Loading