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

DarshitChanpura · 2024-07-18T20:49:40Z

Description

Adds tests for all APIs exposed by security plugin.
Adds any new APIs since last change.
Modifies any API schemas which have changed since.

Issues Resolved

Resolves Add tests for the new API spec security#4404

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.

Signed-off-by: Darshit Chanpura <[email protected]>

…hemas

github-actions · 2024-07-18T20:51:46Z

Changes Analysis

Commit SHA: 705e6cf
Comparing To SHA: 597ed8d

API Changes

Summary

├─┬Paths
│ ├──[➖] path (4504:3)❌ 
│ ├──[➖] path (4487:3)❌ 
│ ├──[➕] path (4487:3)
│ ├──[➕] path (4862:3)
│ ├──[➕] path (4883:3)
│ ├──[➕] path (4504:3)
│ ├─┬/_plugins/_security/api/rolesmapping/{role}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21310:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26221:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21359:20)
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21534:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26626:19)❌ 
│ ├─┬/_plugins/_security/api/cache
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬501
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26172:19)❌ 
│ │ ├─┬PUT
│ │ │ └─┬Responses
│ │ │   └─┬501
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26172:19)❌ 
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬501
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26172:19)❌ 
│ ├─┬/_plugins/_security/api/validate
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21569:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26769:19)❌ 
│ ├─┬/_plugins/_security/api/roles/{role}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21317:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26231:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21366:20)
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21541:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26644:19)❌ 
│ ├─┬/_plugins/_security/api/user/{username}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21499:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21331:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26264:7)
│ │ └─┬DELETE
│ │   └─┬Parameters
│ │     └──[➕] description (21380:20)
│ ├─┬/_plugins/_security/api/ssl/http/reloadcerts
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26702:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26700:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5529:24)
│ ├─┬/_plugins/_security/api/actiongroups/{action_group}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (21408:20)
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21279:22)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └─┬Schema
│ │ │ │   └──[➖] description (21185:22)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26202:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (21345:20)
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21223:22)
│ │ └─┬PATCH
│ │   └─┬Parameters
│ │     └──[➕] description (21520:20)
│ ├─┬/_opendistro/_security/api/actiongroups/{name}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (21408:20)
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21279:22)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └─┬Schema
│ │ │ │   └──[➖] description (21185:22)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26202:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (21345:20)
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21223:22)
│ │ └─┬PATCH
│ │   └─┬Parameters
│ │     └──[➕] description (21520:20)
│ ├─┬/_opendistro/_security/health
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21513:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[➕] description (21513:20)
│ ├─┬/_plugins/_security/api/user/{username}/authtoken
│ │ └─┬POST
│ │   ├──[🔀] description (5796:20)
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21394:20)
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26337:7)
│ │   │ ├──[➖] codes (26126:7)❌ 
│ │   │ └──[➖] codes (26131:7)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5795:24)
│ ├─┬/_opendistro/_security/api/internalusers/{name}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21506:20)
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21338:20)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21387:20)
│ │ └─┬PATCH
│ │   └─┬Parameters
│ │     └──[➕] description (21555:20)
│ ├─┬/_plugins/_security/api/ssl/certs
│ │ └─┬GET
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26402:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26400:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5508:24)
│ ├─┬/_opendistro/_security/sslinfo
│ │ └─┬GET
│ │   └─┬Parameters
│ │     ├──[🔀] description (21483:20)
│ │     └─┬Schema
│ │       ├──[🔀] type (21486:11)❌ 
│ │       └──[➖] description (21317:22)
│ ├─┬/_plugins/_security/whoami
│ │ ├─┬GET
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (5971:24)
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5987:24)
│ ├─┬/_plugins/_security/api/securityconfig
│ │ ├─┬GET
│ │ │ ├─┬Responses
│ │ │ │ └─┬200
│ │ │ │   └─┬application/json
│ │ │ │     └─┬Schema
│ │ │ │       └──[🔀] $ref (49393:13)❌ 
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (5450:24)
│ │ └─┬PATCH
│ │   ├─┬Responses
│ │   │ └──[➕] codes (26589:7)
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5466:24)
│ ├─┬/_opendistro/_security/api/user/{name}/authtoken
│ │ └─┬POST
│ │   ├──[🔀] description (11965:20)
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21394:20)
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26337:7)
│ │   │ ├──[➖] codes (26126:7)❌ 
│ │   │ └──[➖] codes (26131:7)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11964:24)
│ ├─┬/_opendistro/_security/api/allowlist
│ │ ├─┬GET
│ │ │ ├─┬Responses
│ │ │ │ └──[➕] codes (26384:7)
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (12002:24)
│ │ ├─┬PUT
│ │ │ ├─┬Responses
│ │ │ │ └──[➕] codes (26212:7)
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (12022:24)
│ │ └─┬PATCH
│ │   ├─┬Responses
│ │   │ └──[➕] codes (26575:7)
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (12044:24)
│ ├─┬/_plugins/_security/health
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21513:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[➕] description (21513:20)
│ ├─┬/_opendistro/_security/api/nodesdn/{cluster_name}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21429:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21436:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26427:7)
│ │ │   └─┬403
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26433:19)❌ 
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21562:20)
│ │ │ ├─┬Responses
│ │ │ │ ├──[➕] codes (26754:7)
│ │ │ │ └─┬403
│ │ │ │   └─┬application/json
│ │ │ │     └─┬Schema
│ │ │ │       └──[🔀] $ref (26760:19)❌ 
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └──[🔀] $ref (49150:13)❌ 
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21352:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26284:7)
│ │ │   └─┬403
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26290:19)❌ 
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21527:20)
│ │   └─┬Responses
│ │     ├──[➕] codes (26598:7)
│ │     └─┬403
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26604:19)❌ 
│ ├─┬/_plugins/_security/api/account
│ │ └─┬PUT
│ │   └─┬Responses
│ │     └──[➕] codes (26179:7)
│ ├─┬/_plugins/_security/api/generateonbehalfoftoken
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬400
│ │       ├──[➕] content (26333:11)
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26335:19)❌ 
│ ├─┬/_opendistro/_security/api/roles/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21317:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26231:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21366:20)
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21541:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26644:19)❌ 
│ ├─┬/_opendistro/_security/api/ssl/http/reloadcerts
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26702:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26700:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11597:24)
│ ├─┬/_opendistro/_security/api/rolesmapping/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21310:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26221:7)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21359:20)
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21534:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26626:19)❌ 
│ ├─┬/_plugins/_security/api/internalusers/{username}/authtoken
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21401:20)
│ │   ├─┬Responses
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26348:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5038:24)
│ ├─┬/_opendistro/_security/api/securityconfig/config
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ └──[➕] codes (26745:7)
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11528:24)
│ ├─┬/_plugins/_security/api/roles
│ │ └─┬PATCH
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26653:19)❌ 
│ ├─┬/_plugins/_security/api/migrate
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26558:19)❌ 
│ ├─┬/_plugins/_security/api/nodesdn/{cluster_name}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21429:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21436:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26427:7)
│ │ │   └─┬403
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26433:19)❌ 
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21562:20)
│ │ │ ├─┬Responses
│ │ │ │ ├──[➕] codes (26754:7)
│ │ │ │ └─┬403
│ │ │ │   └─┬application/json
│ │ │ │     └─┬Schema
│ │ │ │       └──[🔀] $ref (26760:19)❌ 
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └──[🔀] $ref (49150:13)❌ 
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21352:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26284:7)
│ │ │   └─┬403
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26290:19)❌ 
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21527:20)
│ │   └─┬Responses
│ │     ├──[➕] codes (26598:7)
│ │     └─┬403
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26604:19)❌ 
│ ├─┬/_opendistro/_security/api/cache
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬501
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26172:19)❌ 
│ │ ├─┬PUT
│ │ │ └─┬Responses
│ │ │   └─┬501
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26172:19)❌ 
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬501
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26172:19)❌ 
│ ├─┬/_plugins/_security/api/allowlist
│ │ ├─┬GET
│ │ │ ├─┬Responses
│ │ │ │ └──[➕] codes (26384:7)
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (4676:24)
│ │ ├─┬PUT
│ │ │ ├─┬Responses
│ │ │ │ └──[➕] codes (26212:7)
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (4714:24)
│ │ └─┬PATCH
│ │   ├─┬Responses
│ │   │ └──[➕] codes (26575:7)
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (4694:24)
│ ├─┬/_plugins/_security/api/rolesmapping
│ │ └─┬PATCH
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26635:19)❌ 
│ ├─┬/_plugins/_security/tenantinfo
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26724:7)
│ │ └─┬POST
│ │   └─┬Responses
│ │     └──[➕] codes (26724:7)
│ ├─┬/_opendistro/_security/api/tenants
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26524:19)❌ 
│ │ └─┬PATCH
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26671:19)❌ 
│ ├─┬/_opendistro/_security/api/ssl/transport/reloadcerts
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26715:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26713:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11574:24)
│ ├─┬/_plugins/_security/api/tenants
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26524:19)❌ 
│ │ └─┬PATCH
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26671:19)❌ 
│ ├─┬/_opendistro/_security/kibanainfo
│ │ └─┬POST
│ │   └──[➖] requestBody (23939:7)❌ 
│ ├─┬/_opendistro/_security/api/migrate
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26558:19)❌ 
│ ├─┬/_opendistro/_security/api/tenants/{name}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21492:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21324:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26241:7)
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26248:19)❌ 
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21373:20)
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26309:19)❌ 
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21548:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26662:19)❌ 
│ ├─┬/_opendistro/_security/api/ssl/certs
│ │ └─┬GET
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26402:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26400:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11551:24)
│ ├─┬/_plugins/_security/api/tenancy/config
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26510:19)❌ 
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26257:19)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49274:13)❌ 
│ ├─┬/_plugins/_security/api/ssl/transport/reloadcerts
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ ├──[➕] codes (26715:7)
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26713:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (5550:24)
│ ├─┬/_opendistro/_security/api/tenancy/config
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26510:19)❌ 
│ │ └─┬PUT
│ │   ├─┬Responses
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26257:19)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49274:13)❌ 
│ ├─┬/_opendistro/_security/api/account
│ │ └─┬PUT
│ │   └─┬Responses
│ │     └──[➕] codes (26179:7)
│ ├─┬/_opendistro/_security/api/user/{name}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21499:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21331:20)
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26264:7)
│ │ └─┬DELETE
│ │   └─┬Parameters
│ │     └──[➕] description (21380:20)
│ ├─┬/_opendistro/_security/api/internalusers/{name}/authtoken
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21401:20)
│ │   ├─┬Responses
│ │   │ └─┬400
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (26348:19)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11259:24)
│ ├─┬/_plugins/_security/api/internalusers/{username}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21506:20)
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21338:20)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21387:20)
│ │ └─┬PATCH
│ │   └─┬Parameters
│ │     └──[➕] description (21555:20)
│ ├─┬/_opendistro/_security/tenantinfo
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └──[➕] codes (26724:7)
│ │ └─┬POST
│ │   └─┬Responses
│ │     └──[➕] codes (26724:7)
│ ├─┬/_opendistro/_security/api/validate
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21569:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26769:19)❌ 
│ ├─┬/_plugins/_security/api/tenants/{tenant}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[➕] description (21492:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21324:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26241:7)
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26248:19)❌ 
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21373:20)
│ │ │ └─┬Responses
│ │ │   └─┬400
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26309:19)❌ 
│ │ └─┬PATCH
│ │   ├─┬Parameters
│ │   │ └──[➕] description (21548:20)
│ │   └─┬Responses
│ │     └─┬400
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26662:19)❌ 
│ ├─┬/_opendistro/_security/api/securityconfig
│ │ ├─┬GET
│ │ │ ├─┬Responses
│ │ │ │ └─┬200
│ │ │ │   └─┬application/json
│ │ │ │     └─┬Schema
│ │ │ │       └──[🔀] $ref (49393:13)❌ 
│ │ │ └─┬Extensions
│ │ │   └──[🔀] x-version-added (11487:24)
│ │ └─┬PATCH
│ │   ├─┬Responses
│ │   │ └──[➕] codes (26589:7)
│ │   └─┬Extensions
│ │     └──[🔀] x-version-added (11505:24)
│ ├─┬/_plugins/_security/api/nodesdn
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[➕] description (21443:20)
│ │ │ └─┬Responses
│ │ │   ├──[➕] codes (26440:7)
│ │ │   └─┬403
│ │ │     └─┬application/json
│ │ │       └─┬Schema
│ │ │         └──[🔀] $ref (26447:19)❌ 
│ │ └─┬PATCH
│ │   └─┬Responses
│ │     ├──[➕] codes (26611:7)
│ │     └─┬403
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (26617:19)❌ 
│ ├─┬/_plugins/_security/dashboardsinfo
│ │ └─┬POST
│ │   └──[➖] requestBody (23939:7)❌ 
│ └─┬/_plugins/_security/api/securityconfig/config
│   └─┬PUT
│     ├─┬Responses
│     │ └──[➕] codes (26745:7)
│     └─┬Extensions
│       └──[🔀] x-version-added (5487:24)
└─┬Components
  ├──[➖] requestBodies (23939:7)❌ 
  ├──[➖] responses (26126:7)❌ 
  ├──[➖] responses (26131:7)❌ 
  ├──[➕] responses (26284:7)
  ├──[➕] responses (26402:7)
  ├──[➕] responses (26754:7)
  ├──[➕] responses (26264:7)
  ├──[➕] responses (26745:7)
  ├──[➕] responses (26241:7)
  ├──[➕] responses (26454:7)
  ├──[➕] responses (26575:7)
  ├──[➕] responses (26193:7)
  ├──[➕] responses (26589:7)
  ├──[➕] responses (26724:7)
  ├──[➕] responses (26212:7)
  ├──[➕] responses (26598:7)
  ├──[➕] responses (26365:7)
  ├──[➕] responses (26370:7)
  ├──[➕] responses (26611:7)
  ├──[➕] responses (26202:7)
  ├──[➕] responses (26702:7)
  ├──[➕] responses (26374:7)
  ├──[➕] responses (26458:7)
  ├──[➕] responses (26384:7)
  ├──[➕] responses (26231:7)
  ├──[➕] responses (26715:7)
  ├──[➕] responses (26449:7)
  ├──[➕] responses (26440:7)
  ├──[➕] responses (26337:7)
  ├──[➕] responses (26179:7)
  ├──[➕] responses (26221:7)
  ├──[➕] responses (26427:7)
  ├──[➕] parameters (21413:7)
  ├──[➕] parameters (21420:7)
  ├──[➕] parameters (21462:7)
  ├──[➕] parameters (21455:7)
  ├──[➕] parameters (21448:7)
  ├──[➖] schemas (48602:7)❌ 
  ├──[➖] schemas (49126:7)❌ 
  ├──[➖] schemas (48709:7)❌ 
  ├──[➖] schemas (48918:7)❌ 
  ├──[➕] schemas (49024:7)
  ├──[➕] schemas (49097:7)
  ├──[➕] schemas (49034:7)
  ├──[➕] schemas (49393:7)
  ├──[➕] schemas (49222:7)
  ├──[➕] schemas (48999:7)
  ├─┬security._common:AuditLogsConfig
  │ ├──[➕] properties (48909:9)
  │ └──[➕] properties (48913:9)
  ├─┬security._common:User
  │ └──[➕] properties (49524:9)
  ├─┬security._common:DynamicOptions
  │ ├──[➕] properties (49186:9)
  │ ├──[➕] properties (49172:9)
  │ ├──[➕] properties (49170:9)
  │ ├──[➕] properties (49188:9)
  │ ├──[➕] properties (49194:9)
  │ ├──[➕] properties (49168:9)
  │ ├──[➕] properties (49192:9)
  │ ├──[➕] properties (49190:9)
  │ ├──[➕] properties (49196:9)
  │ ├──[➕] properties (49176:9)
  │ ├──[➕] properties (49174:9)
  │ ├─┬kibana
  │ │ └──[➕] type (49179:17)❌ 
  │ ├─┬authc
  │ │ └──[➕] type (49183:17)❌ 
  │ ├─┬authz
  │ │ └──[➕] type (49185:17)❌ 
  │ └─┬http
  │   └──[➕] type (49181:17)❌ 
  ├─┬security._common:AllowListConfig
  │ ├──[➕] properties (48875:9)
  │ └──[➕] properties (48877:9)
  ├─┬security._common:DashboardsInfo
  │ └─┬sign_in_options
  │   └──[➕] items (49142:13)❌ 
  ├─┬security._common:HealthInfo
  │ └─┬message
  │   └──[🔀] type (49240:13)❌ 
  ├─┬security._common:AccountDetails
  │ └─┬user_requested_tenant
  │   └──[🔀] type (48835:13)❌ 
  ├─┬security._common:Ok
  │ └─┬status
  │   ├──[➖] enum (48961:15)❌ 
  │   └──[🔀] type (49305:13)❌ 
  ├─┬security._common:MultiTenancyConfig
  │ └─┬sign_in_options
  │   └──[➖] description (48940:24)
  ├─┬security._common:SSLInfo
  │ ├──[➕] required (49473:11)❌ 
  │ ├──[➕] required (49474:11)❌ 
  │ ├──[➕] required (49462:11)❌ 
  │ ├──[➕] required (49463:11)❌ 
  │ ├──[➕] required (49464:11)❌ 
  │ ├──[➕] required (49465:11)❌ 
  │ ├──[➕] required (49469:11)❌ 
  │ ├──[➕] required (49472:11)❌ 
  │ ├──[➕] required (49466:11)❌ 
  │ ├──[➕] required (49467:11)❌ 
  │ ├──[➕] required (49468:11)❌ 
  │ ├──[➕] required (49470:11)❌ 
  │ ├──[➕] required (49471:11)❌ 
  │ ├─┬local_certificates_list
  │ │ └──[➕] items (49421:13)❌ 
  │ ├─┬peer_certificates
  │ │ └──[🔀] type (49407:13)❌ 
  │ ├─┬peer_certificates_list
  │ │ ├──[➕] items (49416:13)❌ 
  │ │ └──[🔀] type (49412:13)❌ 
  │ ├─┬principal
  │ │ └──[🔀] type (49402:13)❌ 
  │ ├─┬ssl_openssl_non_available_cause
  │ │ └──[🔀] type (49443:13)❌ 
  │ ├─┬ssl_openssl_version
  │ │ └──[🔀] type (49433:13)❌ 
  │ └─┬ssl_openssl_version_string
  │   └──[🔀] type (49438:13)❌ 
  ├─┬security._common:AuthInfo
  │ ├─┬sso_logout_url
  │ │ └──[🔀] type (48986:13)❌ 
  │ ├─┬user_requested_tenant
  │ │ └──[🔀] type (48948:13)❌ 
  │ ├─┬backend_roles
  │ │ └──[➕] items (48960:13)❌ 
  │ ├─┬custom_attribute_names
  │ │ └──[➕] items (48965:13)❌ 
  │ ├─┬peer_certificates
  │ │ └──[🔀] type (48981:13)❌ 
  │ ├─┬principal
  │ │ └──[🔀] type (48976:13)❌ 
  │ ├─┬remote_address
  │ │ └──[🔀] type (48953:13)❌ 
  │ └─┬roles
  │   └──[➕] items (48970:13)❌ 
  ├─┬security._common:ConfigUpgradePayload
  │ └─┬config
  │   └──[➕] items (49095:13)❌ 
  └─┬security._common:WhoAmI
    ├─┬dn
    │ └──[🔀] type (49568:13)❌ 
    ├─┬is_admin
    │ └──[🔀] type (49571:17)❌ 
    └─┬is_node_certificate_request
      └──[🔀] type (49573:17)❌

