[Connector Builder] Set placeholder documentation_url for builder-generated spec #22340
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flash1293
approved these changes
Feb 5, 2023
There was a problem hiding this comment.
Makes sense, thanks for fixing. I'm wondering whether we should have an integration test for this path (configure something, download yaml, then make it work), but maybe it's not worth it as the end to end flow in the UI will cover it will enough once that's implemented
| @@ -636,7 +636,7 @@ export const convertToManifest = (values: BuilderFormValues): ConnectorManifest | |||
|
|
|||
| const spec: Spec = { | |||
| connection_specification: specSchema, | |||
| documentation_url: "", | |||
| documentation_url: "https://docsurl.com", | |||
There was a problem hiding this comment.
nit: What about using https://example.org/ for this? Its official purpose is to be used as an example
There was a problem hiding this comment.
I like that suggestion, will update
|
Yeah I think an E2E test to do that whole flow in the UI makes sense to add once we have the full flow implemented |
This was referenced Feb 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
See slack context: https://airbytehq-team.slack.com/archives/C03TP6W8081/p1675365814016559?thread_ts=1675198798.481999&cid=C03TP6W8081
Manifests generated by the connector builder currently do not pass integration tests and cannot be used, because they have an empty documentation_url.
This issue platform issue will handle fixing the airbyte-server to not fail in this case: #22242
But until that is complete, we should have an intermediate solution here to fix the problem in the meantime.
How
This PR addresses the issue by setting
documentation_urlin the manifest produce by the connector builder to the placeholder documentation url we have used in other connectors so far.This can be removed once #22242 is complete