From 54855297e267311521dcbbd28077aae94c2e6136 Mon Sep 17 00:00:00 2001 From: dblock Date: Mon, 4 Nov 2024 16:17:56 -0500 Subject: [PATCH] Removed superseeded operations that have unresolved parameters. Signed-off-by: dblock --- CHANGELOG.md | 13 ++- spec/_superseded_operations.yaml | 158 +++++++++++++++---------------- spec/namespaces/ism.yaml | 6 +- 3 files changed, 94 insertions(+), 83 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 031a8c442..3616e4f93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,10 +6,22 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Added - Added API specs for query groups lifecycle APIs ([#649](https://github.com/opensearch-project/opensearch-api-specification/pull/649)) +- Added Python and Ruby spec validators ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) ### Removed - Removed unsupported `_common.mapping:SourceField`'s `mode` field and associated `_common.mapping:SourceFieldMode` enum ([#652](https://github.com/opensearch-project/opensearch-api-specification/pull/652)) +### Fixed +- Spec passes OpenAPI 3.1.0 validations ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Global parameters no longer contain invalid `default` ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Invalid values of `schema: null` are replaced with `schema: false` ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Key names containing invalid `@` and `:` are renamed to `.` and `_` respectively on merge ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Added missing `required` to `path` parameters ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Added missing `schema` parent to response types ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Removed invalid `externalDocs` from `flow_framework.create/update::query.use_case` ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Fixed incorrect `style` in `indices.get_mapping::query.index` ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) +- Removed invalid `required` from `ppl` responses ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) + ## [0.1.0] - 2024-10-25 ### Added @@ -115,7 +127,6 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Added API spec for `adjust_pure_negative` for bool queries ([#641](https://github.com/opensearch-project/opensearch-api-specification/pull/641)) - Added a spec style checker [#620](https://github.com/opensearch-project/opensearch-api-specification/pull/620). - Added `remote_store` to node `Stats` ([#643](https://github.com/opensearch-project/opensearch-api-specification/pull/643)) -- Added Python and Ruby spec validators ([#646](https://github.com/opensearch-project/opensearch-api-specification/pull/646)) ### Changed diff --git a/spec/_superseded_operations.yaml b/spec/_superseded_operations.yaml index 80e556067..d36a404b3 100644 --- a/spec/_superseded_operations.yaml +++ b/spec/_superseded_operations.yaml @@ -200,13 +200,13 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PUT -/_opendistro/_ism/policies/{policyID}: - superseded_by: /_plugins/_ism/policies/{policyID} - operations: - - GET - - HEAD - - PUT - - DELETE +# /_opendistro/_ism/policies/{policyID}: +# superseded_by: /_plugins/_ism/policies/{policyID} +# operations: +# - GET +# - HEAD +# - PUT +# - DELETE /_opendistro/_ism/remove: superseded_by: /_plugins/_ism/remove operations: @@ -239,10 +239,10 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml superseded_by: /_plugins/_knn/{nodeId}/stats/ operations: - GET -/_opendistro/_knn/{nodeId}/stats/{stat}: - superseded_by: /_plugins/_knn/{nodeId}/stats/{stat} - operations: - - GET +# /_opendistro/_knn/{nodeId}/stats/{stat}: +# superseded_by: /_plugins/_knn/{nodeId}/stats/{stat} +# operations: +# - GET /_opendistro/_performanceanalyzer/_agent/{redirectEndpoint}: superseded_by: /_plugins/_performanceanalyzer/_agent/{redirectEndpoint} operations: @@ -353,25 +353,25 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PUT -/_opendistro/_rollup/jobs/{rollupID}: - superseded_by: /_plugins/_rollup/jobs/{rollupID} - operations: - - GET - - HEAD - - PUT - - DELETE -/_opendistro/_rollup/jobs/{rollupID}/_explain: - superseded_by: /_plugins/_rollup/jobs/{rollupID}/_explain - operations: - - GET -/_opendistro/_rollup/jobs/{rollupID}/_start: - superseded_by: /_plugins/_rollup/jobs/{rollupID}/_start - operations: - - POST -/_opendistro/_rollup/jobs/{rollupID}/_stop: - superseded_by: /_plugins/_rollup/jobs/{rollupID}/_stop - operations: - - POST +# /_opendistro/_rollup/jobs/{rollupID}: +# superseded_by: /_plugins/_rollup/jobs/{rollupID} +# operations: +# - GET +# - HEAD +# - PUT +# - DELETE +# /_opendistro/_rollup/jobs/{rollupID}/_explain: +# superseded_by: /_plugins/_rollup/jobs/{rollupID}/_explain +# operations: +# - GET +# /_opendistro/_rollup/jobs/{rollupID}/_start: +# superseded_by: /_plugins/_rollup/jobs/{rollupID}/_start +# operations: +# - POST +# /_opendistro/_rollup/jobs/{rollupID}/_stop: +# superseded_by: /_plugins/_rollup/jobs/{rollupID}/_stop +# operations: +# - POST /_opendistro/_security/api/_upgrade_check/: superseded_by: /_plugins/_security/api/_upgrade_check/ operations: @@ -400,13 +400,13 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PATCH -/_opendistro/_security/api/actiongroups/{name}: - superseded_by: /_plugins/_security/api/actiongroups/{name} - operations: - - GET - - PUT - - PATCH - - DELETE +# /_opendistro/_security/api/actiongroups/{name}: +# superseded_by: /_plugins/_security/api/actiongroups/{name} +# operations: +# - GET +# - PUT +# - PATCH +# - DELETE /_opendistro/_security/api/audit/: superseded_by: /_plugins/_security/api/audit/ operations: @@ -432,17 +432,17 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PATCH -/_opendistro/_security/api/internalusers/{name}: - superseded_by: /_plugins/_security/api/internalusers/{name} - operations: - - GET - - PUT - - PATCH - - DELETE -/_opendistro/_security/api/internalusers/{name}/authtoken: - superseded_by: /_plugins/_security/api/internalusers/{name}/authtoken - operations: - - POST +# /_opendistro/_security/api/internalusers/{name}: +# superseded_by: /_plugins/_security/api/internalusers/{name} +# operations: +# - GET +# - PUT +# - PATCH +# - DELETE +# /_opendistro/_security/api/internalusers/{name}/authtoken: +# superseded_by: /_plugins/_security/api/internalusers/{name}/authtoken +# operations: +# - POST /_opendistro/_security/api/migrate: superseded_by: /_plugins/_security/api/migrate operations: @@ -456,25 +456,25 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PATCH -/_opendistro/_security/api/roles/{name}: - superseded_by: /_plugins/_security/api/roles/{name} - operations: - - GET - - PUT - - PATCH - - DELETE +# /_opendistro/_security/api/roles/{name}: +# superseded_by: /_plugins/_security/api/roles/{name} +# operations: +# - GET +# - PUT +# - PATCH +# - DELETE /_opendistro/_security/api/rolesmapping/: superseded_by: /_plugins/_security/api/rolesmapping/ operations: - GET - PATCH -/_opendistro/_security/api/rolesmapping/{name}: - superseded_by: /_plugins/_security/api/rolesmapping/{name} - operations: - - GET - - PUT - - PATCH - - DELETE +# /_opendistro/_security/api/rolesmapping/{name}: +# superseded_by: /_plugins/_security/api/rolesmapping/{name} +# operations: +# - GET +# - PUT +# - PATCH +# - DELETE /_opendistro/_security/api/securityconfig: superseded_by: /_plugins/_security/api/securityconfig operations: @@ -518,27 +518,27 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml operations: - GET - PATCH -/_opendistro/_security/api/tenants/{name}: - superseded_by: /_plugins/_security/api/tenants/{name} - operations: - - GET - - PUT - - PATCH - - DELETE +# /_opendistro/_security/api/tenants/{name}: +# superseded_by: /_plugins/_security/api/tenants/{name} +# operations: +# - GET +# - PUT +# - PATCH +# - DELETE /_opendistro/_security/api/user: superseded_by: /_plugins/_security/api/user operations: - GET -/_opendistro/_security/api/user/{name}: - superseded_by: /_plugins/_security/api/user/{name} - operations: - - GET - - PUT - - DELETE -/_opendistro/_security/api/user/{name}/authtoken: - superseded_by: /_plugins/_security/api/user/{name}/authtoken - operations: - - POST +# /_opendistro/_security/api/user/{name}: +# superseded_by: /_plugins/_security/api/user/{name} +# operations: +# - GET +# - PUT +# - DELETE +# /_opendistro/_security/api/user/{name}/authtoken: +# superseded_by: /_plugins/_security/api/user/{name}/authtoken +# operations: +# - POST /_opendistro/_security/api/validate: superseded_by: /_plugins/_security/api/validate operations: diff --git a/spec/namespaces/ism.yaml b/spec/namespaces/ism.yaml index 334bc69f7..9e91d84c7 100644 --- a/spec/namespaces/ism.yaml +++ b/spec/namespaces/ism.yaml @@ -178,7 +178,7 @@ paths: '200': $ref: '#/components/responses/ism.explain_policy@200' post: - operationId: ism.explain_policy.0 + operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy description: Gets the currently applied policy on indices. externalDocs: @@ -190,7 +190,7 @@ paths: $ref: '#/components/responses/ism.explain_policy@200' /_plugins/_ism/explain/{index}: get: - operationId: ism.explain_policy.1 + operationId: ism.explain_policy.3 x-operation-group: ism.explain_policy description: Gets the currently applied policy on indices. externalDocs: @@ -203,7 +203,7 @@ paths: '200': $ref: '#/components/responses/ism.explain_policy@200' post: - operationId: ism.explain_policy.1 + operationId: ism.explain_policy.4 x-operation-group: ism.explain_policy description: Gets the currently applied policy on indices. externalDocs: