Skip to content

Add requires field to package manifest output #1612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
teresaromero merged 4 commits into from
Mar 10, 2026
Merged

Add requires field to package manifest output #1612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38b5716
fix test package
teresaromero Mar 10, 2026
2c54c39
Add package requirements support
teresaromero Mar 10, 2026
f8f143e
Update changelog to reference PR #1612
teresaromero Mar 10, 2026
1e5ecd0
Added `validate:"required"` tags to the `Package` and `Version` field…
teresaromero Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

* Add `requires` field to package index and search responses so clients can inspect package dependencies (input and content) before downloading. [#1612](https://github.com/elastic/package-registry/pull/1612)
* Support for referencing inputs and streams by `package`: `type` (for inputs) and `input` (for streams) are no longer required when `package` is set (format_version 3.6.0+, aligns with package-spec and composable packages). [#1605](https://github.com/elastic/package-registry/pull/1605)
* Sort packages by semver when searching, after existing title sorting. [#1585](https://github.com/elastic/package-registry/pull/1585)

Expand Down
13 changes: 13 additions & 0 deletions packages/package.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,18 @@ type Package struct {

type FileSystemBuilder func(*Package) (PackageFileSystem, error)

// PackageRequirement defines a dependency on another package (input or content).
type PackageRequirement struct {
Package string `config:"package" json:"package" yaml:"package" validate:"required"`
Version string `config:"version" json:"version" yaml:"version" validate:"required"`
}

// PackageRequirements holds package dependencies from the manifest requires field.
type PackageRequirements struct {
Input []PackageRequirement `config:"input,omitempty" json:"input,omitempty" yaml:"input,omitempty"`
Content []PackageRequirement `config:"content,omitempty" json:"content,omitempty" yaml:"content,omitempty"`
}

// BasePackage is used for the output of the package info in the /search endpoint
type BasePackage struct {
Name string `config:"name" json:"name"`
Expand All @@ -83,6 +95,7 @@ type BasePackage struct {
Discovery *Discovery `config:"discovery,omitempty" json:"discovery,omitempty,omitzero" yaml:"discovery,omitempty"`
BaseDataStreams []*BaseDataStream `config:"data_streams,omitempty" json:"data_streams,omitempty" yaml:"data_streams,omitempty"`
Deprecated *Deprecated `config:"deprecated,omitempty" json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
Requires *PackageRequirements `config:"requires,omitempty" json:"requires,omitempty" yaml:"requires,omitempty"`
}

// BasePolicyTemplate is used for the package policy templates in the /search endpoint
Expand Down
17 changes: 17 additions & 0 deletions packages/testdata/marshaler/packages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3006,6 +3006,14 @@
"categories": [
"custom"
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
},
"format_version": "3.6.0",
"readme": "/package/package_reference/0.1.0/docs/README.md",
"license": "basic",
Expand Down Expand Up @@ -3046,10 +3054,19 @@
"categories": [
"custom"
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
},
"format_version": "3.6.0",
"readme": "/package/package_reference_stream/0.1.0/docs/README.md",
"license": "basic",
"assets": [
"/package/package_reference_stream/0.1.0/changelog.yml",
"/package/package_reference_stream/0.1.0/manifest.yml",
"/package/package_reference_stream/0.1.0/docs/README.md",
"/package/package_reference_stream/0.1.0/data_stream/valid_stream/manifest.yml",
Expand Down
8 changes: 8 additions & 0 deletions testdata/generated/package/package_reference/0.1.0/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@
"categories": [
"custom"
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
},
"format_version": "3.6.0",
"readme": "/package/package_reference/0.1.0/docs/README.md",
"license": "basic",
Expand Down
9 changes: 9 additions & 0 deletions testdata/generated/package/package_reference_stream/0.1.0/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,19 @@
"categories": [
"custom"
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
},
"format_version": "3.6.0",
"readme": "/package/package_reference_stream/0.1.0/docs/README.md",
"license": "basic",
"assets": [
"/package/package_reference_stream/0.1.0/changelog.yml",
"/package/package_reference_stream/0.1.0/manifest.yml",
"/package/package_reference_stream/0.1.0/docs/README.md",
"/package/package_reference_stream/0.1.0/data_stream/valid_stream/manifest.yml",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-all-proxy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1303,7 +1303,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1327,7 +1335,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-all.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1264,7 +1264,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1288,7 +1296,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-category-custom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -722,7 +730,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-just-latest-proxy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,7 +1080,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1104,7 +1112,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
10 changes: 9 additions & 1 deletion testdata/generated/search-kibana652.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "sql_input",
Expand Down
10 changes: 9 additions & 1 deletion testdata/generated/search-kibana721.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
10 changes: 9 additions & 1 deletion testdata/generated/search-kibana800.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "sql_input",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-package-experimental.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1093,7 +1101,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-package-internal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,7 +1041,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1065,7 +1073,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
20 changes: 18 additions & 2 deletions testdata/generated/search-package-prerelease.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1077,7 +1077,15 @@
},
"categories": [
"custom"
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "package_reference_stream",
Expand All @@ -1101,7 +1109,15 @@
"dataset": "package_reference_stream.valid_stream",
"title": "Package Reference Stream"
}
]
],
"requires": {
"input": [
{
"package": "sql_input",
"version": "0.2.0"
}
]
}
},
{
"name": "reference",
Expand Down
Loading