Document Element	Total Changes	Breaking Changes
components	106	49
paths	208	64

❌ BREAKING Changes: 113 out of 314
Modifications: 104
Removals: 24
Additions: 186
Breaking Removals: 16
Breaking Modifications: 73
Breaking Additions: 24

Report

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

API Coverage

	Before	After	Δ
Covered (%)	522 (51.13 %)	522 (51.13 %)	0 (0 %)
Uncovered (%)	499 (48.87 %)	499 (48.87 %)	0 (0 %)
Unknown	24	26	2

Signed-off-by: Darshit Chanpura <[email protected]>

dblock · 2024-07-18T22:55:50Z

Is "with API prefix" recommended over "without API prefix" or vice-versa? Are they the same thing If one is superseded by another then we should move it, mark it as deprecated and likely not test it twice.

DarshitChanpura · 2024-07-19T18:55:50Z

Is "with API prefix" recommended over "without API prefix" or vice-versa? Are they the same thing If one is superseded by another then we should move it, mark it as deprecated and likely not test it twice.

These APIs are completely different:
without API prefix: /_plugins/_security/<path>
with API prefix: /_plugins/_security/api/<path>

The difference is /api in the URL.

Signed-off-by: Darshit Chanpura <[email protected]>

…s added by linter Signed-off-by: Darshit Chanpura <[email protected]>

Signed-off-by: Darshit Chanpura <[email protected]>

dblock · 2024-08-01T15:46:53Z

spec/namespaces/security.yaml

+      name: timeout
+      in: query
+      schema:
+        type: string


Are these strings or one of the duration types?

it is expected as a string to be utilized here: https://github.com/opensearch-project/security/blob/cc26b94ca84b562ae75ed8e2958a343831682042/src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java#L89

I mean should this be

schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration'

i see, I have replaced it.

Signed-off-by: Darshit Chanpura <[email protected]>

…ecurity-tests Signed-off-by: Darshit Chanpura <[email protected]>

Signed-off-by: Darshit Chanpura <[email protected]>

dblock · 2024-08-09T20:30:36Z

.github/workflows/test-spec.yml

+            tests: plugins/security
+          - version: 2.0.0
+            admin_password: admin
+            tests: plugins/security


Are these APIs different in 1.3.x, 2.0 and 2.16? If they aren't very different only leave the latest, 2.16.

dblock · 2024-08-09T20:31:03Z

tests/plugins/security/api/securityconfig.yaml

+      payload:
+        - op: replace
+          path: /config/dynamic/authc/basic_internal_auth_domain/transport_enabled
+          value: 'true'


This is not a bool?

accepts either or. will change it to bool

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura · 2024-08-09T23:04:53Z

