Use BasePackage for search output data (#529)

So far the `/search` output was manually built. This had the risk that the format of the package output and search output diverge but they should not. To prevent this, a BasePackage is introduced. The package is composed out of this BasePackage with additional fields. This change does not affect the output, only the order of the output.
elastic · Jun 23, 2020 · 337a7c5 · 337a7c5
1 parent 584ca40
commit 337a7c5
Show file tree

Hide file tree

Showing 15 changed files with 273 additions and 269 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Remove package code generator. [#513](https://github.com/elastic/package-registry/pull/513)
 * Support multiple packages paths. [#525](https://github.com/elastic/package-registry/pull/525)
 * Added support for ecs style validation for dataset fields. [#520](https://github.com/elastic/package-registry/pull/520)
+* Use BasePackage for search output data. [#529](https://github.com/elastic/package-registry/pull/529)
 
 ### Deprecated
 

diff --git a/docs/api/package.json b/docs/api/package.json
@@ -1,12 +1,14 @@
 {
-  "format_version": "1.0.0",
   "name": "example",
   "title": "Example Integration",
   "version": "1.0.0",
-  "readme": "/package/example/1.0.0/docs/README.md",
-  "license": "basic",
   "description": "This is the example integration",
   "type": "integration",
+  "download": "/epr/example/example-1.0.0.tar.gz",
+  "path": "/package/example/1.0.0",
+  "format_version": "1.0.0",
+  "readme": "/package/example/1.0.0/docs/README.md",
+  "license": "basic",
   "categories": [
     "logs",
     "metrics"
@@ -111,7 +113,5 @@
       ],
       "multiple": true
     }
-  ],
-  "download": "/epr/example/example-1.0.0.tar.gz",
-  "path": "/package/example/1.0.0"
+  ]
 }
diff --git a/docs/api/search-all.json b/docs/api/search-all.json
@@ -1,74 +1,74 @@
 [
   {
-    "description": "Package with data sources",
-    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
     "name": "datasources",
-    "path": "/package/datasources/1.0.0",
     "title": "Default datasource Integration",
+    "version": "1.0.0",
+    "description": "Package with data sources",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
+    "path": "/package/datasources/1.0.0"
   },
   {
-    "description": "Tests if no pipeline is set, it defaults to the default one",
-    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
     "name": "default_pipeline",
-    "path": "/package/default_pipeline/0.0.2",
     "title": "Default pipeline Integration",
+    "version": "0.0.2",
+    "description": "Tests if no pipeline is set, it defaults to the default one",
     "type": "integration",
-    "version": "0.0.2"
+    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
+    "path": "/package/default_pipeline/0.0.2"
   },
   {
-    "description": "Tests the registry validations works for dataset fields using the ecs style format",
-    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
     "name": "ecs_style_dataset",
-    "path": "/package/ecs_style_dataset/0.0.1",
     "title": "Default pipeline Integration",
+    "version": "0.0.1",
+    "description": "Tests the registry validations works for dataset fields using the ecs style format",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
+    "path": "/package/ecs_style_dataset/0.0.1"
   },
   {
-    "description": "This is the example integration.",
-    "download": "/epr/example/example-0.0.2.tar.gz",
     "name": "example",
-    "path": "/package/example/0.0.2",
     "title": "Example",
+    "version": "0.0.2",
+    "description": "This is the example integration.",
     "type": "integration",
-    "version": "0.0.2"
+    "download": "/epr/example/example-0.0.2.tar.gz",
+    "path": "/package/example/0.0.2"
   },
   {
-    "description": "This is the example integration",
-    "download": "/epr/example/example-1.0.0.tar.gz",
     "name": "example",
-    "path": "/package/example/1.0.0",
     "title": "Example Integration",
+    "version": "1.0.0",
+    "description": "This is the example integration",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/example/example-1.0.0.tar.gz",
+    "path": "/package/example/1.0.0"
   },
   {
-    "description": "This is the foo integration",
-    "download": "/epr/foo/foo-1.0.0.tar.gz",
     "name": "foo",
-    "path": "/package/foo/1.0.0",
     "title": "Foo",
+    "version": "1.0.0",
+    "description": "This is the foo integration",
     "type": "solution",
-    "version": "1.0.0"
+    "download": "/epr/foo/foo-1.0.0.tar.gz",
+    "path": "/package/foo/1.0.0"
   },
   {
-    "description": "Tests that multiple can be set to false",
-    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
     "name": "multiple_false",
-    "path": "/package/multiple_false/0.0.1",
     "title": "Multiple false",
+    "version": "0.0.1",
+    "description": "Tests that multiple can be set to false",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
+    "path": "/package/multiple_false/0.0.1"
   },
   {
-    "description": "This package does contain a dataset but not stream configs.\n",
-    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
     "name": "no_stream_configs",
-    "path": "/package/no_stream_configs/1.0.0",
     "title": "No Stream configs",
+    "version": "1.0.0",
+    "description": "This package does contain a dataset but not stream configs.\n",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
+    "path": "/package/no_stream_configs/1.0.0"
   }
 ]
diff --git a/docs/api/search-category-logs.json b/docs/api/search-category-logs.json
@@ -1,56 +1,56 @@
 [
   {
-    "description": "Package with data sources",
-    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
     "name": "datasources",
-    "path": "/package/datasources/1.0.0",
     "title": "Default datasource Integration",
+    "version": "1.0.0",
+    "description": "Package with data sources",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
+    "path": "/package/datasources/1.0.0"
   },
   {
-    "description": "Tests if no pipeline is set, it defaults to the default one",
-    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
     "name": "default_pipeline",
-    "path": "/package/default_pipeline/0.0.2",
     "title": "Default pipeline Integration",
+    "version": "0.0.2",
+    "description": "Tests if no pipeline is set, it defaults to the default one",
     "type": "integration",
-    "version": "0.0.2"
+    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
+    "path": "/package/default_pipeline/0.0.2"
   },
   {
-    "description": "Tests the registry validations works for dataset fields using the ecs style format",
-    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
     "name": "ecs_style_dataset",
-    "path": "/package/ecs_style_dataset/0.0.1",
     "title": "Default pipeline Integration",
+    "version": "0.0.1",
+    "description": "Tests the registry validations works for dataset fields using the ecs style format",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
+    "path": "/package/ecs_style_dataset/0.0.1"
   },
   {
-    "description": "This is the example integration",
-    "download": "/epr/example/example-1.0.0.tar.gz",
     "name": "example",
-    "path": "/package/example/1.0.0",
     "title": "Example Integration",
+    "version": "1.0.0",
+    "description": "This is the example integration",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/example/example-1.0.0.tar.gz",
+    "path": "/package/example/1.0.0"
   },
   {
-    "description": "Tests that multiple can be set to false",
-    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
     "name": "multiple_false",
-    "path": "/package/multiple_false/0.0.1",
     "title": "Multiple false",
+    "version": "0.0.1",
+    "description": "Tests that multiple can be set to false",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
+    "path": "/package/multiple_false/0.0.1"
   },
   {
-    "description": "This package does contain a dataset but not stream configs.\n",
-    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
     "name": "no_stream_configs",
-    "path": "/package/no_stream_configs/1.0.0",
     "title": "No Stream configs",
+    "version": "1.0.0",
+    "description": "This package does contain a dataset but not stream configs.\n",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
+    "path": "/package/no_stream_configs/1.0.0"
   }
 ]
diff --git a/docs/api/search-category-metrics.json b/docs/api/search-category-metrics.json
@@ -1,20 +1,20 @@
 [
   {
-    "description": "This is the example integration",
-    "download": "/epr/example/example-1.0.0.tar.gz",
     "name": "example",
-    "path": "/package/example/1.0.0",
     "title": "Example Integration",
+    "version": "1.0.0",
+    "description": "This is the example integration",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/example/example-1.0.0.tar.gz",
+    "path": "/package/example/1.0.0"
   },
   {
-    "description": "This is the foo integration",
-    "download": "/epr/foo/foo-1.0.0.tar.gz",
     "name": "foo",
-    "path": "/package/foo/1.0.0",
     "title": "Foo",
+    "version": "1.0.0",
+    "description": "This is the foo integration",
     "type": "solution",
-    "version": "1.0.0"
+    "download": "/epr/foo/foo-1.0.0.tar.gz",
+    "path": "/package/foo/1.0.0"
   }
 ]
diff --git a/docs/api/search-kibana652.json b/docs/api/search-kibana652.json
@@ -1,56 +1,56 @@
 [
   {
-    "description": "Package with data sources",
-    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
     "name": "datasources",
-    "path": "/package/datasources/1.0.0",
     "title": "Default datasource Integration",
+    "version": "1.0.0",
+    "description": "Package with data sources",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/datasources/datasources-1.0.0.tar.gz",
+    "path": "/package/datasources/1.0.0"
   },
   {
-    "description": "Tests if no pipeline is set, it defaults to the default one",
-    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
     "name": "default_pipeline",
-    "path": "/package/default_pipeline/0.0.2",
     "title": "Default pipeline Integration",
+    "version": "0.0.2",
+    "description": "Tests if no pipeline is set, it defaults to the default one",
     "type": "integration",
-    "version": "0.0.2"
+    "download": "/epr/default_pipeline/default_pipeline-0.0.2.tar.gz",
+    "path": "/package/default_pipeline/0.0.2"
   },
   {
-    "description": "Tests the registry validations works for dataset fields using the ecs style format",
-    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
     "name": "ecs_style_dataset",
-    "path": "/package/ecs_style_dataset/0.0.1",
     "title": "Default pipeline Integration",
+    "version": "0.0.1",
+    "description": "Tests the registry validations works for dataset fields using the ecs style format",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/ecs_style_dataset/ecs_style_dataset-0.0.1.tar.gz",
+    "path": "/package/ecs_style_dataset/0.0.1"
   },
   {
-    "description": "This is the example integration.",
-    "download": "/epr/example/example-0.0.2.tar.gz",
     "name": "example",
-    "path": "/package/example/0.0.2",
     "title": "Example",
+    "version": "0.0.2",
+    "description": "This is the example integration.",
     "type": "integration",
-    "version": "0.0.2"
+    "download": "/epr/example/example-0.0.2.tar.gz",
+    "path": "/package/example/0.0.2"
   },
   {
-    "description": "Tests that multiple can be set to false",
-    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
     "name": "multiple_false",
-    "path": "/package/multiple_false/0.0.1",
     "title": "Multiple false",
+    "version": "0.0.1",
+    "description": "Tests that multiple can be set to false",
     "type": "integration",
-    "version": "0.0.1"
+    "download": "/epr/multiple_false/multiple_false-0.0.1.tar.gz",
+    "path": "/package/multiple_false/0.0.1"
   },
   {
-    "description": "This package does contain a dataset but not stream configs.\n",
-    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
     "name": "no_stream_configs",
-    "path": "/package/no_stream_configs/1.0.0",
     "title": "No Stream configs",
+    "version": "1.0.0",
+    "description": "This package does contain a dataset but not stream configs.\n",
     "type": "integration",
-    "version": "1.0.0"
+    "download": "/epr/no_stream_configs/no_stream_configs-1.0.0.tar.gz",
+    "path": "/package/no_stream_configs/1.0.0"
   }
 ]