Add the /manifest_template endpoint to return a string representation of the manifest template #19367
Conversation
| http_method: "GET" | ||
| authenticator: | ||
| type: BearerAuthenticator | ||
| api_token: "{{ config['api_key'] }}" |
There was a problem hiding this comment.
As mentioned. In the generator this is defined as /{{ config['api_key'] }} because we need to escape the template so that the template generator doesn't fill this with anything. We want the {{ }} to actually be present in the file. But for the server version, we don't need to escape anything
There was a problem hiding this comment.
One way that you could reduce the duplication here would be to have a shared python method which takes in arguments for the api_token value and the spec title value, and returns this string with those arguments inserted. Then this method could call it and pass in the api_token without the slash, and the generator could call it and pass in the api_token with the slash, etc.
There was a problem hiding this comment.
hmm yeah that sounds like it could work, but I might table that type of change for the future, I don't think its necessarily critical to keep things perfectly in sync in V0. And we could have some thorny edges trying to read the YAML template from airbyte-integrations/connector-templates/source-configuration-based/source_{{snakeCase name}}/{{snakeCase name}}.yaml.hbs across python packages 😅
| spec: | ||
| documentation_url: https://docsurl.com | ||
| connection_specification: | ||
| title: Source Name Spec # 'TODO: Replace this with the name of your source.' |
There was a problem hiding this comment.
this used to be {{capitalCase name}} in the generator. But it could be misleading for a developer thinking it should be interpolated when its not supposed to be.
… of the manifest template (#19367) * return a string representation of the manifest template * get rid of extra template * add a comment
What
The UI needs to display the default manifest template the first time a developer enters the connector builder UI. This is just a flat string which will then be rendered by the UI. It includes indentation spaces and
\ncharacters.How
Just returns a flat string. It is a little bit annoying that we have the template mostly duplicated in the generator and in the connector builder server, but there are a few slight changes between the files. One example is we need to escape the interpolation block in the generator version. But in the connector server one, we don't need to.
Recommended reading order
default_api.py