Once 2.17 and 3.0 tags on opensearchstaging will be updated, the ci will pass for those two versions.
Fixed here: opensearch-project/security#4628

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura

@dblock Would you please re-review this?

.github/workflows/test-spec.yml

Signed-off-by: Darshit Chanpura <[email protected]>

dblock

Needs some file naming consistency in tests.

tests/default/security/api/action_groups.yaml -> tests/default/security/api/actiongroups.yaml

etc.

Thanks!

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura · 2024-08-12T18:02:48Z

@dblock I've renamed everything to match API path. Could you please re-run CI as the test-failure is not related to security plugin?

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

@DarshitChanpura in #510 I marked a lot of the security API tests to be skipped when running against Amazon Managed / Serverless OpenSearch. You might want to check that it's correct. I found some discrepancies in sslinfo as well where AOS returns null instead of a cipher version, not sure that's expected.

DarshitChanpura added 4 commits July 15, 2024 11:53

Updates the missing item types for security API related schemas

af53f9c

Signed-off-by: Darshit Chanpura <[email protected]>

Adds tests for some APIs

f5220c1

Signed-off-by: Darshit Chanpura <[email protected]>

Merge remote-tracking branch 'upstream/main' into security-tests

cd4709b

Merge remote-tracking branch 'upstream/main' into correct-security-sc…

