Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
43 changes: 0 additions & 43 deletions .github/workflows/generate-graphql-docs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
"prettier": "^3.0.3",
"protoc-gen-js": "^3.21.2",
"react": "^18.2.0",
"spectaql": "^2.3.0",
"spectaql": "^3.0.9",
"tiny-secp256k1": "^2.2.3",
"tree-kill": "^1.2.2",
"ts-node": "^10.9.1",
Expand Down
13 changes: 6 additions & 7 deletions spectaql/TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Lightning Integration

## Overview
The staging API endpoint is: `https://api.staging.galoy.io/graphql`
Production API endpoint: `https://api.flashapp.me/graphql`
Test API endpoint: `https://api.test.flashapp.me/graphql`

Use the test environment for integration development; phone numbers and
balances there are separate from production.

## Authentication
To get a new JWT:
Expand All @@ -16,7 +20,7 @@ All other methods require a valid JWT set in the header as a bearer token - `Aut

#### query
```bash
export URI=https://api.staging.galoy.io/graphql
export URI=https://api.test.flashapp.me/graphql
export PHONE='+12025550148'
curl --location --request POST $URI --header 'Content-Type: application/json' --data-raw '{"query":"mutation userRequestAuthCode ($input: UserRequestAuthCodeInput!) {\n userRequestAuthCode (input: $input) {\n errors {\n message\n path\n }\n success\n }\n}","variables":{"input":{"phone":"'"$PHONE"'"}}}'
```
Expand Down Expand Up @@ -122,8 +126,3 @@ curl --location --request POST $URI --header "$AUTH_TOKEN" --header 'Content-Typ
}
```

## Extra Resources

If you use Postman, we have a collection you can import to test the API.

Download it here: [galoy_graphql_main_api.postman_collection.json](https://github.com/GaloyMoney/galoy/tree/main/src/graphql/docs/galoy_graphql_main_api.postman_collection.json)
17 changes: 10 additions & 7 deletions spectaql/spectaql-config-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,22 @@ introspection:
schemaFile: ./src/graphql/public/schema.graphql

info:
title: GraphQL API Reference
description: Welcome to the Galoy API reference!
title: Flash GraphQL API Reference
description: Complete reference for the Flash GraphQL API — every query, mutation, and type, generated from the live schema. For guides and getting started, see https://docs.flashapp.me.
contact:
name: Galoy developer community
url: https://chat.galoy.io/
name: Flash
url: https://getflash.io/
license:
name: MIT
url: https://opensource.org/licenses/MIT
x-introItems:
- title: Galoy API Tutorial
- title: Flash API Tutorial
description: #@ data.read("TUTORIAL.md")

servers:
- url: https://api.staging.galoy.io/graphql
description: Testnet
- url: https://api.flashapp.me/graphql
description: Production (mainnet)
production: true
- url: https://api.test.flashapp.me/graphql
description: Test environment
production: false
Loading
Loading