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: Add an extensible API for stream schema sources #2746

Open
edgarrmondragon opened this issue Nov 7, 2024 · 0 comments
Open

feat: Add an extensible API for stream schema sources #2746

edgarrmondragon opened this issue Nov 7, 2024 · 0 comments
Assignees
Labels
kind/Feature New feature or request valuestream/SDK

Comments

@edgarrmondragon
Copy link
Collaborator

edgarrmondragon commented Nov 7, 2024

Feature scope

Taps (catalog, state, tests, etc.)

Description

With #2743 and eventual removal of support for schema file paths in constructors, we'll be on the path to support a better public API for arbitrary schema sources that prevents users from reinventing the wheel.

An example of how this might look:

openapi_schema = OpenAPISchema("https://.../openapi.json")  # might also accept a 'Traversable' importlib.resources object

class ProjectsStream(RESTStream):
    name = "projects"
    path = "/projects"
    schema_source = openapi_schema("ProjectListItem")  # a JSON Schema ref

Related:

@edgarrmondragon edgarrmondragon self-assigned this Nov 7, 2024
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