ec97b6b

…hemas

DarshitChanpura added 4 commits July 18, 2024 17:02

Fixes schema path and lint error in a file

4c51de4

Signed-off-by: Darshit Chanpura <[email protected]>

Adds version check for account API test

a35cfda

Signed-off-by: Darshit Chanpura <[email protected]>

Adds a CHANGELOG entry

488e774

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes tests to expect status as integer

0439eb2

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura added 9 commits July 22, 2024 23:10

Adds base tests for all APIs

f65a6cf

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes linter errors and complete payloads and request bodies

a25b14f

Signed-off-by: Darshit Chanpura <[email protected]>

Merge remote-tracking branch 'upstream/main' into security-tests

dce0965

Adds API spec for the new certificates API and adds tests

ab976d4

Signed-off-by: Darshit Chanpura <[email protected]>

Adds missing new lines at the end of files and removes any extra line…

463401a

…s added by linter Signed-off-by: Darshit Chanpura <[email protected]>

Merge remote-tracking branch 'upstream/main' into security-tests

ee3f3b4

Fixes lint errors

092a1d6

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes test spec lint

757b0ed

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes without api prefix tests

70e9f4c

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura force-pushed the security-tests branch from 8c8c1fe to 70e9f4c Compare August 1, 2024 15:42

