Adds test for APIs related to security plugin and updates spec to add new APIs. #439
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -163,6 +163,7 @@ subqueries | |
| subschemas | ||
| subword | ||
| syserr | ||
| tcnative | ||
| tdigest | ||
| tenantinfo | ||
| termvectors | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,8 +60,6 @@ paths: | |
| x-operation-group: security.post_dashboards_info | ||
| x-version-added: '1.0' | ||
| description: Updates the current security-dashboards plugin configuration. | ||
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.post_dashboards_info@200' | ||
|
|
@@ -101,6 +99,8 @@ paths: | |
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.tenant_info@200' | ||
| '403': | ||
| $ref: '#/components/responses/security.tenant_info@403' | ||
| '500': | ||
| $ref: '#/components/responses/security.tenant_info@500' | ||
| post: | ||
|
|
@@ -111,6 +111,8 @@ paths: | |
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.tenant_info@200' | ||
| '403': | ||
| $ref: '#/components/responses/security.tenant_info@403' | ||
| '500': | ||
| $ref: '#/components/responses/security.tenant_info@500' | ||
| /_plugins/_security/whoami: | ||
|
|
@@ -145,7 +147,7 @@ paths: | |
| $ref: '#/components/responses/security.who_am_i_protected@200' | ||
| '500': | ||
| $ref: '#/components/responses/security.who_am_i_protected@500' | ||
| /_plugins/_security/api/_upgrade_check: | ||
| get: | ||
| operationId: security.config_upgrade_check.0 | ||
| x-operation-group: security.config_upgrade_check | ||
|
|
@@ -156,7 +158,7 @@ paths: | |
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.config_upgrade_check@200' | ||
| /_plugins/_security/api/_upgrade_perform: | ||
| post: | ||
| operationId: security.config_upgrade_perform.0 | ||
| x-operation-group: security.config_upgrade_perform | ||
|
|
@@ -386,6 +388,35 @@ paths: | |
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.flush_cache@200' | ||
| /_plugins/_security/api/certificates: | ||
| get: | ||
| operationId: security.get_all_certificates.0 | ||
| x-operation-group: security.get_all_certificates | ||
| x-version-added: '2.15' | ||
| description: Retrieves the cluster security certificates. | ||
| parameters: | ||
| - $ref: '#/components/parameters/security.get_all_certificates::query.cert_type' | ||
| - $ref: '#/components/parameters/security.get_all_certificates::query.timeout' | ||
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.get_all_certificates@200' | ||
| '500': | ||
| $ref: '#/components/responses/security.get_all_certificates@500' | ||
| /_plugins/_security/api/certificates/{node_id}: | ||
| get: | ||
| operationId: security.get_node_certificates.0 | ||
| x-operation-group: security.get_node_certificates | ||
| x-version-added: '2.15' | ||
| description: Retrieves the given node's security certificates. | ||
| parameters: | ||
| - $ref: '#/components/parameters/security.get_node_certificates::path.node_id' | ||
| - $ref: '#/components/parameters/security.get_node_certificates::query.cert_type' | ||
| - $ref: '#/components/parameters/security.get_node_certificates::query.timeout' | ||
| responses: | ||
| '200': | ||
| $ref: '#/components/responses/security.get_node_certificates@200' | ||
| '500': | ||
| $ref: '#/components/responses/security.get_node_certificates@500' | ||
| /_plugins/_security/api/generateonbehalfoftoken: | ||
| post: | ||
| operationId: security.generate_obo_token.0 | ||
|
|
@@ -1064,9 +1095,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/MultiTenancyConfig' | ||
| required: true | ||
| security.create_user: | ||
| content: | ||
|
|
@@ -1203,12 +1232,6 @@ components: | |
| items: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' | ||
| required: true | ||
| security.update_audit_configuration: | ||
| content: | ||
| application/json: | ||
|
|
@@ -1346,7 +1369,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.delete_role@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1461,12 +1484,36 @@ components: | |
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/GetCertificates' | ||
| security.get_all_certificates@200: | ||
| description: '' | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/GetCertificatesNew' | ||
| security.get_node_certificates@200: | ||
| description: '' | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/GetCertificatesNew' | ||
| security.get_certificates@400: | ||
| description: '' | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/BadRequest' | ||
| security.get_all_certificates@500: | ||
| description: '' | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/InternalServerError' | ||
| security.get_node_certificates@500: | ||
| description: '' | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/InternalServerError' | ||
| security.get_configuration@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1496,7 +1543,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.get_distinguished_names@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1508,7 +1555,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.get_permissions_info@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1670,7 +1717,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.patch_distinguished_names@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1682,7 +1729,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.patch_role@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1809,6 +1856,14 @@ components: | |
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/TenantInfo' | ||
| security.tenant_info@403: | ||
| description: '' | ||
| content: | ||
| text/plain: | ||
| type: string | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.tenant_info@500: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1838,7 +1893,7 @@ components: | |
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/security._common.yaml#/components/schemas/Forbidden' | ||
| security.validate@200: | ||
| description: '' | ||
| content: | ||
|
|
@@ -1992,6 +2047,36 @@ components: | |
| type: string | ||
| description: Action group to retrieve. | ||
| required: true | ||
| security.get_node_certificates::path.node_id: | ||
| name: node_id | ||
| in: path | ||
| schema: | ||
| type: string | ||
| required: true | ||
| security.get_all_certificates::query.cert_type: | ||
| name: cert_type | ||
| in: query | ||
| schema: | ||
| type: string | ||
| required: false | ||
| security.get_node_certificates::query.cert_type: | ||
| name: cert_type | ||
| in: query | ||
| schema: | ||
| type: string | ||
| required: false | ||
| security.get_all_certificates::query.timeout: | ||
| name: timeout | ||
| in: query | ||
| schema: | ||
| type: string | ||
|
There was a problem hiding this comment. Are these strings or one of the duration types? There was a problem hiding this comment. 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 There was a problem hiding this comment. I mean should this be There was a problem hiding this comment. i see, I have replaced it. |
||
| required: false | ||
| security.get_node_certificates::query.timeout: | ||
| name: timeout | ||
| in: query | ||
| schema: | ||
| type: string | ||
| required: false | ||
| security.get_distinguished_name::path.cluster_name: | ||
| name: cluster_name | ||
| in: path | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to mention tests as they are not external.
Mention additions here (e.g. "Added
/_plugins/_security/api/certificates/{node_id}"), and fixes under fixes with some specifics (e.g. "Fixed/_plugins/_security/api/_upgrade_check").There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated changelog. I've also added an entry for specs that I added originally.