[CSP-2182] add schema generator to connector utils #29
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
…rry/CSP-2182/add-schema-generator-to-connector-utils
Kalininator
reviewed
Mar 18, 2020
README.md
Outdated
| | keys | <code>Object</code> | The keys that you wish to extract from the schema with any override values. | | ||
| | operation | <code>String</code> | The name of the connector operation that you are generating the schema for. | | ||
|
|
||
| For more information on how to use the schema generator, please see the [notion page](https://www.notion.so/trayio/Schema-Generation-42f5e57341d1473c9a61b9b0e57b31db). |
There was a problem hiding this comment.
wondering if its a good idea to be making the repo docs dependent on notion links?
we could put the rest of the docs in a separate .md file in the repo instead of in notion and link it, kinda like how the raw http docs are separate in falafel repo
There was a problem hiding this comment.
Yeah, I was uncomfortable doing that.
I'll link to a new md file as you suggest.
alexburley
reviewed
Mar 18, 2020
alexburley
reviewed
Mar 18, 2020
lib/generateInputSchema.js
Outdated
| // eslint-disable-next-line no-console | ||
| console.warn(MISSING_KEYS_MESSAGE); | ||
| } | ||
| // eslint-disable-next-line no-console |
There was a problem hiding this comment.
Might as well ignore this in the entire file
|
|
||
| /** | ||
| * Deep recursive iteration through a full schema object definition. | ||
| * Returns a flat array of objects specifying the missing keys. |
There was a problem hiding this comment.
Do we need JSDOC if we aren't actually exposing this publicly?
There was a problem hiding this comment.
I did wonder that myself. Removed.
lib/index.js
Outdated
| @@ -38,24 +39,29 @@ module.exports = { | |||
| }, | |||
| deepMap: { | |||
| deepMapKeys: (collection, iteratee) => { | |||
| // eslint-disable-next-line no-console | |||
There was a problem hiding this comment.
Might as well ignore this in entire file
alexburley
suggested changes
Mar 19, 2020
…rry/CSP-2182/add-schema-generator-to-connector-utils
alexburley
approved these changes
Mar 27, 2020
Kalininator
approved these changes
Mar 27, 2020
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.
Added schema generation helper to utils.
Jira ticket: CSP-2182.
There should be enough info in the README and the notion page to see what this is all about.