dblock reviewed Aug 1, 2024

View reviewed changes

DarshitChanpura added 2 commits August 5, 2024 13:42

Merge remote-tracking branch 'upstream/main' into security-tests

456bc51

Signed-off-by: Darshit Chanpura <[email protected]>

Merge remote-tracking branch 'origin/correct-security-schemas' into s…

588ff10

…ecurity-tests Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura mentioned this pull request Aug 5, 2024

Updates the missing item types for security API related schemas #420

Closed

DarshitChanpura added 3 commits August 7, 2024 15:03

Fixes accounts tests

c86e8fa

Signed-off-by: Darshit Chanpura <[email protected]>

Merge remote-tracking branch 'upstream/main' into security-tests

892561b

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes action-groups tests

7b34505

Signed-off-by: Darshit Chanpura <[email protected]>

nhtruong mentioned this pull request Aug 8, 2024

[BUG][Test Framework] response.payload is set to null for non-2XX responses #482

Open

Fixes account, allowlist and audit tests

0eac313

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura mentioned this pull request Aug 9, 2024

[FEATURE] Add support for custom authorization headers in chapters section of the tests. #485

Closed

DarshitChanpura added 3 commits August 9, 2024 15:54

Moved security tests inside plugins folder

2b3494f

Signed-off-by: Darshit Chanpura <[email protected]>

