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

🎉 Tool for generation catalog schema from OpenAPI definition file #5734

Merged
merged 2 commits into from
Sep 1, 2021

Conversation

avida
Copy link
Contributor

@avida avida commented Aug 30, 2021

What

Resolves #2652

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added the CDK Connector Development Kit label Aug 30, 2021
@avida avida force-pushed the drezchykov/2652-catalog-json-schema-gen-tool branch from 658cd3e to c36fdd5 Compare August 30, 2021 13:37
@github-actions github-actions bot removed the CDK Connector Development Kit label Aug 30, 2021
@avida avida changed the title Drezchykov/2652 catalog json schema gen tool Tool for generation catalog schema from OpenAPI definition file Aug 30, 2021
@avida avida force-pushed the drezchykov/2652-catalog-json-schema-gen-tool branch from c36fdd5 to 9479a19 Compare August 30, 2021 14:30
@avida avida requested a review from sherifnada August 31, 2021 06:27
@avida avida force-pushed the drezchykov/2652-catalog-json-schema-gen-tool branch from 9479a19 to cf14615 Compare August 31, 2021 08:27
Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I have a couple of more requests to make this easily consumable by an Airbyte user.

  1. Can you add a note in the CDK docs advertising this tool maybe here. Something like a section which says that you can use this tool.
  2. Can you add some files to this directory tools/openapi2jsonschema/examples which are an example of generated files? e.g:
examples/
  stripe-api/
    stripe-openapi-spec.json
    transactions.json
    ...

exit
}

docker images | grep "$IMG_TAG" > /dev/null || {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love the lazy instantiation here

@avida avida force-pushed the drezchykov/2652-catalog-json-schema-gen-tool branch from cf14615 to c88ba23 Compare September 1, 2021 08:09
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 1, 2021
@avida avida closed this Sep 1, 2021
@sherifnada sherifnada reopened this Sep 1, 2021
@avida avida changed the title Tool for generation catalog schema from OpenAPI definition file 🎉 Tool for generation catalog schema from OpenAPI definition file Sep 1, 2021
@avida avida merged commit 8d2cd1e into master Sep 1, 2021
@avida avida deleted the drezchykov/2652-catalog-json-schema-gen-tool branch September 1, 2021 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CDK: Generate HTTP stream catalog from OpenAPI spec
5 participants