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

Add Stripe connector #175

Merged
merged 5 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions registry/hasura/stripe/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Stripe Connector

## Overview

The Stripe Data Connector provides an instant adapter for Engine v3 to request Stripe resources via GraphQL. This connector is built upon the [REST connector](https://github.com/hasura/ndc-rest) and [Stripe's OpenAPI Specification](https://github.com/stripe/openapi).

- [GitHub Repository](https://github.com/hasura/ndc-stripe)

## Prerequisites

1. Create a [Hasura Cloud account](https://console.hasura.io)
2. Please ensure you have the [DDN CLI](https://hasura.io/docs/3.0/cli/installation) and
[Docker](https://docs.docker.com/engine/install/) installed
3. [Create a supergraph](https://hasura.io/docs/3.0/getting-started/init-supergraph)
4. [Create a subgraph](https://hasura.io/docs/3.0/getting-started/init-subgraph)

The steps below explain how to initialize and configure a connector on your local machine (typically for development
purposes).You can learn how to deploy a connector to Hasura DDN — after it's been configured —
[here](https://hasura.io/docs/3.0/getting-started/deployment/deploy-a-connector).

## Using the Stripe connector

With the [context set](https://hasura.io/docs/3.0/cli/commands/ddn_context_set/) for an existing subgraph, initialize
the connector by choosing `hasura/stripe`. When the wizard runs, you'll also be prompted to enter the following env
vars necessary for your connector to function.

After the CLI initializes the connector, you'll need to:

- [Introspect](https://hasura.io/docs/3.0/cli/commands/ddn_connector_introspect) the source.
- Add your [models](https://hasura.io/docs/3.0/cli/commands/ddn_model_add) and
[commands](https://hasura.io/docs/3.0/cli/commands/ddn_command_add).
- Create a [new build](https://hasura.io/docs/3.0/cli/commands/ddn_supergraph_build_local).
- Test it by [running your project along with the connector](https://hasura.io/docs/3.0/cli/commands/ddn_run#examples)

See all available variables [here](https://github.com/hasura/ndc-stripe#environment-variables).

## License

The Hasura Stripe connector is available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
1 change: 1 addition & 0 deletions registry/hasura/stripe/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions registry/hasura/stripe/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"overview": {
"namespace": "hasura",
"description": "The Stripe Data Connector provides an instant adapter for Engine v3 to request Stripe resources via GraphQL",
"title": "Stripe Data Connector",
"logo": "logo.svg",
"tags": [],
"latest_version": "v0.2.3"
},
"author": {
"support_email": "[email protected]",
"homepage": "https://hasura.io",
"name": "Hasura"
},
"is_verified": true,
"is_hosted_by_hasura": true,
"source_code": {
"is_open_source": true,
"repository": "https://github.com/hasura/ndc-stripe",
"version": [
{
"tag": "v0.2.3",
"hash": "71956bc9cc3eb1c08c0f22441a8c9d106dc6cea8",
"is_verified": true
}
]
}
}
11 changes: 11 additions & 0 deletions registry/hasura/stripe/releases/v0.2.3/connector-packaging.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "v0.2.3",
"uri": "https://github.com/hasura/ndc-stripe/releases/download/v0.2.3/connector-definition.tgz",
"checksum": {
"type": "sha256",
"value": "01c3b462cfc89e78cbf72f8713c59c67d2c13b3054a16f39a584e293bee6ab10"
},
"source": {
"hash": "71956bc9cc3eb1c08c0f22441a8c9d106dc6cea8"
}
}
Loading