Skip to content

Commit

Permalink
Adds API spec for security plugin (#271)
Browse files Browse the repository at this point in the history
* Adds missing entries in the spec as well superseded yml files

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

* Re-organized HTTP methods in GET, POST, PUT, PATCH, DELETE order

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

* Re-arrange alphabetically

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

* Added all missing endpoints

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

* Added missing response codes

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

* Adds correct versions and fixes grammar in description field

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

* Adds entries in root file and fixes linter

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

* Adds legacy user api and rearranges some request bodies

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

* Re-arranges some more schemas

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

* Fixes a couple of descriptions

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

* Sort all schemas alphabetically

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

* Make cache operation ingorable

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

* Replace properties with additionalProperties for readability and flexibility

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

---------

Signed-off-by: Darshit Chanpura <[email protected]>
  • Loading branch information
DarshitChanpura authored May 10, 2024
1 parent 57dd4ca commit de939d2
Show file tree
Hide file tree
Showing 3 changed files with 1,714 additions and 654 deletions.
50 changes: 38 additions & 12 deletions spec/_superseded_operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,14 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
superseded_by: /_plugins/_rollup/jobs/{rollupID}/_stop
operations:
- POST
/_opendistro/_security/api/_upgrade_check/:
superseded_by: /_plugins/_security/api/_upgrade_check/
operations:
- GET
/_opendistro/_security/api/_upgrade_perform/:
superseded_by: /_plugins/_security/api/_upgrade_perform/
operations:
- POST
/_opendistro/_security/api/account:
superseded_by: /_plugins/_security/api/account
operations:
Expand All @@ -393,8 +401,8 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
operations:
- GET
- PUT
- DELETE
- PATCH
- DELETE
/_opendistro/_security/api/audit/:
superseded_by: /_plugins/_security/api/audit/
operations:
Expand Down Expand Up @@ -476,17 +484,33 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
superseded_by: /_plugins/_security/api/ssl/certs
operations:
- GET
/_opendistro/_security/api/ssl/{certType}/reloadcerts/:
superseded_by: /_plugins/_security/api/ssl/{certType}/reloadcerts/
/_opendistro/_security/api/ssl/transport/reloadcerts:
superseded_by: /_plugins/_security/api/ssl/transport/reloadcerts
operations:
- PUT
/_opendistro/_security/api/ssl/http/reloadcerts:
superseded_by: /_plugins/_security/api/ssl/http/reloadcerts
operations:
- PUT
/_opendistro/_security/api/nodesdn:
superseded_by: /_plugins/_security/api/nodesdn/
operations:
- GET
- PATCH
/_opendistro/_security/api/nodesdn/{cluster_name}:
superseded_by: /_plugins/_security/api/nodesdn/{cluster_name}
operations:
- GET
- PUT
- PATCH
- DELETE
/_opendistro/_security/api/tenancy/config:
superseded_by: /_plugins/_security/api/tenancy/config
operations:
- GET
- PUT
/_opendistro/_security/api/tenants/:
superseded_by: /_plugins/_security/api/tenants/
/_opendistro/_security/api/tenants:
superseded_by: /_plugins/_security/api/tenants
operations:
- GET
- PATCH
Expand All @@ -497,8 +521,8 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
- PUT
- DELETE
- PATCH
/_opendistro/_security/api/user/:
superseded_by: /_plugins/_security/api/user/
/_opendistro/_security/api/user:
superseded_by: /_plugins/_security/api/user
operations:
- GET
/_opendistro/_security/api/user/{name}:
Expand All @@ -521,6 +545,12 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
- GET
- PUT
- PATCH
/_opendistro/_security/api/allowlist:
superseded_by: /_plugins/_security/api/allowlist
operations:
- GET
- PUT
- PATCH
/_opendistro/_security/authinfo:
superseded_by: /_plugins/_security/authinfo
operations:
Expand All @@ -532,14 +562,10 @@ $schema: ../json_schemas/_superseded_operations.schema.yaml
- GET
- POST
/_opendistro/_security/kibanainfo:
superseded_by: /_plugins/_security/kibanainfo
superseded_by: /_plugins/_security/dashboardsinfo
operations:
- GET
- POST
/_opendistro/_security/sslinfo:
superseded_by: /_plugins/_security/sslinfo
operations:
- GET
/_opendistro/_security/tenantinfo:
superseded_by: /_plugins/_security/tenantinfo
operations:
Expand Down
Loading

0 comments on commit de939d2

Please sign in to comment.