Updates test spec workflow to run security tests

833c82e

Signed-off-by: Darshit Chanpura <[email protected]>

Adds security test specific docker compose file

451b179

Signed-off-by: Darshit Chanpura <[email protected]>

dblock reviewed Aug 9, 2024

View reviewed changes

DarshitChanpura mentioned this pull request Aug 9, 2024

[API-spec] Add a custom configuration for admin-only APIs and add tests for those opensearch-project/security#4633

Open

DarshitChanpura added 6 commits August 9, 2024 16:42

Cleans commented code and updates test-spec to run for 2.16 only

cb0547e

Signed-off-by: Darshit Chanpura <[email protected]>

Refactor s boolean to be true boolean

54f4cfa

Signed-off-by: Darshit Chanpura <[email protected]>

Move security tests to default folder and updates spec file

536cf04

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes 1.3 tests

87640ec

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes 2.0 test failures

c4205c5

Signed-off-by: Darshit Chanpura <[email protected]>

Fixes TLS cipher versiion payload issue

4227e00

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura added 5 commits August 12, 2024 11:16

Merge remote-tracking branch 'upstream/main' into security-tests

b393538

Re-verifies auth token fix

2f30633

Signed-off-by: Darshit Chanpura <[email protected]>

Checks for newer images and pulls them before running tests

