Added a linter for order of parameters. (#369)

* Added a linter for order of parameters. Signed-off-by: dblock <[email protected]> * Re-add npm run jest to run individual tests. Signed-off-by: dblock <[email protected]> * Sorted parameters in spec. Signed-off-by: dblock <[email protected]> --------- Signed-off-by: dblock <[email protected]>
opensearch-project · Jun 30, 2024 · e96f70d · e96f70d
1 parent ed3fb4d
commit e96f70d
Show file tree

Hide file tree

Showing 23 changed files with 817 additions and 777 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added support for `text/plain` responses in `_cat` APIs ([#360](https://github.com/opensearch-project/opensearch-api-specification/pull/360))
 - Added support for `application/yaml` responses ([#363](https://github.com/opensearch-project/opensearch-api-specification/pull/363))
 - Added test for search with seq_no_primary_term ([#367](https://github.com/opensearch-project/opensearch-api-specification/pull/367))
+- Added a linter for parameter sorting ([#369](https://github.com/opensearch-project/opensearch-api-specification/pull/369))
 
 ### Changed
 

diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
     "lint--fix": "eslint . --fix --report-unused-disable-directives",
     "merge": "ts-node tools/src/merger/merge.ts",
     "test": "npm run test:unit && npm run test:integ",
+    "jest": "jest",
     "test:unit": "jest --testMatch='**/*.test.ts' --testPathIgnorePatterns=/integ/",
     "test:integ": "jest --testMatch='**/integ/*.test.ts' --runInBand",
     "test:spec": "ts-node tools/src/tester/test.ts",

diff --git a/spec/_global_parameters.yaml b/spec/_global_parameters.yaml
@@ -40,4 +40,4 @@ components:
           - type: string
           - type: array
             items:
-              type: string
+              type: string
diff --git a/spec/_info.yaml b/spec/_info.yaml
@@ -1,4 +1,4 @@
 $schema: ./json_schemas/_info.schema.yaml
 
 title: OpenSearch API Specification
-version: 1.0.0
+version: 1.0.0
diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml
diff --git a/spec/namespaces/dangling_indices.yaml b/spec/namespaces/dangling_indices.yaml
@@ -27,9 +27,9 @@ paths:
       parameters:
         - $ref: '#/components/parameters/dangling_indices.import_dangling_index::path.index_uuid'
         - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.accept_data_loss'
-        - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.timeout'
-        - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout'
         - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout'
+        - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.timeout'
       responses:
         '200':
           $ref: '#/components/responses/dangling_indices.import_dangling_index@200'
@@ -43,9 +43,9 @@ paths:
       parameters:
         - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::path.index_uuid'
         - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.accept_data_loss'
-        - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.timeout'
-        - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout'
         - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout'
+        - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.timeout'
       responses:
         '200':
           $ref: '#/components/responses/dangling_indices.delete_dangling_index@200'

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml
@@ -13,8 +13,8 @@ paths:
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
       parameters:
-        - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout'
       responses:
         '200':
           $ref: '#/components/responses/ingest.get_pipeline@200'
@@ -57,8 +57,8 @@ paths:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
       parameters:
         - $ref: '#/components/parameters/ingest.get_pipeline::path.id'
-        - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout'
       responses:
         '200':
           $ref: '#/components/responses/ingest.get_pipeline@200'
@@ -71,8 +71,8 @@ paths:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
       parameters:
         - $ref: '#/components/parameters/ingest.put_pipeline::path.id'
-        - $ref: '#/components/parameters/ingest.put_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.put_pipeline::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/ingest.put_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.put_pipeline::query.timeout'
       requestBody:
         $ref: '#/components/requestBodies/ingest.put_pipeline'
@@ -88,8 +88,8 @@ paths:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
       parameters:
         - $ref: '#/components/parameters/ingest.delete_pipeline::path.id'
-        - $ref: '#/components/parameters/ingest.delete_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.delete_pipeline::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/ingest.delete_pipeline::query.master_timeout'
         - $ref: '#/components/parameters/ingest.delete_pipeline::query.timeout'
       responses:
         '200':

diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml
@@ -13,48 +13,48 @@ paths:
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model
       parameters:
-        - $ref: '#/components/parameters/knn.search_models::query.analyzer'
+        - $ref: '#/components/parameters/knn.search_models::query._source'
+        - $ref: '#/components/parameters/knn.search_models::query._source_excludes'
+        - $ref: '#/components/parameters/knn.search_models::query._source_includes'
+        - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices'
+        - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results'
         - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard'
+        - $ref: '#/components/parameters/knn.search_models::query.analyzer'
+        - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size'
         - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips'
         - $ref: '#/components/parameters/knn.search_models::query.default_operator'
         - $ref: '#/components/parameters/knn.search_models::query.df'
-        - $ref: '#/components/parameters/knn.search_models::query.explain'
-        - $ref: '#/components/parameters/knn.search_models::query.stored_fields'
         - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields'
+        - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards'
+        - $ref: '#/components/parameters/knn.search_models::query.explain'
         - $ref: '#/components/parameters/knn.search_models::query.from'
-        - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable'
         - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled'
-        - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices'
-        - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards'
+        - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable'
         - $ref: '#/components/parameters/knn.search_models::query.lenient'
+        - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests'
+        - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size'
         - $ref: '#/components/parameters/knn.search_models::query.preference'
         - $ref: '#/components/parameters/knn.search_models::query.q'
+        - $ref: '#/components/parameters/knn.search_models::query.request_cache'
+        - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int'
         - $ref: '#/components/parameters/knn.search_models::query.routing'
         - $ref: '#/components/parameters/knn.search_models::query.scroll'
         - $ref: '#/components/parameters/knn.search_models::query.search_type'
+        - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term'
         - $ref: '#/components/parameters/knn.search_models::query.size'
         - $ref: '#/components/parameters/knn.search_models::query.sort'
-        - $ref: '#/components/parameters/knn.search_models::query._source'
-        - $ref: '#/components/parameters/knn.search_models::query._source_excludes'
-        - $ref: '#/components/parameters/knn.search_models::query._source_includes'
-        - $ref: '#/components/parameters/knn.search_models::query.terminate_after'
         - $ref: '#/components/parameters/knn.search_models::query.stats'
+        - $ref: '#/components/parameters/knn.search_models::query.stored_fields'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_field'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_mode'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_size'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_text'
+        - $ref: '#/components/parameters/knn.search_models::query.terminate_after'
         - $ref: '#/components/parameters/knn.search_models::query.timeout'
         - $ref: '#/components/parameters/knn.search_models::query.track_scores'
         - $ref: '#/components/parameters/knn.search_models::query.track_total_hits'
-        - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results'
         - $ref: '#/components/parameters/knn.search_models::query.typed_keys'
         - $ref: '#/components/parameters/knn.search_models::query.version'
-        - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term'
-        - $ref: '#/components/parameters/knn.search_models::query.request_cache'
-        - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size'
-        - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests'
-        - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size'
-        - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int'
       requestBody:
         $ref: '#/components/requestBodies/knn.search_models'
       responses:
@@ -68,48 +68,48 @@ paths:
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model
       parameters:
-        - $ref: '#/components/parameters/knn.search_models::query.analyzer'
+        - $ref: '#/components/parameters/knn.search_models::query._source'
+        - $ref: '#/components/parameters/knn.search_models::query._source_excludes'
+        - $ref: '#/components/parameters/knn.search_models::query._source_includes'
+        - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices'
+        - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results'
         - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard'
+        - $ref: '#/components/parameters/knn.search_models::query.analyzer'
+        - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size'
         - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips'
         - $ref: '#/components/parameters/knn.search_models::query.default_operator'
         - $ref: '#/components/parameters/knn.search_models::query.df'
-        - $ref: '#/components/parameters/knn.search_models::query.explain'
-        - $ref: '#/components/parameters/knn.search_models::query.stored_fields'
         - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields'
+        - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards'
+        - $ref: '#/components/parameters/knn.search_models::query.explain'
         - $ref: '#/components/parameters/knn.search_models::query.from'
-        - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable'
         - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled'
-        - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices'
-        - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards'
+        - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable'
         - $ref: '#/components/parameters/knn.search_models::query.lenient'
+        - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests'
+        - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size'
         - $ref: '#/components/parameters/knn.search_models::query.preference'
         - $ref: '#/components/parameters/knn.search_models::query.q'
+        - $ref: '#/components/parameters/knn.search_models::query.request_cache'
+        - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int'
         - $ref: '#/components/parameters/knn.search_models::query.routing'
         - $ref: '#/components/parameters/knn.search_models::query.scroll'
         - $ref: '#/components/parameters/knn.search_models::query.search_type'
+        - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term'
         - $ref: '#/components/parameters/knn.search_models::query.size'
         - $ref: '#/components/parameters/knn.search_models::query.sort'
-        - $ref: '#/components/parameters/knn.search_models::query._source'
-        - $ref: '#/components/parameters/knn.search_models::query._source_excludes'
-        - $ref: '#/components/parameters/knn.search_models::query._source_includes'
-        - $ref: '#/components/parameters/knn.search_models::query.terminate_after'
         - $ref: '#/components/parameters/knn.search_models::query.stats'
+        - $ref: '#/components/parameters/knn.search_models::query.stored_fields'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_field'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_mode'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_size'
         - $ref: '#/components/parameters/knn.search_models::query.suggest_text'
+        - $ref: '#/components/parameters/knn.search_models::query.terminate_after'
         - $ref: '#/components/parameters/knn.search_models::query.timeout'
         - $ref: '#/components/parameters/knn.search_models::query.track_scores'
         - $ref: '#/components/parameters/knn.search_models::query.track_total_hits'
-        - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results'
         - $ref: '#/components/parameters/knn.search_models::query.typed_keys'
         - $ref: '#/components/parameters/knn.search_models::query.version'
-        - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term'
-        - $ref: '#/components/parameters/knn.search_models::query.request_cache'
-        - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size'
-        - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests'
-        - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size'
-        - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int'
       requestBody:
         $ref: '#/components/requestBodies/knn.search_models'
       responses: