Rename image src to path and have src as the original value from the … #629
Conversation
|
@ycombinator This addresses the most urgent issue that we overwrite variables from the manifest. A follow up discussion is needed on what convention we follow for naming the different fields and standardise on from where the path is relative. I picked |
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
|
|
@jfsiii This is a breaking change for Kibana. Do you see a way to potentially support both options for a while. Something like if |
|
@ruflin yes, I believe that's right. I created elastic/kibana#76380 to track it. I'll leave for you & @ph to prioritize but it should ™️ be a quick & safe change Could you add the new |
|
I added the path in the openapi spec, thanks for the reminder. For my own reference: Here the PR to test this with: elastic/kibana#76434 |
| @@ -107,6 +107,7 @@ type Owner struct { | |||
|
|
|||
| type Image struct { | |||
| Src string `config:"src" json:"src" validate:"required"` | |||
| Path string `config:"path" json:"path"` | |||
There was a problem hiding this comment.
Does this change need a dependency update in integrations repository? Same question for package-storage.
There was a problem hiding this comment.
I don't think so as this only changes the output generated by the registry and nothing on the package side itself. Anything specific you were thinking of?
There was a problem hiding this comment.
I was thinking about the case in which the Kibana expects the missing property.
There was a problem hiding this comment.
This should be solved by elastic/kibana#76434
…manifest All the configs specified in the manifest file by the user should be exposed without changes in our JSON output. In the case of images, the src was overwritten by the path variable. This means what was in the manifest and outputted by JSON was not a 1:1 match. It is ok to add additional fields in the JSON output but the original fields should never be touched. This is a breaking change and need adjustements in Kibana.
ruflin
force-pushed
the
fix-src-path
branch
from
623e021 to
b063322
Compare
|
Tested again with 7.10.0-SNAPSHOT of Kibana and seems to work as expected. |
…manifest
All the configs specified in the manifest file by the user should be exposed without changes in our JSON output. In the case of images, the src was overwritten by the path variable. This means what was in the manifest and outputted by JSON was not a 1:1 match.
It is ok to add additional fields in the JSON output but the original fields should never be touched.
This is a breaking change and need adjustements in Kibana.