cc10600

Signed-off-by: Darshit Chanpura <[email protected]>

Updates the docker compose command

355cace

Signed-off-by: Darshit Chanpura <[email protected]>

Removes sha ref for staging branches

172328a

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura commented Aug 12, 2024

View reviewed changes

.github/workflows/test-spec.yml Show resolved Hide resolved

Updates shas

7e6bf0c

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura force-pushed the security-tests branch from c1f99b5 to 7e6bf0c Compare August 12, 2024 16:21

dblock requested changes Aug 12, 2024

View reviewed changes

Renames everything to match the API path

705e6cf

Signed-off-by: Darshit Chanpura <[email protected]>

dblock approved these changes Aug 12, 2024

View reviewed changes

dblock merged commit 9eb3732 into opensearch-project:main Aug 12, 2024
15 checks passed

dblock mentioned this pull request Aug 12, 2024

Fix: correctly named folders/files. #497

Merged

dblock mentioned this pull request Nov 7, 2024

[BUG] Security: wrong schemes for PUT requests #202

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

DarshitChanpura commented Jul 18, 2024 •

edited

Loading

github-actions bot commented Jul 18, 2024 •

edited

Loading

dblock commented Jul 18, 2024

DarshitChanpura commented Jul 19, 2024

dblock Aug 1, 2024

DarshitChanpura Aug 9, 2024

dblock Aug 9, 2024

DarshitChanpura Aug 9, 2024

dblock Aug 9, 2024

dblock Aug 9, 2024

DarshitChanpura Aug 9, 2024

DarshitChanpura commented Aug 9, 2024

DarshitChanpura left a comment

dblock left a comment

DarshitChanpura commented Aug 12, 2024

dblock commented Aug 14, 2024

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

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

Conversation

DarshitChanpura commented Jul 18, 2024 • edited Loading

Description

Issues Resolved

github-actions bot commented Jul 18, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

dblock commented Jul 18, 2024

DarshitChanpura commented Jul 19, 2024

dblock Aug 1, 2024

Choose a reason for hiding this comment

DarshitChanpura Aug 9, 2024

Choose a reason for hiding this comment

dblock Aug 9, 2024

Choose a reason for hiding this comment

DarshitChanpura Aug 9, 2024

Choose a reason for hiding this comment

dblock Aug 9, 2024

Choose a reason for hiding this comment

dblock Aug 9, 2024

Choose a reason for hiding this comment

DarshitChanpura Aug 9, 2024

Choose a reason for hiding this comment

DarshitChanpura commented Aug 9, 2024

DarshitChanpura left a comment

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

DarshitChanpura commented Aug 12, 2024

dblock commented Aug 14, 2024

DarshitChanpura commented Jul 18, 2024 •

edited

Loading

github-actions bot commented Jul 18, 2024 •

edited

Loading