Skip to content
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.

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

feat: Support using JSON Schema's deprecated keyword to mark deprecated settings #2116

Open
edgarrmondragon opened this issue Dec 18, 2023 · 0 comments
Labels
kind/Feature New feature or request valuestream/SDK
Milestone

Comments

@edgarrmondragon
Copy link
Collaborator

edgarrmondragon commented Dec 18, 2023

Feature scope

Configuration (settings parsing, validation, etc.)

Description

sdk/singer_sdk/typing.py

Lines 520 to 530 in 40b6333

def __init__(
self,
name: str,
wrapped: JSONTypeHelper[T] | type[JSONTypeHelper[T]],
required: bool = False, # noqa: FBT001, FBT002
default: T | None = None,
description: str | None = None,
secret: bool | None = False, # noqa: FBT002
allowed_values: list[T] | None = None,
examples: list[T] | None = None,
) -> None:

is the place where this change would need to be applied. Also, this would be a great opportunity to add kwargs to that init method that are directly passed to the generated type dict.

This would be even better if paired with python-jsonschema/jsonschema#1170, as well as Hub and Meltano support.

References:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/Feature New feature or request valuestream/SDK
Projects
None yet
Development

No branches or pull requests

1 participant