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

feat: Build Airbyte Protocol js-schema files for use in schemastore #64

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

evantahler
Copy link
Contributor

@evantahler evantahler commented Feb 2, 2024

This pr adds the creation of both 'latest' and versioned JS versions of the Airbyte Protocol for use with https://www.schemastore.org.

  1. New utilities that produce JS versions of the protocol at the below paths. We want to keep these files in the main branch of this repository for easy access. The docker command wraps the node command to run on GHA. Run ./protocol-models/bin/generate-schemastore-docker.sh locally to try it
    • /airbyte-protocol/jsonschema/latest/airbyte_protocol.json
    • /airbyte-protocol/jsonschema/{version}/airbyte_protocol.json
  2. pull-request-publish will run this new command when the bot creates a new PR (e.g.) for a version bump. This lets the PR reviewer see the changes, and we won't be writing directly to the main branch of the repo.

These changes in aggregate allow for a simple default schematore entry (e.g.) with the following content, once we merge this:

    {
      "name": "Airbyte Protocol definition",
      "description": "JSON schema for Airbyte Protocol",
      "fileMatch": [
        "airbyte_protocol.yml", 
        "airbyte_protocol.yaml"
      ],
      "url": "https://github.com/airbytehq/airbyte-protocol/raw/main/airbyte-protocol/jsonschema/latest/airbyte_protocol.json"
    }

@evantahler evantahler changed the title Build Airbyte Protocol js-schema files for use in schemastore feat: Build Airbyte Protocol js-schema files for use in schemastore Feb 2, 2024
@evantahler
Copy link
Contributor Author

AJ - I totally forgot about this. Are you still interested in have SchemaStore entries for the Airbyte Protocol? I think this mostly works...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant