-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
API spec v0.2.0 #479
API spec v0.2.0 #479
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adds the ability to create sources, and update a source's default imageVersion
why just source and not destination?
Just commenting, because I feel like I'm missing an important piece here, which is what will be calling create
/ update
. Definitely don't need you to implement it yet, but a few sentences explaining what you have in mind would be helpful so I have a better idea of how this will be used.
@@ -1458,4 +1512,4 @@ components: | |||
InvalidInput: | |||
description: Invalid Input | |||
security: | |||
- {} | |||
- { } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ij formatting, removed
@@ -121,6 +121,48 @@ paths: | |||
description: Workspace not found | |||
"422": | |||
$ref: "#/components/responses/InvalidInput" | |||
/v1/sources/create: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is calling this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to make sure we are fully aligned on the terminology:
does it mean we will call source-connector: source?
does it mean we will call destination-connector: destination?
Challenging it: why don't we call it connector (with an enum type to distinguish between source and destination)?
@@ -895,21 +967,15 @@ components: | |||
items: | |||
$ref: "#/components/schemas/SourceRead" | |||
# SOURCE SPECIFICATION | |||
SourceSpecificationId: | |||
type: string | |||
format: uuid | |||
SourceSpecification: | |||
description: The specification for what values are required to configure the source. | |||
example: { user: { type: string } } | |||
SourceSpecificationRead: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will the specification now read from the spec method on each docker image?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is the idea, but it doesn't have to happen in strict lockstep with this change.
@cgardens the create endpoint will be called from this screen in the current mockups |
We'll be able to change a destination's version but not add a new destination since we only support one destination rn. |
initial PR did not have destination update endpoint, added now. |
type: object | ||
required: | ||
- name | ||
- defaultDockerRepository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is it called default?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
future-proofing to allow specific connector instances to diverge from the global default version
What
in the future, specs will be retrieved based on a (source/dest ID, source/dest version) tuple or a dedicated ID representing that tuple. But right now since there is no explicit versioning registry, we always use the source/destination's default image version.
If this looks good I'll go ahead and start editing the "inner" schemas behind the scenes