Uh oh!
There was an error while loading. Please reload this page.
Mark deprecated pipeline fields - #2646
Conversation
16eaf6a to
75b7155CompareUh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| "target": | ||
| # should not be marked as deprecated until its possible to switch | ||
| # existing pipelines to use 'schema' instead | ||
| "deprecated": false |
There was a problem hiding this comment.
Is this set as deprecated in the annotations file already?
If not, absence of an entry means it won't be set.
There was a problem hiding this comment.
It's primarily for the case when parent file gets deprecated annotation from OpenAPI spec
| Enum []any `json:"enum,omitempty"` | ||
| MarkdownExamples string `json:"markdown_examples,omitempty"` | ||
| DeprecationMessage string `json:"deprecation_message,omitempty"` | ||
| Deprecated bool `json:"deprecated,omitempty"` |
There was a problem hiding this comment.
This is duplicated in #2652. What's the sequence of merging you're thinking of?
There was a problem hiding this comment.
It doesn't matter much, because we can rebase one PR on another. This PR is more important, I feel it will take time to review all deprecations introduced in #2652
| } | ||
| if a.Deprecated { | ||
| s.Deprecated = true | ||
| } |
There was a problem hiding this comment.
Please define what happens if Deprecated == false and DeprecationMessage != "".
This seems confusing. Alternatively, we can exclusively use the message field for this.
cc @ilyakuz-db
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
kanterov
commented
Apr 8, 2025
@pietern does it look good now? we need an approval for code owners |
Update JSON schema for pipelines with deprecated fields. While fields have been deprecated for a long time, we have to use overrides until we propagate deprecated annotation from the OpenAPI spec. We need to manually set a deprecation message because the OpenAPI spec doesn't have such a field. A deprecation message is a part of the description that doesn't create an actionable tooltip. `target` is not marked as deprecated. While `schema` is preferred over `target`, currently, it isn't possible to update existing pipelines from using `target` to using `schema` without re-creating them. These fields should be avoided
## Release v0.247.0 ### CLI * Added include/exclude flags support to sync command ([#2650](#2650)) ### Bundles * Added support for model serving endpoints in deployment bind/unbind commands ([#2634](#2634)) * Added include/exclude flags support to bundle sync command ([#2650](#2650)) * Added JSON schema for resource permissions ([#2674](#2674)) * Removed pipeline 'deployment' field from jsonschema ([#2653](#2653)) * Updated JSON schema for deprecated pipeline fields ([#2646](#2646)) * The --config-dir and --source-dir flags for "bundle generate app" are now relative to CWD, not bundle root ([#2683](#2683)) * Reverts [#2549](#2549) to resolve issues with Web Terminal host mismatch ([#2685](#2685))
## Changes Update JSON schema for pipelines with deprecated fields. While fields have been deprecated for a long time, we have to use overrides until we propagate deprecated annotation from the OpenAPI spec. We need to manually set a deprecation message because the OpenAPI spec doesn't have such a field. A deprecation message is a part of the description that doesn't create an actionable tooltip. `target` is not marked as deprecated. While `schema` is preferred over `target`, currently, it isn't possible to update existing pipelines from using `target` to using `schema` without re-creating them. ## Why These fields should be avoided
## Release v0.247.0 ### CLI * Added include/exclude flags support to sync command ([#2650](#2650)) ### Bundles * Added support for model serving endpoints in deployment bind/unbind commands ([#2634](#2634)) * Added include/exclude flags support to bundle sync command ([#2650](#2650)) * Added JSON schema for resource permissions ([#2674](#2674)) * Removed pipeline 'deployment' field from jsonschema ([#2653](#2653)) * Updated JSON schema for deprecated pipeline fields ([#2646](#2646)) * The --config-dir and --source-dir flags for "bundle generate app" are now relative to CWD, not bundle root ([#2683](#2683)) * Reverts [#2549](#2549) to resolve issues with Web Terminal host mismatch ([#2685](#2685))
Changes
Update JSON schema for pipelines with deprecated fields.
While fields have been deprecated for a long time, we have to use overrides until we propagate deprecated annotation from the OpenAPI spec.
We need to manually set a deprecation message because the OpenAPI spec doesn't have such a field. A deprecation message is a part of the description that doesn't create an actionable tooltip.
targetis not marked as deprecated. Whileschemais preferred overtarget, currently, it isn't possible to update existing pipelines from usingtargetto usingschemawithout re-creating them.Why
These fields should be avoided