From c0460aeb460be8a3f64376841daad505adce3168 Mon Sep 17 00:00:00 2001 From: Alex Lakatos Date: Sat, 16 Sep 2023 13:41:28 +0100 Subject: [PATCH] feat(docs): add astro-graphql-plugin to the documentation (#1814) * Add astro-graphql-plugin * fix implementedBy links * fix sidebar highlighting twice * Update .prettierignore * remove generated schema MDX * remove generated graphql docs * add generated docs content folder to .gitignore * update astro plugin version to use the new build:start hook * I don't really know what this does, but magic * I learned to read comments, Max said to remove this step * Update pnpm-lock.yaml * Update index.mdx --- .github/workflows/lint_test_build.yml | 16 - .prettierignore | 3 +- packages/documentation/.gitignore | 6 +- packages/documentation/astro.config.mjs | 31 +- packages/documentation/package.json | 6 +- .../src/content/docs/apis/auth/enums.md | 67 - .../content/docs/apis/auth/inputObjects.md | 99 - .../src/content/docs/apis/auth/interfaces.md | 79 - .../src/content/docs/apis/auth/mutations.md | 28 - .../src/content/docs/apis/auth/objects.md | 367 -- .../src/content/docs/apis/auth/queries.md | 87 - .../src/content/docs/apis/auth/scalars.md | 25 - .../src/content/docs/apis/auth/schema.mdx | 837 --- .../src/content/docs/apis/backend/enums.md | 269 - .../content/docs/apis/backend/inputObjects.md | 1280 ---- .../content/docs/apis/backend/interfaces.md | 150 - .../content/docs/apis/backend/mutations.md | 557 -- .../src/content/docs/apis/backend/objects.md | 2558 -------- .../src/content/docs/apis/backend/queries.md | 411 -- .../src/content/docs/apis/backend/scalars.md | 31 - .../src/content/docs/apis/backend/schema.mdx | 5333 ----------------- .../documentation/src/content/docs/index.mdx | 4 +- pnpm-lock.yaml | 109 +- 23 files changed, 75 insertions(+), 12278 deletions(-) delete mode 100644 packages/documentation/src/content/docs/apis/auth/enums.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/inputObjects.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/interfaces.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/mutations.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/objects.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/queries.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/scalars.md delete mode 100644 packages/documentation/src/content/docs/apis/auth/schema.mdx delete mode 100644 packages/documentation/src/content/docs/apis/backend/enums.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/inputObjects.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/interfaces.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/mutations.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/objects.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/queries.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/scalars.md delete mode 100644 packages/documentation/src/content/docs/apis/backend/schema.mdx diff --git a/.github/workflows/lint_test_build.yml b/.github/workflows/lint_test_build.yml index 8deb35c708..7a0298df93 100644 --- a/.github/workflows/lint_test_build.yml +++ b/.github/workflows/lint_test_build.yml @@ -41,22 +41,6 @@ jobs: if: steps.verify-changed-files.outputs.files_changed == 'true' run: exit 1 - documentation: - runs-on: ubuntu-22.04 - needs: checkout - steps: - - uses: actions/checkout@v4 - - uses: ./.github/workflows/rafiki/env-setup - - name: generate graphql api documentation - run: pnpm --filter documentation docs:graphql:generate && pnpm format - - name: verify changed files - uses: tj-actions/verify-changed-files@v16 - id: verify-changed-files - - - name: fail if docs were generated - if: steps.verify-changed-files.outputs.files_changed == 'true' - run: exit 1 - backend: runs-on: ubuntu-22.04 needs: [checkout] diff --git a/.prettierignore b/.prettierignore index 2da30231a9..f22c7b4a51 100644 --- a/.prettierignore +++ b/.prettierignore @@ -15,4 +15,5 @@ build .docusaurus .cache-loader postman -.postman \ No newline at end of file +.postman +packages/documentation/src/content/docs/apis \ No newline at end of file diff --git a/packages/documentation/.gitignore b/packages/documentation/.gitignore index 5592971a41..2391c5f59b 100644 --- a/packages/documentation/.gitignore +++ b/packages/documentation/.gitignore @@ -1,8 +1,13 @@ # build output dist/ + # generated types .astro/ +# generated docs +src/content/docs/apis/auth/* +src/content/docs/apis/backend/* + # dependencies node_modules/ @@ -12,7 +17,6 @@ yarn-debug.log* yarn-error.log* pnpm-debug.log* - # environment variables .env .env.production diff --git a/packages/documentation/astro.config.mjs b/packages/documentation/astro.config.mjs index 4be24d6d0f..386aec4666 100644 --- a/packages/documentation/astro.config.mjs +++ b/packages/documentation/astro.config.mjs @@ -6,6 +6,7 @@ import react from '@astrojs/react' import remarkMath from 'remark-math' import rehypeMathjax from 'rehype-mathjax' +import GraphQL from 'astro-graphql-plugin' // https://astro.build/config export default defineConfig({ @@ -153,28 +154,32 @@ export default defineConfig({ { label: 'Backend Admin API', collapsed: true, - items: [ - { - label: 'Schema types', - link: 'apis/backend/schema/' - } - ] + autogenerate: { + directory: 'apis/backend' + } }, { label: 'Auth Admin API', collapsed: true, - items: [ - { - label: 'Schema types', - link: 'apis/auth/schema/' - } - ] + autogenerate: { + directory: 'apis/auth' + } } ] } ] }), - react() + react(), + GraphQL({ + schema: '../backend/src/graphql/schema.graphql', + output: './src/content/docs/apis/backend/', + linkPrefix: '/apis/backend/' + }), + GraphQL({ + schema: '../auth/src/graphql/schema.graphql', + output: './src/content/docs/apis/auth/', + linkPrefix: '/apis/auth/' + }) ], // Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp image: { diff --git a/packages/documentation/package.json b/packages/documentation/package.json index dc8df4015d..179eb9d703 100644 --- a/packages/documentation/package.json +++ b/packages/documentation/package.json @@ -6,9 +6,7 @@ "start": "astro dev", "build": "astro build", "preview": "astro preview", - "astro": "astro", - "docs:graphql:generate:backend": "./node_modules/.bin/graphql-markdown ../backend/src/graphql/schema.graphql > src/schema-dumps/backend_raw_schema.md", - "docs:graphql:generate:auth": "./node_modules/.bin/graphql-markdown ../auth/src/graphql/schema.graphql > src/schema-dumps/auth_raw_schema.md" + "astro": "astro" }, "dependencies": { "@astrojs/react": "^2.3.2", @@ -16,8 +14,8 @@ "@types/react": "^18.2.21", "@types/react-dom": "^18.2.7", "astro": "2.10.15", + "astro-graphql-plugin": "^0.0.7", "graphql": "^16.8.0", - "graphql-markdown": "^7.0.0", "react": "^18.2.0", "react-dom": "^18.2.0", "rehype-mathjax": "^4.0.3", diff --git a/packages/documentation/src/content/docs/apis/auth/enums.md b/packages/documentation/src/content/docs/apis/auth/enums.md deleted file mode 100644 index 3284c1b805..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/enums.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Enums ---- - - - -## GrantFinalization - -

Values

- - - - - - - - - - - - - - - - - -
ValueDescription
ISSUED -

grant was issued

-
REVOKED -

grant was revoked

-
REJECTED -

grant was rejected

-
- -## GrantState - -

Values

- - - - - - - - - - - - - - - - - - - - - -
ValueDescription
PROCESSING -

grant request is determining what state to enter next

-
PENDING -

grant request is awaiting interaction

-
APPROVED -

grant was approved

-
FINALIZED -

grant was finalized and no more access tokens or interactions can be made on it

-
diff --git a/packages/documentation/src/content/docs/apis/auth/inputObjects.md b/packages/documentation/src/content/docs/apis/auth/inputObjects.md deleted file mode 100644 index c4c18d743a..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/inputObjects.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: Input objects ---- - - - -## FilterGrantState - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-in
-[GrantState!] -		 - -
-notIn
-[GrantState!] -		 - -
- -## FilterString - -

Arguments

- - - - - - - - - -
NameDescription
-in
-[String!] -		 - -
- -## GrantFilter - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-identifier
-FilterString -		 - -
-state
-FilterGrantState -		 - -
- -## RevokeGrantInput - -

Arguments

- - - - - - - - - -
NameDescription
-grantId
-String! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/auth/interfaces.md b/packages/documentation/src/content/docs/apis/auth/interfaces.md deleted file mode 100644 index 8fc1a3fa11..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/interfaces.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Interfaces ---- - - - -## Model - -

Implemented by

- -- [Grant](objects#grant) -- [Access](objects#access) - -

Fields

- - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 - -
-createdAt
-String! -		 - -
- -## MutationResponse - -

Implemented by

- -- [RevokeGrantMutationResponse](objects#revokegrantmutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/auth/mutations.md b/packages/documentation/src/content/docs/apis/auth/mutations.md deleted file mode 100644 index 13a7ec4d2a..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/mutations.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Mutations ---- - - - -## revokeGrant - -**Type:** [RevokeGrantMutationResponse!](objects#revokegrantmutationresponse) - -Revoke Grant - -

Arguments

- - - - - - - - - -
NameDescription
-input
-RevokeGrantInput! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/auth/objects.md b/packages/documentation/src/content/docs/apis/auth/objects.md deleted file mode 100644 index 64a7d1627f..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/objects.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -title: Objects ---- - - - -## Access - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Access id

-
-identifier
-String -		 -

Payment pointer of a sub-resource (incoming payment, outgoing payment, or quote)

-
-type
-String! -		 -

Access type (incoming payment, outgoing payment, or quote)

-
-actions
-[String]! -		 -

Access action (create, read, list or complete)

-
-limits
-LimitData -		 -

Payment limits

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## Grant - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Grant id

-
-client
-String! -		 -

Payment pointer of the grantee's account

-
-access
-[Access!]! -		 -

Access details

-
-state
-GrantState! -		 -

State of the grant

-
-finalizationReason
-GrantFinalization -		 -

Reason a grant was finalized

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## GrantEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-Grant! -		 - -
-cursor
-String! -		 - -
- -## GrantsConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[GrantEdge!]! -		 - -
- -## LimitData - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-receiver
-String -		 -

Payment pointer URL of the receiver

-
-sendAmount
-PaymentAmount -		 -

Amount to send

-
-receiveAmount
-PaymentAmount -		 -

Amount to receive

-
-interval
-String -		 -

Interval between payments

-
- -## PageInfo - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-endCursor
-String -		 -

Paginating forwards: the cursor to continue.

-
-hasNextPage
-Boolean! -		 -

Paginating forwards: Are there more pages?

-
-hasPreviousPage
-Boolean! -		 -

Paginating backwards: Are there more pages?

-
-startCursor
-String -		 -

Paginating backwards: the cursor to continue.

-
- -## PaymentAmount - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-value
-UInt64! -		 - -
-assetCode
-String! -		 -

ISO 4217 currency code, e.g. USD

-
-assetScale
-UInt8! -		 -

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

-
- -## RevokeGrantMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/auth/queries.md b/packages/documentation/src/content/docs/apis/auth/queries.md deleted file mode 100644 index a2a50041a7..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/queries.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Queries ---- - - - -## grant - -**Type:** [Grant!](objects#grant) - -Fetch a grant - -

Arguments

- - - - - - - - - -
NameDescription
-id
-ID! -		 - -
- -## grants - -**Type:** [GrantsConnection!](objects#grantsconnection) - -Fetch a page of grants. - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
-filter
-GrantFilter -		 -

Filter grants based on specific criteria.

-
diff --git a/packages/documentation/src/content/docs/apis/auth/scalars.md b/packages/documentation/src/content/docs/apis/auth/scalars.md deleted file mode 100644 index 2821e22958..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/scalars.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Scalars ---- - - - -## Boolean - -The `Boolean` scalar type represents `true` or `false`. - -## ID - -The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. - -## Int - -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - -## String - -The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. - -## UInt64 - -## UInt8 diff --git a/packages/documentation/src/content/docs/apis/auth/schema.mdx b/packages/documentation/src/content/docs/apis/auth/schema.mdx deleted file mode 100644 index e7bf2dc9d6..0000000000 --- a/packages/documentation/src/content/docs/apis/auth/schema.mdx +++ /dev/null @@ -1,837 +0,0 @@ ---- -title: Schema types ---- - -
- Table of Contents - -- [Query](#query) -- [Mutation](#mutation) -- [Objects](#objects) - - [Access](#access) - - [Grant](#grant) - - [GrantEdge](#grantedge) - - [GrantsConnection](#grantsconnection) - - [LimitData](#limitdata) - - [PageInfo](#pageinfo) - - [PaymentAmount](#paymentamount) - - [RevokeGrantMutationResponse](#revokegrantmutationresponse) -- [Inputs](#inputs) - - [FilterGrantState](#filtergrantstate) - - [FilterString](#filterstring) - - [GrantFilter](#grantfilter) - - [RevokeGrantInput](#revokegrantinput) -- [Enums](#enums) - - [GrantFinalization](#grantfinalization) - - [GrantState](#grantstate) -- [Scalars](#scalars) - - [Boolean](#boolean) - - [ID](#id) - - [Int](#int) - - [String](#string) - - [UInt64](#uint64) - - [UInt8](#uint8) -- [Interfaces](#interfaces) - - [Model](#model) - - [MutationResponse](#mutationresponse) - -
- -## Query - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
grantsGrantsConnection! - -Fetch a page of grants. - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
filterGrantFilter - -Filter grants based on specific criteria. - -
grantGrant! - -Fetch a grant - -
idID!
- -## Mutation - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
revokeGrantRevokeGrantMutationResponse! - -Revoke Grant - -
inputRevokeGrantInput!
- -## Objects - -### Access - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Access id - -
identifierString - -Payment pointer of a sub-resource (incoming payment, outgoing payment, or quote) - -
typeString! - -Access type (incoming payment, outgoing payment, or quote) - -
actions[String]! - -Access action (create, read, list or complete) - -
limitsLimitData - -Payment limits - -
createdAtString! - -Date-time of creation - -
- -### Grant - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Grant id - -
clientString! - -Payment pointer of the grantee's account - -
access[Access!]! - -Access details - -
stateGrantState! - -State of the grant - -
finalizationReasonGrantFinalization - -Reason a grant was finalized - -
createdAtString! - -Date-time of creation - -
- -### GrantEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - Grant! -
- cursor - - String! -
- -### GrantsConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [GrantEdge!]! -
- -### LimitData - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
receiverString - -Payment pointer URL of the receiver - -
debitAmountPaymentAmount - -Amount to send - -
receiveAmountPaymentAmount - -Amount to receive - -
intervalString - -Interval between payments - -
- -### PageInfo - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
endCursorString - -Paginating forwards: the cursor to continue. - -
hasNextPageBoolean! - -Paginating forwards: Are there more pages? - -
hasPreviousPageBoolean! - -Paginating backwards: Are there more pages? - -
startCursorString - -Paginating backwards: the cursor to continue. - -
- -### PaymentAmount - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
valueUInt64!
assetCodeString! - -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - -
assetScaleUInt8! - -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - -
- -### RevokeGrantMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- -## Inputs - -### FilterGrantState - - - - - - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- in - - [GrantState!] -
- notIn - - [GrantState!] -
- -### FilterString - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- in - - [String!] -
- -### GrantFilter - - - - - - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- identifier - - FilterString -
- state - - FilterGrantState -
- -### RevokeGrantInput - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- grantId - - String! -
- -## Enums - -### GrantFinalization - - - - - - - - - - - - - - - - - - - - -
ValueDescription
ISSUED - -grant was issued - -
REVOKED - -grant was revoked - -
REJECTED - -grant was rejected - -
- -### GrantState - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
PROCESSING - -grant request is determining what state to enter next - -
PENDING - -grant request is awaiting interaction - -
APPROVED - -grant was approved - -
FINALIZED - -grant was finalized and no more access tokens or interactions can be made on it - -
- -## Scalars - -### Boolean - -The `Boolean` scalar type represents `true` or `false`. - -### ID - -The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - -### String - -The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. - -### UInt64 - -### UInt8 - -## Interfaces - -### Model - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- id - - ID! -
- createdAt - - String! -
- -### MutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
diff --git a/packages/documentation/src/content/docs/apis/backend/enums.md b/packages/documentation/src/content/docs/apis/backend/enums.md deleted file mode 100644 index a1bb9bc444..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/enums.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: Enums ---- - - - -## Alg - -

Values

- - - - - - - - - -
ValueDescription
EdDSA - -
- -## Crv - -

Values

- - - - - - - - - -
ValueDescription
Ed25519 - -
- -## FeeType - -

Values

- - - - - - - - - - - - - -
ValueDescription
SENDING -

Sender pays the fees

-
RECEIVING -

Receiver pays the fees

-
- -## IncomingPaymentState - -

Values

- - - - - - - - - - - - - - - - - - - - - -
ValueDescription
PENDING -

The payment has a state of PENDING when it is initially created.

-
PROCESSING -

As soon as payment has started (funds have cleared into the account) the state moves to PROCESSING

-
COMPLETED -

The payment is either auto-completed once the received amount equals the expected incomingAmount, or it is completed manually via an API call.

-
EXPIRED -

If the payment expires before it is completed then the state will move to EXPIRED and no further payments will be accepted.

-
- -## Kty - -

Values

- - - - - - - - - -
ValueDescription
OKP - -
- -## LiquidityError - -

Values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
AlreadyPosted - -
AlreadyVoided - -
AmountZero - -
InsufficientBalance - -
InvalidId - -
TransferExists - -
UnknownAsset - -
UnknownIncomingPayment - -
UnknownPayment - -
UnknownPaymentPointer - -
UnknownPeer - -
UnknownTransfer - -
- -## OutgoingPaymentState - -

Values

- - - - - - - - - - - - - - - - - - - - - -
ValueDescription
FUNDING -

Will transition to SENDING once payment funds are reserved

-
SENDING -

Paying, will transition to COMPLETED on success

-
COMPLETED -

Successful completion

-
FAILED -

Payment failed

-
- -## PaymentPointerStatus - -

Values

- - - - - - - - - - - - - -
ValueDescription
INACTIVE -

Status after deactivating

-
ACTIVE -

Default status

-
- -## PaymentType - -

Values

- - - - - - - - - - - - - -
ValueDescription
INCOMING - -
OUTGOING - -
diff --git a/packages/documentation/src/content/docs/apis/backend/inputObjects.md b/packages/documentation/src/content/docs/apis/backend/inputObjects.md deleted file mode 100644 index 310f66d08e..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/inputObjects.md +++ /dev/null @@ -1,1280 +0,0 @@ ---- -title: Input objects ---- - - - -## AddAssetLiquidityInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-assetId
-String! -		 -

The id of the asset to add liquidity.

-
-amount
-UInt64! -		 -

Amount of liquidity to add.

-
-id
-String! -		 -

The id of the transfer.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## AddPeerLiquidityInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-peerId
-String! -		 -

The id of the peer to add liquidity.

-
-amount
-UInt64! -		 -

Amount of liquidity to add.

-
-id
-String! -		 -

The id of the transfer.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## AmountInput - -

Arguments

- - - - - - - - - - - - - - - - - -
NameDescription
-value
-UInt64! -		 - -
-assetCode
-String! -		 -

ISO 4217 currency code, e.g. USD

-
-assetScale
-UInt8! -		 -

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

-
- -## CreateAssetInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 -

ISO 4217 currency code, e.g. USD

-
-scale
-UInt8! -		 -

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

-
-withdrawalThreshold
-UInt64 -		 -

Minimum amount of liquidity that can be withdrawn from the asset

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreateAssetLiquidityWithdrawalInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-assetId
-String! -		 -

The id of the asset to create the withdrawal for.

-
-amount
-UInt64! -		 -

Amount of withdrawal.

-
-id
-String! -		 -

The id of the withdrawal.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreateIncomingPaymentInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerId
-String! -		 -

Id of the payment pointer under which the incoming payment will be created

-
-expiresAt
-String -		 -

Expiration date-time

-
-metadata
-JSONObject -		 -

Additional metadata associated with the incoming payment.

-
-incomingAmount
-AmountInput -		 -

Maximum amount to be received

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreateOutgoingPaymentInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerId
-String! -		 -

Id of the payment pointer under which the outgoing payment will be created

-
-quoteId
-String! -		 -

Id of the corresponding quote for that outgoing payment

-
-metadata
-JSONObject -		 -

Additional metadata associated with the outgoing payment.

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreatePaymentPointerInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-assetId
-String! -		 -

Asset of the payment pointer

-
-url
-String! -		 -

Payment Pointer URL

-
-publicName
-String -		 -

Public name associated with the payment pointer

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreatePaymentPointerKeyInput - -

Arguments

- - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerId
-String! -		 - -
-jwk
-JwkInput! -		 -

Public key

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreatePaymentPointerWithdrawalInput - -

Arguments

- - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerId
-String! -		 -

The id of the Open Payments payment pointer to create the withdrawal for.

-
-id
-String! -		 -

The id of the withdrawal.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreatePeerInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-maxPacketAmount
-UInt64 -		 -

Maximum packet amount that the peer accepts

-
-http
-HttpInput! -		 -

Peering connection details

-
-assetId
-String! -		 -

Asset id of peering relationship

-
-staticIlpAddress
-String! -		 -

Peer's ILP address

-
-name
-String -		 -

Peer's internal name

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreatePeerLiquidityWithdrawalInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-peerId
-String! -		 -

The id of the peer to create the withdrawal for.

-
-amount
-UInt64! -		 -

Amount of withdrawal.

-
-id
-String! -		 -

The id of the withdrawal.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreateQuoteInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerId
-String! -		 -

Id of the payment pointer under which the quote will be created

-
-sendAmount
-AmountInput -		 -

Amount to send (fixed send)

-
-receiveAmount
-AmountInput -		 -

Amount to receive (fixed receive)

-
-receiver
-String! -		 -

Payment pointer URL of the receiver

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## CreateReceiverInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-paymentPointerUrl
-String! -		 -

Receiving payment pointer URL

-
-expiresAt
-String -		 -

Expiration date-time

-
-incomingAmount
-AmountInput -		 -

Maximum amount to be received

-
-metadata
-JSONObject -		 -

Additional metadata associated with the incoming payment.

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## DeletePeerInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 - -
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## DepositEventLiquidityInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-eventId
-String! -		 -

The id of the event to deposit into.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## FeeDetails - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-fixed
-UInt64! -		 -

A flat fee

-
-basisPoints
-Int! -		 -

Basis points fee. Should be between 0 and 10000 (inclusive). 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100%

-
- -## FilterString - -

Arguments

- - - - - - - - - -
NameDescription
-in
-[String!]! -		 - -
- -## HttpIncomingInput - -

Arguments

- - - - - - - - - -
NameDescription
-authTokens
-[String!]! -		 -

Array of auth tokens accepted by this Rafiki instance

-
- -## HttpInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-incoming
-HttpIncomingInput -		 -

Incoming connection details

-
-outgoing
-HttpOutgoingInput! -		 -

Outgoing connection details

-
- -## HttpOutgoingInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-authToken
-String! -		 -

Auth token to present at the peering Rafiki instance

-
-endpoint
-String! -		 -

Peer's connection endpoint

-
- -## JwkInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-kid
-String! -		 -

Key id

-
-x
-String! -		 -

Base64 url-encoded public key.

-
-alg
-Alg! -		 -

Cryptographic algorithm family used with the key. The only allowed value is EdDSA.

-
-kty
-Kty! -		 -

Key type. The only allowed value is OKP.

-
-crv
-Crv! -		 -

Curve that the key pair is derived from. The only allowed value is Ed25519.

-
- -## PaymentFilter - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-type
-FilterString -		 - -
-paymentPointerId
-FilterString -		 - -
- -## PostLiquidityWithdrawalInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-withdrawalId
-String! -		 -

The id of the liquidity withdrawal to post.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## RevokePaymentPointerKeyInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-id
-String! -		 -

Internal id of key

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## SetFeeInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-assetId
-ID! -		 -

Asset id to add the fee to

-
-type
-FeeType! -		 -

Type of fee (sending or receiving)

-
-fee
-FeeDetails! -		 -

Fee values

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## TriggerPaymentPointerEventsInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-limit
-Int! -		 -

Maximum number of events being triggered (n).

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## UpdateAssetInput - -

Arguments

- - - - - - - - - - - - - - - - - -
NameDescription
-id
-String! -		 -

Asset id

-
-withdrawalThreshold
-UInt64 -		 -

New minimum amount of liquidity that can be withdrawn from the asset

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## UpdatePaymentPointerInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

ID of payment pointer to update

-
-publicName
-String -		 -

New public name for payment pointer

-
-status
-PaymentPointerStatus -		 -

New status to set the payment pointer to

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## UpdatePeerInput - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-String! -		 -

Peer id

-
-maxPacketAmount
-UInt64 -		 -

New maximum packet amount that the peer accepts

-
-http
-HttpInput -		 -

New peering connection details

-
-staticIlpAddress
-String -		 -

Peer's new ILP address

-
-name
-String -		 -

Peer's new public name

-
-idempotencyKey
-String -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## VoidLiquidityWithdrawalInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-withdrawalId
-String! -		 -

The id of the liquidity withdrawal to void.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
- -## WebhookEventFilter - -

Arguments

- - - - - - - - - -
NameDescription
-type
-FilterString -		 - -
- -## WithdrawEventLiquidityInput - -

Arguments

- - - - - - - - - - - - - -
NameDescription
-eventId
-String! -		 -

The id of the event to withdraw from.

-
-idempotencyKey
-String! -		 -

Unique key to ensure duplicate or retried requests are processed only once. See idempotence

-
diff --git a/packages/documentation/src/content/docs/apis/backend/interfaces.md b/packages/documentation/src/content/docs/apis/backend/interfaces.md deleted file mode 100644 index 3969cf2b0c..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/interfaces.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: Interfaces ---- - - - -## BasePayment - -

Implemented by

- -- [IncomingPayment](objects#incomingpayment) -- [OutgoingPayment](objects#outgoingpayment) -- [Payment](objects#payment) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 - -
-paymentPointerId
-ID! -		 - -
-metadata
-JSONObject -		 - -
-createdAt
-String! -		 - -
- -## Model - -

Implemented by

- -- [Asset](objects#asset) -- [Peer](objects#peer) -- [PaymentPointer](objects#paymentpointer) -- [IncomingPayment](objects#incomingpayment) -- [OutgoingPayment](objects#outgoingpayment) -- [Payment](objects#payment) -- [PaymentPointerKey](objects#paymentpointerkey) -- [WebhookEvent](objects#webhookevent) -- [Fee](objects#fee) - -

Fields

- - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 - -
-createdAt
-String! -		 - -
- -## MutationResponse - -

Implemented by

- -- [CreatePaymentPointerMutationResponse](objects#createpaymentpointermutationresponse) -- [UpdatePaymentPointerMutationResponse](objects#updatepaymentpointermutationresponse) -- [TriggerPaymentPointerEventsMutationResponse](objects#triggerpaymentpointereventsmutationresponse) -- [AssetMutationResponse](objects#assetmutationresponse) -- [CreatePeerMutationResponse](objects#createpeermutationresponse) -- [UpdatePeerMutationResponse](objects#updatepeermutationresponse) -- [DeletePeerMutationResponse](objects#deletepeermutationresponse) -- [TransferMutationResponse](objects#transfermutationresponse) -- [LiquidityMutationResponse](objects#liquiditymutationresponse) -- [PaymentPointerWithdrawalMutationResponse](objects#paymentpointerwithdrawalmutationresponse) -- [CreatePaymentPointerKeyMutationResponse](objects#createpaymentpointerkeymutationresponse) -- [RevokePaymentPointerKeyMutationResponse](objects#revokepaymentpointerkeymutationresponse) -- [SetFeeResponse](objects#setfeeresponse) - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/backend/mutations.md b/packages/documentation/src/content/docs/apis/backend/mutations.md deleted file mode 100644 index 22b20cc9d9..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/mutations.md +++ /dev/null @@ -1,557 +0,0 @@ ---- -title: Mutations ---- - - - -## addAssetLiquidity - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Add asset liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-AddAssetLiquidityInput! -		 - -
- -## addPeerLiquidity - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Add peer liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-AddPeerLiquidityInput! -		 - -
- -## createAsset - -**Type:** [AssetMutationResponse!](objects#assetmutationresponse) - -Create an asset - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateAssetInput! -		 - -
- -## createAssetLiquidityWithdrawal - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Withdraw asset liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateAssetLiquidityWithdrawalInput! -		 - -
- -## createIncomingPayment - -**Type:** [IncomingPaymentResponse!](objects#incomingpaymentresponse) - -Create an internal Open Payments Incoming Payment. The receiver has a payment pointer on this Rafiki instance. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateIncomingPaymentInput! -		 - -
- -## createOutgoingPayment - -**Type:** [OutgoingPaymentResponse!](objects#outgoingpaymentresponse) - -Create an Open Payments Outgoing Payment - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateOutgoingPaymentInput! -		 - -
- -## createPaymentPointer - -**Type:** [CreatePaymentPointerMutationResponse!](objects#createpaymentpointermutationresponse) - -Create a payment pointer - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreatePaymentPointerInput! -		 - -
- -## createPaymentPointerKey - -**Type:** [CreatePaymentPointerKeyMutationResponse](objects#createpaymentpointerkeymutationresponse) - -Add a public key to a payment pointer that is used to verify Open Payments requests. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreatePaymentPointerKeyInput! -		 - -
- -## createPaymentPointerWithdrawal - -**Type:** [PaymentPointerWithdrawalMutationResponse](objects#paymentpointerwithdrawalmutationresponse) - -Withdraw liquidity from a payment pointer received via Web Monetization. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreatePaymentPointerWithdrawalInput! -		 - -
- -## createPeer - -**Type:** [CreatePeerMutationResponse!](objects#createpeermutationresponse) - -Create a peer - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreatePeerInput! -		 - -
- -## createPeerLiquidityWithdrawal - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Withdraw peer liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreatePeerLiquidityWithdrawalInput! -		 - -
- -## createQuote - -**Type:** [QuoteResponse!](objects#quoteresponse) - -Create an Open Payments Quote - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateQuoteInput! -		 - -
- -## createReceiver - -**Type:** [CreateReceiverResponse!](objects#createreceiverresponse) - -Create an internal or external Open Payments Incoming Payment. The receiver has a payment pointer on either this or another Open Payments resource server. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-CreateReceiverInput! -		 - -
- -## deletePeer - -**Type:** [DeletePeerMutationResponse!](objects#deletepeermutationresponse) - -Delete a peer - -

Arguments

- - - - - - - - - -
NameDescription
-input
-DeletePeerInput! -		 - -
- -## depositEventLiquidity - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Deposit webhook event liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-DepositEventLiquidityInput! -		 - -
- -## postLiquidityWithdrawal - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Post liquidity withdrawal. Withdrawals are two-phase commits and are committed via this mutation. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-PostLiquidityWithdrawalInput! -		 - -
- -## revokePaymentPointerKey - -**Type:** [RevokePaymentPointerKeyMutationResponse](objects#revokepaymentpointerkeymutationresponse) - -Revoke a public key associated with a payment pointer. Open Payment requests using this key for request signatures will be denied going forward. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-RevokePaymentPointerKeyInput! -		 - -
- -## setFee - -**Type:** [SetFeeResponse!](objects#setfeeresponse) - -Set the fee on an asset - -

Arguments

- - - - - - - - - -
NameDescription
-input
-SetFeeInput! -		 - -
- -## triggerPaymentPointerEvents - -**Type:** [TriggerPaymentPointerEventsMutationResponse!](objects#triggerpaymentpointereventsmutationresponse) - -If automatic withdrawal of funds received via Web Monetization by the payment pointer are disabled, this mutation can be used to trigger up to n withdrawal events. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-TriggerPaymentPointerEventsInput! -		 - -
- -## updateAssetWithdrawalThreshold - -**Type:** [AssetMutationResponse!](objects#assetmutationresponse) - -Update an asset's withdrawal threshold. The withdrawal threshold indicates the MINIMUM amount that can be withdrawn. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-UpdateAssetInput! -		 - -
- -## updatePaymentPointer - -**Type:** [UpdatePaymentPointerMutationResponse!](objects#updatepaymentpointermutationresponse) - -Update a payment pointer - -

Arguments

- - - - - - - - - -
NameDescription
-input
-UpdatePaymentPointerInput! -		 - -
- -## updatePeer - -**Type:** [UpdatePeerMutationResponse!](objects#updatepeermutationresponse) - -Update a peer - -

Arguments

- - - - - - - - - -
NameDescription
-input
-UpdatePeerInput! -		 - -
- -## voidLiquidityWithdrawal - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Void liquidity withdrawal. Withdrawals are two-phase commits and are rolled back via this mutation. - -

Arguments

- - - - - - - - - -
NameDescription
-input
-VoidLiquidityWithdrawalInput! -		 - -
- -## withdrawEventLiquidity - -**Type:** [LiquidityMutationResponse](objects#liquiditymutationresponse) - -Withdraw webhook event liquidity - -

Arguments

- - - - - - - - - -
NameDescription
-input
-WithdrawEventLiquidityInput! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/backend/objects.md b/packages/documentation/src/content/docs/apis/backend/objects.md deleted file mode 100644 index 0f5e9957c9..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/objects.md +++ /dev/null @@ -1,2558 +0,0 @@ ---- -title: Objects ---- - - - -## Amount - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-value
-UInt64! -		 - -
-assetCode
-String! -		 -

ISO 4217 currency code, e.g. USD

-
-assetScale
-UInt8! -		 -

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

-
- -## Asset - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Asset id

-
-code
-String! -		 -

ISO 4217 currency code, e.g. USD

-
-scale
-UInt8! -		 -

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

-
-liquidity
-UInt64 -		 -

Available liquidity

-
-withdrawalThreshold
-UInt64 -		 -

Minimum amount of liquidity that can be withdrawn from the asset

-
-receivingFee
-Fee -		 -

The receiving fee structure for the asset

-
-sendingFee
-Fee -		 -

The sending fee structure for the asset

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## AssetEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-Asset! -		 - -
-cursor
-String! -		 - -
- -## AssetMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-asset
-Asset -		 - -
- -## AssetsConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[AssetEdge!]! -		 - -
- -## CreatePaymentPointerKeyMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-paymentPointerKey
-PaymentPointerKey -		 - -
- -## CreatePaymentPointerMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-paymentPointer
-PaymentPointer -		 - -
- -## CreatePeerMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-peer
-Peer -		 - -
- -## CreateReceiverResponse - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String -		 - -
-receiver
-Receiver -		 - -
- -## DeletePeerMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
- -## Fee - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Fee id

-
-assetId
-ID! -		 -

Asset id associated with the fee

-
-type
-FeeType! -		 -

Type of fee (sending or receiving)

-
-fixed
-UInt64! -		 -

Fixed fee

-
-basisPoints
-Int! -		 -

Basis points fee. 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100%

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## Http - -

Fields

- - - - - - - - - -
NameDescription
-outgoing
-HttpOutgoing! -		 -

Outgoing connection details

-
- -## HttpOutgoing - -

Fields

- - - - - - - - - - - - - -
NameDescription
-authToken
-String! -		 -

Auth token to present at the peering Rafiki instance

-
-endpoint
-String! -		 -

Peer's connection endpoint

-
- -## IncomingPayment - -

Implements

- -- [BasePayment](interfaces#basepayment) -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Incoming Payment id

-
-paymentPointerId
-ID! -		 -

Id of the payment pointer under which this incoming payment was created

-
-state
-IncomingPaymentState! -		 -

Incoming payment state

-
-expiresAt
-String! -		 -

Date-time of expiry. After this time, the incoming payment will not accept further payments made to it.

-
-incomingAmount
-Amount -		 -

The maximum amount that should be paid into the payment pointer under this incoming payment.

-
-receivedAmount
-Amount! -		 -

The total amount that has been paid into the payment pointer under this incoming payment.

-
-metadata
-JSONObject -		 -

Additional metadata associated with the incoming payment.

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## IncomingPaymentConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[IncomingPaymentEdge!]! -		 - -
- -## IncomingPaymentEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-IncomingPayment! -		 - -
-cursor
-String! -		 - -
- -## IncomingPaymentResponse - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String -		 - -
-payment
-IncomingPayment -		 - -
- -## Jwk - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-kid
-String! -		 -

Key id

-
-x
-String! -		 -

Base64 url-encoded public key.

-
-alg
-Alg! -		 -

Cryptographic algorithm family used with the key. The only allowed value is EdDSA.

-
-kty
-Kty! -		 -

Key type. The only allowed value is OKP.

-
-crv
-Crv! -		 -

Curve that the key pair is derived from. The only allowed value is Ed25519.

-
- -## LiquidityMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-error
-LiquidityError -		 - -
- -## OutgoingPayment - -

Implements

- -- [BasePayment](interfaces#basepayment) -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Outgoing payment id

-
-paymentPointerId
-ID! -		 -

Id of the payment pointer under which this outgoing payment was created

-
-state
-OutgoingPaymentState! -		 -

Outgoing payment state

-
-error
-String -		 - -
-stateAttempts
-Int! -		 - -
-sendAmount
-Amount! -		 -

Amount to send (fixed send)

-
-receiveAmount
-Amount! -		 -

Amount to receive (fixed receive)

-
-receiver
-String! -		 -

Payment pointer URL of the receiver

-
-metadata
-JSONObject -		 -

Additional metadata associated with the outgoing payment.

-
-quote
-Quote -		 -

Quote for this outgoing payment

-
-sentAmount
-Amount! -		 -

Amount already sent

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## OutgoingPaymentConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[OutgoingPaymentEdge!]! -		 - -
- -## OutgoingPaymentEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-OutgoingPayment! -		 - -
-cursor
-String! -		 - -
- -## OutgoingPaymentResponse - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String -		 - -
-payment
-OutgoingPayment -		 - -
- -## PageInfo - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-endCursor
-String -		 -

Paginating forwards: the cursor to continue.

-
-hasNextPage
-Boolean! -		 -

Paginating forwards: Are there more pages?

-
-hasPreviousPage
-Boolean! -		 -

Paginating backwards: Are there more pages?

-
-startCursor
-String -		 -

Paginating backwards: the cursor to continue.

-
- -## Payment - -

Implements

- -- [BasePayment](interfaces#basepayment) -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Payment id

-
-type
-PaymentType! -		 -

Type of payment

-
-paymentPointerId
-ID! -		 -

Id of the payment pointer under which this payment was created

-
-state
-String! -		 -

Either the IncomingPaymentState or OutgoingPaymentState according to type

-
-metadata
-JSONObject -		 -

Additional metadata associated with the payment.

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## PaymentConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[PaymentEdge!]! -		 - -
- -## PaymentEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-Payment! -		 - -
-cursor
-String! -		 - -
- -## PaymentPointer - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Payment pointer id

-
-asset
-Asset! -		 -

Asset of the payment pointer

-
-url
-String! -		 -

Payment Pointer URL

-
-publicName
-String -		 -

Public name associated with the payment pointer

-
-incomingPayments
-IncomingPaymentConnection -		 -

List of incoming payments received by this payment pointer

- -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -
-quotes
-QuoteConnection -		 -

List of quotes created at this payment pointer

- -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -
-outgoingPayments
-OutgoingPaymentConnection -		 -

List of outgoing payments sent from this payment pointer

- -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -
-createdAt
-String! -		 -

Date-time of creation

-
-status
-PaymentPointerStatus! -		 -

Status of the payment pointer

-
- -## PaymentPointerEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-PaymentPointer! -		 - -
-cursor
-String! -		 - -
- -## PaymentPointerKey - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Internal id of key

-
-paymentPointerId
-ID! -		 -

Id of the payment pointer to which this key belongs to

-
-jwk
-Jwk! -		 -

Public key

-
-revoked
-Boolean! -		 -

Indicator whether the key has been revoked

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## PaymentPointersConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[PaymentPointerEdge!]! -		 - -
- -## PaymentPointerWithdrawal - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Withdrawal Id

-
-amount
-UInt64! -		 -

Amount to withdraw

-
-paymentPointer
-PaymentPointer! -		 -

Payment pointer details

-
- -## PaymentPointerWithdrawalMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-error
-LiquidityError -		 - -
-withdrawal
-PaymentPointerWithdrawal -		 - -
- -## Peer - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Peer id

-
-maxPacketAmount
-UInt64 -		 -

Maximum packet amount that the peer accepts

-
-http
-Http! -		 -

Peering connection details

-
-asset
-Asset! -		 -

Asset of peering relationship

-
-staticIlpAddress
-String! -		 -

Peer's ILP address

-
-name
-String -		 -

Peer's public name

-
-liquidity
-UInt64 -		 -

Available liquidity

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## PeerEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-Peer! -		 - -
-cursor
-String! -		 - -
- -## PeersConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[PeerEdge!]! -		 - -
- -## Quote - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Quote id

-
-paymentPointerId
-ID! -		 -

Id of the payment pointer under which this quote was created

-
-receiver
-String! -		 -

Payment pointer URL of the receiver

-
-debitAmount
-Amount! -		 -

Amount to send (fixed send)

-
-receiveAmount
-Amount! -		 -

Amount to receive (fixed receive)

-
-maxPacketAmount
-UInt64! -		 -

Maximum value per packet allowed on the possible routes

-
-minExchangeRate
-Float! -		 -

Aggregate exchange rate the payment is guaranteed to meet

-
-lowEstimatedExchangeRate
-Float! -		 -

Lower bound of probed exchange rate

-
-highEstimatedExchangeRate
-Float! -		 -

Upper bound of probed exchange rate

-
-createdAt
-String! -		 -

Date-time of creation

-
-expiresAt
-String! -		 -

Date-time of expiration

-
- -## QuoteConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[QuoteEdge!]! -		 - -
- -## QuoteEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-Quote! -		 - -
-cursor
-String! -		 - -
- -## QuoteResponse - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String -		 - -
-quote
-Quote -		 - -
- -## Receiver - -

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-String! -		 -

Incoming payment URL

-
-paymentPointerUrl
-String! -		 -

Payment pointer URL under which the incoming payment was created

-
-completed
-Boolean! -		 -

Describes whether the incoming payment has completed receiving funds.

-
-incomingAmount
-Amount -		 -

The maximum amount that should be paid into the payment pointer under this incoming payment.

-
-receivedAmount
-Amount! -		 -

The total amount that has been paid into the payment pointer under this incoming payment.

-
-expiresAt
-String -		 -

Date-time of expiry. After this time, the incoming payment will accept further payments made to it.

-
-metadata
-JSONObject -		 -

Additional metadata associated with the incoming payment.

-
-createdAt
-String! -		 -

Date-time of creation

-
-updatedAt
-String! -		 -

Date-time of last update

-
- -## RevokePaymentPointerKeyMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-paymentPointerKey
-PaymentPointerKey -		 - -
- -## SetFeeResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-fee
-Fee -		 - -
- -## TransferMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
- -## TriggerPaymentPointerEventsMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-count
-Int -		 -

Number of events triggered

-
- -## UpdatePaymentPointerMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-paymentPointer
-PaymentPointer -		 - -
- -## UpdatePeerMutationResponse - -

Implements

- -- [MutationResponse](interfaces#mutationresponse) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-code
-String! -		 - -
-success
-Boolean! -		 - -
-message
-String! -		 - -
-peer
-Peer -		 - -
- -## WebhookEvent - -

Implements

- -- [Model](interfaces#model) - -

Fields

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-id
-ID! -		 -

Event id

-
-type
-String! -		 -

Type of event

-
-data
-JSONObject! -		 -

Stringified JSON data

-
-createdAt
-String! -		 -

Date-time of creation

-
- -## WebhookEventsConnection - -

Fields

- - - - - - - - - - - - - -
NameDescription
-pageInfo
-PageInfo! -		 - -
-edges
-[WebhookEventsEdge!]! -		 - -
- -## WebhookEventsEdge - -

Fields

- - - - - - - - - - - - - -
NameDescription
-node
-WebhookEvent! -		 - -
-cursor
-String! -		 - -
diff --git a/packages/documentation/src/content/docs/apis/backend/queries.md b/packages/documentation/src/content/docs/apis/backend/queries.md deleted file mode 100644 index d8003d1c62..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/queries.md +++ /dev/null @@ -1,411 +0,0 @@ ---- -title: Queries ---- - - - -## asset - -**Type:** [Asset](objects#asset) - -Fetch an asset - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## assets - -**Type:** [AssetsConnection!](objects#assetsconnection) - -Fetch a page of assets. - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -## incomingPayment - -**Type:** [IncomingPayment](objects#incomingpayment) - -Fetch an Open Payments incoming payment - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## outgoingPayment - -**Type:** [OutgoingPayment](objects#outgoingpayment) - -Fetch an Open Payments outgoing payment - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## paymentPointer - -**Type:** [PaymentPointer](objects#paymentpointer) - -Fetch a payment pointer - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## paymentPointers - -**Type:** [PaymentPointersConnection!](objects#paymentpointersconnection) - -Fetch a page of payment pointers. - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -## payments - -**Type:** [PaymentConnection!](objects#paymentconnection) - -Fetch a page of combined payments - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
-filter
-PaymentFilter -		 -

Filter payment events based on specific criteria.

-
- -## peer - -**Type:** [Peer](objects#peer) - -Fetch a peer - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## peers - -**Type:** [PeersConnection!](objects#peersconnection) - -Fetch a page of peers. - -

Arguments

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
- -## quote - -**Type:** [Quote](objects#quote) - -Fetch an Open Payments quote - -

Arguments

- - - - - - - - - -
NameDescription
-id
-String! -		 - -
- -## webhookEvents - -**Type:** [WebhookEventsConnection!](objects#webhookeventsconnection) - -Fetch a page of webhook events - -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
-after
-String -		 -

Paginating forwards: the cursor before the the requested page.

-
-before
-String -		 -

Paginating backwards: the cursor after the the requested page.

-
-first
-Int -		 -

Paginating forwards: The first n elements from the page.

-
-last
-Int -		 -

Paginating backwards: The last n elements from the page.

-
-filter
-WebhookEventFilter -		 -

Filter webhook events based on specific criteria.

-
diff --git a/packages/documentation/src/content/docs/apis/backend/scalars.md b/packages/documentation/src/content/docs/apis/backend/scalars.md deleted file mode 100644 index c1970513c1..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/scalars.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Scalars ---- - - - -## Boolean - -The `Boolean` scalar type represents `true` or `false`. - -## Float - -The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -## ID - -The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. - -## Int - -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - -## JSONObject - -## String - -The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. - -## UInt64 - -## UInt8 diff --git a/packages/documentation/src/content/docs/apis/backend/schema.mdx b/packages/documentation/src/content/docs/apis/backend/schema.mdx deleted file mode 100644 index c4c3e8025c..0000000000 --- a/packages/documentation/src/content/docs/apis/backend/schema.mdx +++ /dev/null @@ -1,5333 +0,0 @@ ---- -title: Schema Types ---- - -
- Table of Contents - -- [Query](#query) -- [Mutation](#mutation) -- [Objects](#objects) - - [Amount](#amount) - - [Asset](#asset) - - [AssetEdge](#assetedge) - - [AssetMutationResponse](#assetmutationresponse) - - [AssetsConnection](#assetsconnection) - - [CreatePaymentPointerKeyMutationResponse](#createpaymentpointerkeymutationresponse) - - [CreatePaymentPointerMutationResponse](#createpaymentpointermutationresponse) - - [CreatePeerMutationResponse](#createpeermutationresponse) - - [CreateReceiverResponse](#createreceiverresponse) - - [DeletePeerMutationResponse](#deletepeermutationresponse) - - [Fee](#fee) - - [Http](#http) - - [HttpOutgoing](#httpoutgoing) - - [IncomingPayment](#incomingpayment) - - [IncomingPaymentConnection](#incomingpaymentconnection) - - [IncomingPaymentEdge](#incomingpaymentedge) - - [IncomingPaymentResponse](#incomingpaymentresponse) - - [Jwk](#jwk) - - [LiquidityMutationResponse](#liquiditymutationresponse) - - [OutgoingPayment](#outgoingpayment) - - [OutgoingPaymentConnection](#outgoingpaymentconnection) - - [OutgoingPaymentEdge](#outgoingpaymentedge) - - [OutgoingPaymentResponse](#outgoingpaymentresponse) - - [PageInfo](#pageinfo) - - [Payment](#payment) - - [PaymentConnection](#paymentconnection) - - [PaymentEdge](#paymentedge) - - [PaymentPointer](#paymentpointer) - - [PaymentPointerEdge](#paymentpointeredge) - - [PaymentPointerKey](#paymentpointerkey) - - [PaymentPointerWithdrawal](#paymentpointerwithdrawal) - - [PaymentPointerWithdrawalMutationResponse](#paymentpointerwithdrawalmutationresponse) - - [PaymentPointersConnection](#paymentpointersconnection) - - [Peer](#peer) - - [PeerEdge](#peeredge) - - [PeersConnection](#peersconnection) - - [Quote](#quote) - - [QuoteConnection](#quoteconnection) - - [QuoteEdge](#quoteedge) - - [QuoteResponse](#quoteresponse) - - [Receiver](#receiver) - - [RevokePaymentPointerKeyMutationResponse](#revokepaymentpointerkeymutationresponse) - - [SetFeeResponse](#setfeeresponse) - - [TransferMutationResponse](#transfermutationresponse) - - [TriggerPaymentPointerEventsMutationResponse](#triggerpaymentpointereventsmutationresponse) - - [UpdatePaymentPointerMutationResponse](#updatepaymentpointermutationresponse) - - [UpdatePeerMutationResponse](#updatepeermutationresponse) - - [WebhookEvent](#webhookevent) - - [WebhookEventsConnection](#webhookeventsconnection) - - [WebhookEventsEdge](#webhookeventsedge) -- [Inputs](#inputs) - - [AddAssetLiquidityInput](#addassetliquidityinput) - - [AddPeerLiquidityInput](#addpeerliquidityinput) - - [AmountInput](#amountinput) - - [CreateAssetInput](#createassetinput) - - [CreateAssetLiquidityWithdrawalInput](#createassetliquiditywithdrawalinput) - - [CreateIncomingPaymentInput](#createincomingpaymentinput) - - [CreateOutgoingPaymentInput](#createoutgoingpaymentinput) - - [CreatePaymentPointerInput](#createpaymentpointerinput) - - [CreatePaymentPointerKeyInput](#createpaymentpointerkeyinput) - - [CreatePaymentPointerWithdrawalInput](#createpaymentpointerwithdrawalinput) - - [CreatePeerInput](#createpeerinput) - - [CreatePeerLiquidityWithdrawalInput](#createpeerliquiditywithdrawalinput) - - [CreateQuoteInput](#createquoteinput) - - [CreateReceiverInput](#createreceiverinput) - - [DeletePeerInput](#deletepeerinput) - - [DepositEventLiquidityInput](#depositeventliquidityinput) - - [FeeDetails](#feedetails) - - [FilterString](#filterstring) - - [HttpIncomingInput](#httpincominginput) - - [HttpInput](#httpinput) - - [HttpOutgoingInput](#httpoutgoinginput) - - [JwkInput](#jwkinput) - - [PaymentFilter](#paymentfilter) - - [PostLiquidityWithdrawalInput](#postliquiditywithdrawalinput) - - [RevokePaymentPointerKeyInput](#revokepaymentpointerkeyinput) - - [SetFeeInput](#setfeeinput) - - [TriggerPaymentPointerEventsInput](#triggerpaymentpointereventsinput) - - [UpdateAssetInput](#updateassetinput) - - [UpdatePaymentPointerInput](#updatepaymentpointerinput) - - [UpdatePeerInput](#updatepeerinput) - - [VoidLiquidityWithdrawalInput](#voidliquiditywithdrawalinput) - - [WebhookEventFilter](#webhookeventfilter) - - [WithdrawEventLiquidityInput](#withdraweventliquidityinput) -- [Enums](#enums) - - [Alg](#alg) - - [Crv](#crv) - - [FeeType](#feetype) - - [IncomingPaymentState](#incomingpaymentstate) - - [Kty](#kty) - - [LiquidityError](#liquidityerror) - - [OutgoingPaymentState](#outgoingpaymentstate) - - [PaymentPointerStatus](#paymentpointerstatus) - - [PaymentType](#paymenttype) -- [Scalars](#scalars) - - [Boolean](#boolean) - - [Float](#float) - - [ID](#id) - - [Int](#int) - - [JSONObject](#jsonobject) - - [String](#string) - - [UInt64](#uint64) - - [UInt8](#uint8) -- [Interfaces](#interfaces) - - [BasePayment](#basepayment) - - [Model](#model) - - [MutationResponse](#mutationresponse) - -
- -## Query - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
assetAsset - -Fetch an asset - -
idString!
assetsAssetsConnection! - -Fetch a page of assets. - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
peerPeer - -Fetch a peer - -
idString!
peersPeersConnection! - -Fetch a page of peers. - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
paymentPointerPaymentPointer - -Fetch a payment pointer - -
idString!
paymentPointersPaymentPointersConnection! - -Fetch a page of payment pointers. - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
quoteQuote - -Fetch an Open Payments quote - -
idString!
outgoingPaymentOutgoingPayment - -Fetch an Open Payments outgoing payment - -
idString!
incomingPaymentIncomingPayment - -Fetch an Open Payments incoming payment - -
idString!
webhookEventsWebhookEventsConnection! - -Fetch a page of webhook events - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
filterWebhookEventFilter - -Filter webhook events based on specific criteria. - -
paymentsPaymentConnection! - -Fetch a page of combined payments - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
filterPaymentFilter - -Filter payment events based on specific criteria. - -
- -## Mutation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
createAssetAssetMutationResponse! - -Create an asset - -
inputCreateAssetInput!
updateAssetWithdrawalThresholdAssetMutationResponse! - -Update an asset's withdrawal threshold. The withdrawal threshold indicates the MINIMUM amount that can be withdrawn. - -
inputUpdateAssetInput!
addAssetLiquidityLiquidityMutationResponse - -Add asset liquidity - -
inputAddAssetLiquidityInput!
createAssetLiquidityWithdrawalLiquidityMutationResponse - -Withdraw asset liquidity - -
inputCreateAssetLiquidityWithdrawalInput!
createPeerCreatePeerMutationResponse! - -Create a peer - -
inputCreatePeerInput!
updatePeerUpdatePeerMutationResponse! - -Update a peer - -
inputUpdatePeerInput!
deletePeerDeletePeerMutationResponse! - -Delete a peer - -
inputDeletePeerInput!
addPeerLiquidityLiquidityMutationResponse - -Add peer liquidity - -
inputAddPeerLiquidityInput!
createPeerLiquidityWithdrawalLiquidityMutationResponse - -Withdraw peer liquidity - -
inputCreatePeerLiquidityWithdrawalInput!
postLiquidityWithdrawalLiquidityMutationResponse - -Post liquidity withdrawal. Withdrawals are two-phase commits and are committed via this mutation. - -
inputPostLiquidityWithdrawalInput!
voidLiquidityWithdrawalLiquidityMutationResponse - -Void liquidity withdrawal. Withdrawals are two-phase commits and are rolled back via this mutation. - -
inputVoidLiquidityWithdrawalInput!
createPaymentPointerCreatePaymentPointerMutationResponse! - -Create a payment pointer - -
inputCreatePaymentPointerInput!
updatePaymentPointerUpdatePaymentPointerMutationResponse! - -Update a payment pointer - -
inputUpdatePaymentPointerInput!
createPaymentPointerKeyCreatePaymentPointerKeyMutationResponse - -Add a public key to a payment pointer that is used to verify Open Payments requests. - -
inputCreatePaymentPointerKeyInput!
revokePaymentPointerKeyRevokePaymentPointerKeyMutationResponse - -Revoke a public key associated with a payment pointer. Open Payment requests using this key for request signatures will be denied going forward. - -
inputRevokePaymentPointerKeyInput!
createIncomingPaymentIncomingPaymentResponse! - -Create an internal Open Payments Incoming Payment. The receiver has a payment pointer on this Rafiki instance. - -
inputCreateIncomingPaymentInput!
createReceiverCreateReceiverResponse! - -Create an internal or external Open Payments Incoming Payment. The receiver has a payment pointer on either this or another Open Payments resource server. - -
inputCreateReceiverInput!
createQuoteQuoteResponse! - -Create an Open Payments Quote - -
inputCreateQuoteInput!
createOutgoingPaymentOutgoingPaymentResponse! - -Create an Open Payments Outgoing Payment - -
inputCreateOutgoingPaymentInput!
depositEventLiquidityLiquidityMutationResponse - -Deposit webhook event liquidity - -
inputDepositEventLiquidityInput!
withdrawEventLiquidityLiquidityMutationResponse - -Withdraw webhook event liquidity - -
inputWithdrawEventLiquidityInput!
createPaymentPointerWithdrawalPaymentPointerWithdrawalMutationResponse - -Withdraw liquidity from a payment pointer received via Web Monetization. - -
inputCreatePaymentPointerWithdrawalInput!
triggerPaymentPointerEventsTriggerPaymentPointerEventsMutationResponse! - -If automatic withdrawal of funds received via Web Monetization by the payment pointer are disabled, this mutation can be used to trigger up to n withdrawal events. - -
inputTriggerPaymentPointerEventsInput!
setFeeSetFeeResponse! - -Set the fee on an asset - -
inputSetFeeInput!
- -## Objects - -### Amount - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
valueUInt64!
assetCodeString! - -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - -
assetScaleUInt8! - -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - -
- -### Asset - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Asset id - -
codeString! - -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - -
scaleUInt8! - -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - -
liquidityUInt64 - -Available liquidity - -
withdrawalThresholdUInt64 - -Minimum amount of liquidity that can be withdrawn from the asset - -
receivingFeeFee - -The receiving fee structure for the asset - -
sendingFeeFee - -The sending fee structure for the asset - -
createdAtString! - -Date-time of creation - -
- -### AssetEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - Asset! -
- cursor - - String! -
- -### AssetMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- asset - - Asset -
- -### AssetsConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [AssetEdge!]! -
- -### CreatePaymentPointerKeyMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- paymentPointerKey - - PaymentPointerKey -
- -### CreatePaymentPointerMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- paymentPointer - - PaymentPointer -
- -### CreatePeerMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- peer - - Peer -
- -### CreateReceiverResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String -
- receiver - - Receiver -
- -### DeletePeerMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- -### Fee - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Fee id - -
assetIdID! - -Asset id associated with the fee - -
typeFeeType! - -Type of fee (sending or receiving) - -
fixedUInt64! - -Fixed fee - -
basisPointsInt! - -Basis points fee. 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100% - -
createdAtString! - -Date-time of creation - -
- -### Http - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
outgoingHttpOutgoing! - -Outgoing connection details - -
- -### HttpOutgoing - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
authTokenString! - -Auth token to present at the peering Rafiki instance - -
endpointString! - -Peer's connection endpoint - -
- -### IncomingPayment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Incoming Payment id - -
paymentPointerIdID! - -Id of the payment pointer under which this incoming payment was created - -
stateIncomingPaymentState! - -Incoming payment state - -
expiresAtString! - -Date-time of expiry. After this time, the incoming payment will not accept further payments made to it. - -
incomingAmountAmount - -The maximum amount that should be paid into the payment pointer under this incoming payment. - -
receivedAmountAmount! - -The total amount that has been paid into the payment pointer under this incoming payment. - -
metadataJSONObject - -Additional metadata associated with the incoming payment. - -
createdAtString! - -Date-time of creation - -
- -### IncomingPaymentConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [IncomingPaymentEdge!]! -
- -### IncomingPaymentEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - IncomingPayment! -
- cursor - - String! -
- -### IncomingPaymentResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String -
- payment - - IncomingPayment -
- -### Jwk - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
kidString! - -Key id - -
xString! - -Base64 url-encoded public key. - -
algAlg! - -Cryptographic algorithm family used with the key. The only allowed value is `EdDSA`. - -
ktyKty! - -Key type. The only allowed value is `OKP`. - -
crvCrv! - -Curve that the key pair is derived from. The only allowed value is `Ed25519`. - -
- -### LiquidityMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- error - - LiquidityError -
- -### OutgoingPayment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Outgoing payment id - -
paymentPointerIdID! - -Id of the payment pointer under which this outgoing payment was created - -
stateOutgoingPaymentState! - -Outgoing payment state - -
errorString
stateAttemptsInt!
debitAmountAmount! - -Amount to send (fixed send) - -
receiveAmountAmount! - -Amount to receive (fixed receive) - -
receiverString! - -Payment pointer URL of the receiver - -
metadataJSONObject - -Additional metadata associated with the outgoing payment. - -
quoteQuote - -Quote for this outgoing payment - -
sentAmountAmount! - -Amount already sent - -
createdAtString! - -Date-time of creation - -
- -### OutgoingPaymentConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [OutgoingPaymentEdge!]! -
- -### OutgoingPaymentEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - OutgoingPayment! -
- cursor - - String! -
- -### OutgoingPaymentResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String -
- payment - - OutgoingPayment -
- -### PageInfo - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
endCursorString - -Paginating forwards: the cursor to continue. - -
hasNextPageBoolean! - -Paginating forwards: Are there more pages? - -
hasPreviousPageBoolean! - -Paginating backwards: Are there more pages? - -
startCursorString - -Paginating backwards: the cursor to continue. - -
- -### Payment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Payment id - -
typePaymentType! - -Type of payment - -
paymentPointerIdID! - -Id of the payment pointer under which this payment was created - -
stateString! - -Either the IncomingPaymentState or OutgoingPaymentState according to type - -
metadataJSONObject - -Additional metadata associated with the payment. - -
createdAtString! - -Date-time of creation - -
- -### PaymentConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [PaymentEdge!]! -
- -### PaymentEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - Payment! -
- cursor - - String! -
- -### PaymentPointer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Payment pointer id - -
assetAsset! - -Asset of the payment pointer - -
urlString! - -Payment Pointer URL - -
publicNameString - -Public name associated with the payment pointer - -
incomingPaymentsIncomingPaymentConnection - -List of incoming payments received by this payment pointer - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
quotesQuoteConnection - -List of quotes created at this payment pointer - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
outgoingPaymentsOutgoingPaymentConnection - -List of outgoing payments sent from this payment pointer - -
afterString - -Paginating forwards: the cursor before the the requested page. - -
beforeString - -Paginating backwards: the cursor after the the requested page. - -
firstInt - -Paginating forwards: The first **n** elements from the page. - -
lastInt - -Paginating backwards: The last **n** elements from the page. - -
createdAtString! - -Date-time of creation - -
statusPaymentPointerStatus! - -Status of the payment pointer - -
- -### PaymentPointerEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - PaymentPointer! -
- cursor - - String! -
- -### PaymentPointerKey - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Internal id of key - -
paymentPointerIdID! - -Id of the payment pointer to which this key belongs to - -
jwkJwk! - -Public key - -
revokedBoolean! - -Indicator whether the key has been revoked - -
createdAtString! - -Date-time of creation - -
- -### PaymentPointerWithdrawal - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Withdrawal Id - -
amountUInt64! - -Amount to withdraw - -
paymentPointerPaymentPointer! - -Payment pointer details - -
- -### PaymentPointerWithdrawalMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- error - - LiquidityError -
- withdrawal - - PaymentPointerWithdrawal -
- -### PaymentPointersConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [PaymentPointerEdge!]! -
- -### Peer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Peer id - -
maxPacketAmountUInt64 - -Maximum packet amount that the peer accepts - -
httpHttp! - -Peering connection details - -
assetAsset! - -Asset of peering relationship - -
staticIlpAddressString! - -Peer's ILP address - -
nameString - -Peer's public name - -
liquidityUInt64 - -Available liquidity - -
createdAtString! - -Date-time of creation - -
- -### PeerEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - Peer! -
- cursor - - String! -
- -### PeersConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [PeerEdge!]! -
- -### Quote - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Quote id - -
paymentPointerIdID! - -Id of the payment pointer under which this quote was created - -
receiverString! - -Payment pointer URL of the receiver - -
debitAmountAmount! - -Amount to send (fixed send) - -
receiveAmountAmount! - -Amount to receive (fixed receive) - -
maxPacketAmountUInt64! - -Maximum value per packet allowed on the possible routes - -
minExchangeRateFloat! - -Aggregate exchange rate the payment is guaranteed to meet - -
lowEstimatedExchangeRateFloat! - -Lower bound of probed exchange rate - -
highEstimatedExchangeRateFloat! - -Upper bound of probed exchange rate - -
createdAtString! - -Date-time of creation - -
expiresAtString! - -Date-time of expiration - -
- -### QuoteConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [QuoteEdge!]! -
- -### QuoteEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - Quote! -
- cursor - - String! -
- -### QuoteResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String -
- quote - - Quote -
- -### Receiver - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idString! - -Incoming payment URL - -
paymentPointerUrlString! - -Payment pointer URL under which the incoming payment was created - -
completedBoolean! - -Describes whether the incoming payment has completed receiving funds. - -
incomingAmountAmount - -The maximum amount that should be paid into the payment pointer under this incoming payment. - -
receivedAmountAmount! - -The total amount that has been paid into the payment pointer under this incoming payment. - -
expiresAtString - -Date-time of expiry. After this time, the incoming payment will accept further payments made to it. - -
metadataJSONObject - -Additional metadata associated with the incoming payment. - -
createdAtString! - -Date-time of creation - -
updatedAtString! - -Date-time of last update - -
- -### RevokePaymentPointerKeyMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- paymentPointerKey - - PaymentPointerKey -
- -### SetFeeResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- fee - - Fee -
- -### TransferMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- -### TriggerPaymentPointerEventsMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
codeString!
successBoolean!
messageString!
countInt - -Number of events triggered - -
- -### UpdatePaymentPointerMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- paymentPointer - - PaymentPointer -
- -### UpdatePeerMutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
- peer - - Peer -
- -### WebhookEvent - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID! - -Event id - -
typeString! - -Type of event - -
dataJSONObject! - -Stringified JSON data - -
createdAtString! - -Date-time of creation - -
- -### WebhookEventsConnection - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- pageInfo - - PageInfo! -
- edges - - [WebhookEventsEdge!]! -
- -### WebhookEventsEdge - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- node - - WebhookEvent! -
- cursor - - String! -
- -## Inputs - -### AddAssetLiquidityInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
assetIdString! - -The id of the asset to add liquidity. - -
amountUInt64! - -Amount of liquidity to add. - -
idString! - -The id of the transfer. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### AddPeerLiquidityInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
peerIdString! - -The id of the peer to add liquidity. - -
amountUInt64! - -Amount of liquidity to add. - -
idString! - -The id of the transfer. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### AmountInput - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
valueUInt64!
assetCodeString! - -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - -
assetScaleUInt8! - -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - -
- -### CreateAssetInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
codeString! - -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - -
scaleUInt8! - -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - -
withdrawalThresholdUInt64 - -Minimum amount of liquidity that can be withdrawn from the asset - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreateAssetLiquidityWithdrawalInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
assetIdString! - -The id of the asset to create the withdrawal for. - -
amountUInt64! - -Amount of withdrawal. - -
idString! - -The id of the withdrawal. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreateIncomingPaymentInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerIdString! - -Id of the payment pointer under which the incoming payment will be created - -
expiresAtString - -Expiration date-time - -
metadataJSONObject - -Additional metadata associated with the incoming payment. - -
incomingAmountAmountInput - -Maximum amount to be received - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreateOutgoingPaymentInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerIdString! - -Id of the payment pointer under which the outgoing payment will be created - -
quoteIdString! - -Id of the corresponding quote for that outgoing payment - -
metadataJSONObject - -Additional metadata associated with the outgoing payment. - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreatePaymentPointerInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
assetIdString! - -Asset of the payment pointer - -
urlString! - -Payment Pointer URL - -
publicNameString - -Public name associated with the payment pointer - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreatePaymentPointerKeyInput - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerIdString!
jwkJwkInput! - -Public key - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreatePaymentPointerWithdrawalInput - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerIdString! - -The id of the Open Payments payment pointer to create the withdrawal for. - -
idString! - -The id of the withdrawal. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreatePeerInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
maxPacketAmountUInt64 - -Maximum packet amount that the peer accepts - -
httpHttpInput! - -Peering connection details - -
assetIdString! - -Asset id of peering relationship - -
staticIlpAddressString! - -Peer's ILP address - -
nameString - -Peer's internal name - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreatePeerLiquidityWithdrawalInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
peerIdString! - -The id of the peer to create the withdrawal for. - -
amountUInt64! - -Amount of withdrawal. - -
idString! - -The id of the withdrawal. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreateQuoteInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerIdString! - -Id of the payment pointer under which the quote will be created - -
debitAmountAmountInput - -Amount to send (fixed send) - -
receiveAmountAmountInput - -Amount to receive (fixed receive) - -
receiverString! - -Payment pointer URL of the receiver - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### CreateReceiverInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
paymentPointerUrlString! - -Receiving payment pointer URL - -
expiresAtString - -Expiration date-time - -
incomingAmountAmountInput - -Maximum amount to be received - -
metadataJSONObject - -Additional metadata associated with the incoming payment. - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### DeletePeerInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idID!
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### DepositEventLiquidityInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
eventIdString! - -The id of the event to deposit into. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### FeeDetails - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
fixedUInt64! - -A flat fee - -
basisPointsInt! - -Basis points fee. Should be between 0 and 10000 (inclusive). 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100% - -
- -### FilterString - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- in - - [String!]! -
- -### HttpIncomingInput - - - - - - - - - - - - - - - - -
FieldTypeDescription
authTokens[String!]! - -Array of auth tokens accepted by this Rafiki instance - -
- -### HttpInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
incomingHttpIncomingInput - -Incoming connection details - -
outgoingHttpOutgoingInput! - -Outgoing connection details - -
- -### HttpOutgoingInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
authTokenString! - -Auth token to present at the peering Rafiki instance - -
endpointString! - -Peer's connection endpoint - -
- -### JwkInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
kidString! - -Key id - -
xString! - -Base64 url-encoded public key. - -
algAlg! - -Cryptographic algorithm family used with the key. The only allowed value is `EdDSA`. - -
ktyKty! - -Key type. The only allowed value is `OKP`. - -
crvCrv! - -Curve that the key pair is derived from. The only allowed value is `Ed25519`. - -
- -### PaymentFilter - - - - - - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- type - - FilterString -
- paymentPointerId - - FilterString -
- -### PostLiquidityWithdrawalInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
withdrawalIdString! - -The id of the liquidity withdrawal to post. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### RevokePaymentPointerKeyInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idString! - -Internal id of key - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### SetFeeInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
assetIdID! - -Asset id to add the fee to - -
typeFeeType! - -Type of fee (sending or receiving) - -
feeFeeDetails! - -Fee values - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### TriggerPaymentPointerEventsInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
limitInt! - -Maximum number of events being triggered (n). - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### UpdateAssetInput - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idString! - -Asset id - -
withdrawalThresholdUInt64 - -New minimum amount of liquidity that can be withdrawn from the asset - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### UpdatePaymentPointerInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idID! - -ID of payment pointer to update - -
publicNameString - -New public name for payment pointer - -
statusPaymentPointerStatus - -New status to set the payment pointer to - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### UpdatePeerInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idString! - -Peer id - -
maxPacketAmountUInt64 - -New maximum packet amount that the peer accepts - -
httpHttpInput - -New peering connection details - -
staticIlpAddressString - -Peer's new ILP address - -
nameString - -Peer's new public name - -
idempotencyKeyString - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### VoidLiquidityWithdrawalInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
withdrawalIdString! - -The id of the liquidity withdrawal to void. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -### WebhookEventFilter - - - - - - - - - - - - - - - - -
- Field - TypeDescription
- type - - FilterString -
- -### WithdrawEventLiquidityInput - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
eventIdString! - -The id of the event to withdraw from. - -
idempotencyKeyString! - -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - -
- -## Enums - -### Alg - - - - - - - - - - - - -
ValueDescription
- EdDSA -
- -### Crv - - - - - - - - - - - - -
ValueDescription
- Ed25519 -
- -### FeeType - - - - - - - - - - - - - - - - -
ValueDescription
SENDING - -Sender pays the fees - -
RECEIVING - -Receiver pays the fees - -
- -### IncomingPaymentState - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
PENDING - -The payment has a state of PENDING when it is initially created. - -
PROCESSING - -As soon as payment has started (funds have cleared into the account) the state moves to PROCESSING - -
COMPLETED - -The payment is either auto-completed once the received amount equals the expected `incomingAmount`, or it is completed manually via an API call. - -
EXPIRED - -If the payment expires before it is completed then the state will move to EXPIRED and no further payments will be accepted. - -
- -### Kty - - - - - - - - - - - - -
ValueDescription
- OKP -
- -### LiquidityError - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
- AlreadyPosted -
- AlreadyVoided -
- AmountZero -
- InsufficientBalance -
- InvalidId -
- TransferExists -
- UnknownAsset -
- UnknownIncomingPayment -
- UnknownPayment -
- UnknownPaymentPointer -
- UnknownPeer -
- UnknownTransfer -
- -### OutgoingPaymentState - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
FUNDING - -Will transition to SENDING once payment funds are reserved - -
SENDING - -Paying, will transition to COMPLETED on success - -
COMPLETED - -Successful completion - -
FAILED - -Payment failed - -
- -### PaymentPointerStatus - - - - - - - - - - - - - - - - -
ValueDescription
INACTIVE - -Status after deactivating - -
ACTIVE - -Default status - -
- -### PaymentType - - - - - - - - - - - - - - - - -
ValueDescription
- INCOMING -
- OUTGOING -
- -## Scalars - -### Boolean - -The `Boolean` scalar type represents `true` or `false`. - -### Float - -The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -### ID - -The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - -### JSONObject - -### String - -The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. - -### UInt64 - -### UInt8 - -## Interfaces - -### BasePayment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- id - - ID! -
- paymentPointerId - - ID! -
- metadata - - JSONObject -
- createdAt - - String! -
- -### Model - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- id - - ID! -
- createdAt - - String! -
- -### MutationResponse - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
- code - - String! -
- success - - Boolean! -
- message - - String! -
diff --git a/packages/documentation/src/content/docs/index.mdx b/packages/documentation/src/content/docs/index.mdx index 3afd91dcef..cca044dd4d 100644 --- a/packages/documentation/src/content/docs/index.mdx +++ b/packages/documentation/src/content/docs/index.mdx @@ -13,12 +13,12 @@ hero: import { Card, CardGrid } from '@astrojs/starlight/components' - + Discover what is in our Backend GraphQL schema. - + Discover what is in our Auth GraphQL schema. diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e280e3d657..0c3c95ba2c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -492,12 +492,12 @@ importers: astro: specifier: 2.10.15 version: 2.10.15(sharp@0.32.5) + astro-graphql-plugin: + specifier: ^0.0.7 + version: 0.0.7(astro@2.10.15)(graphql@16.8.0) graphql: specifier: ^16.8.0 version: 16.8.0 - graphql-markdown: - specifier: ^7.0.0 - version: 7.0.0(graphql@16.8.0) react: specifier: ^18.2.0 version: 18.2.0 @@ -911,7 +911,6 @@ packages: node-fetch: 2.6.12 transitivePeerDependencies: - encoding - dev: true /@as-integrations/koa@1.1.1(@apollo/server@4.9.2)(koa@2.14.2): resolution: {integrity: sha512-v84cVhkLUxAH9l19pajbWp/Z9ZYTzO7jkAOiY1xndTclfpXZstiWDKejZYq7xpkBtUSSAKzNyM66uox8MP9qVg==} @@ -3731,7 +3730,6 @@ packages: graphql: 16.8.0 tslib: 2.5.0 value-or-promise: 1.0.12 - dev: true /@graphql-tools/code-file-loader@8.0.1(@babel/core@7.22.10)(graphql@16.8.0): resolution: {integrity: sha512-pmg81lsIXGW3uW+nFSCIG0lFQIxWVbgDjeBkSWlnP8CZsrHTQEkB53DT7t4BHLryoxDS4G4cPxM52yNINDSL8w==} @@ -3764,7 +3762,6 @@ packages: graphql: 16.8.0 tslib: 2.5.0 value-or-promise: 1.0.12 - dev: true /@graphql-tools/delegate@8.8.1(graphql@16.8.0): resolution: {integrity: sha512-NDcg3GEQmdEHlnF7QS8b4lM1PSF+DKeFcIlLEfZFBvVq84791UtJcDj8734sIHLukmyuAxXMfA1qLd2l4lZqzA==} @@ -3796,7 +3793,6 @@ packages: transitivePeerDependencies: - bufferutil - utf-8-validate - dev: true /@graphql-tools/executor-http@1.0.1(@types/node@18.11.9)(graphql@16.8.0): resolution: {integrity: sha512-36D2oxVuv7NboFdPPS9MDOICvsg08P1K9xkqcQTB4UQogkUn58ZFfWM+4cZ9rwfNCIPTIzH4quoj7Xo09xbzmw==} @@ -3814,7 +3810,6 @@ packages: value-or-promise: 1.0.12 transitivePeerDependencies: - '@types/node' - dev: true /@graphql-tools/executor-legacy-ws@1.0.1(graphql@16.8.0): resolution: {integrity: sha512-PQrTJ+ncHMEQspBARc2lhwiQFfRAX/z/CsOdZTFjIljOHgRWGAA1DAx7pEN0j6PflbLCfZ3NensNq2jCBwF46w==} @@ -3831,7 +3826,6 @@ packages: transitivePeerDependencies: - bufferutil - utf-8-validate - dev: true /@graphql-tools/executor@1.1.0(graphql@16.8.0): resolution: {integrity: sha512-+1wmnaUHETSYxiK/ELsT60x584Rw3QKBB7F/7fJ83HKPnLifmE2Dm/K9Eyt6L0Ppekf1jNUbWBpmBGb8P5hAeg==} @@ -3845,7 +3839,6 @@ packages: graphql: 16.8.0 tslib: 2.5.0 value-or-promise: 1.0.12 - dev: true /@graphql-tools/git-loader@8.0.1(@babel/core@7.22.10)(graphql@16.8.0): resolution: {integrity: sha512-ivNtxD+iEfpPONYKip0kbpZMRdMCNR3HrIui8NCURmUdvBYGaGcbB3VrGMhxwZuzc+ybhs2ralPt1F8Oxq2jLA==} @@ -3893,7 +3886,7 @@ packages: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: '@graphql-tools/import': 7.0.0(graphql@16.8.0) - '@graphql-tools/utils': 10.0.0(graphql@16.8.0) + '@graphql-tools/utils': 10.0.3(graphql@16.8.0) globby: 11.1.0 graphql: 16.8.0 tslib: 2.5.0 @@ -3923,7 +3916,7 @@ packages: peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: - '@graphql-tools/utils': 10.0.0(graphql@16.8.0) + '@graphql-tools/utils': 10.0.3(graphql@16.8.0) graphql: 16.8.0 resolve-from: 5.0.0 tslib: 2.5.0 @@ -3939,7 +3932,6 @@ packages: graphql: 16.8.0 tslib: 2.5.0 unixify: 1.0.0 - dev: true /@graphql-tools/load@8.0.0(graphql@16.8.0): resolution: {integrity: sha512-Cy874bQJH0FP2Az7ELPM49iDzOljQmK1PPH6IuxsWzLSTxwTqd8dXA09dcVZrI7/LsN26heTY2R8q2aiiv0GxQ==} @@ -3948,7 +3940,7 @@ packages: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: '@graphql-tools/schema': 10.0.0(graphql@16.8.0) - '@graphql-tools/utils': 10.0.0(graphql@16.8.0) + '@graphql-tools/utils': 10.0.3(graphql@16.8.0) graphql: 16.8.0 p-limit: 3.1.0 tslib: 2.5.0 @@ -3979,7 +3971,7 @@ packages: peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: - '@graphql-tools/utils': 10.0.0(graphql@16.8.0) + '@graphql-tools/utils': 10.0.3(graphql@16.8.0) graphql: 16.8.0 tslib: 2.5.0 @@ -4048,7 +4040,7 @@ packages: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: '@graphql-tools/merge': 9.0.0(graphql@16.8.0) - '@graphql-tools/utils': 10.0.0(graphql@16.8.0) + '@graphql-tools/utils': 10.0.3(graphql@16.8.0) graphql: 16.8.0 tslib: 2.5.0 value-or-promise: 1.0.12 @@ -4102,7 +4094,6 @@ packages: - bufferutil - encoding - utf-8-validate - dev: true /@graphql-tools/utils@10.0.0(graphql@16.8.0): resolution: {integrity: sha512-ndBPc6zgR+eGU/jHLpuojrs61kYN3Z89JyMLwK3GCRkPv4EQn9EOr1UWqF1JO0iM+/jAVHY0mvfUxyrFFN9DUQ==} @@ -4113,6 +4104,7 @@ packages: '@graphql-typed-document-node/core': 3.2.0(graphql@16.8.0) graphql: 16.8.0 tslib: 2.5.0 + dev: true /@graphql-tools/utils@10.0.3(graphql@16.8.0): resolution: {integrity: sha512-6uO41urAEIs4sXQT2+CYGsUTkHkVo/2MpM/QjoHj6D6xoEF2woXHBpdAVi0HKIInDwZqWgEYOwIFez0pERxa1Q==} @@ -4124,7 +4116,6 @@ packages: dset: 3.1.2 graphql: 16.8.0 tslib: 2.5.0 - dev: true /@graphql-tools/utils@8.9.0(graphql@16.8.0): resolution: {integrity: sha512-pjJIWH0XOVnYGXCqej8g/u/tsfV4LvLlj0eATKQu5zwnxd/TiTHq7Cg313qUPTFFHZ3PP5wJ15chYVtLDwaymg==} @@ -4157,7 +4148,6 @@ packages: graphql: 16.8.0 tslib: 2.5.0 value-or-promise: 1.0.12 - dev: true /@graphql-typed-document-node/core@3.2.0(graphql@16.8.0): resolution: {integrity: sha512-mB9oAsNCm9aM3/SOv4YtBMqZbYj10R7dkq8byBqxGY/ncFwhf2oQzMV+LCRlWoDSEBJ3COiR1yeDvMtsoOsuFQ==} @@ -4204,7 +4194,7 @@ packages: http-message-signatures: 0.1.2 httpbis-digest-headers: 1.0.0 jose: 4.13.1 - uuid: 9.0.0 + uuid: 9.0.1 dev: false /@interledger/open-payments@3.0.1: @@ -5127,7 +5117,6 @@ packages: /@repeaterjs/repeater@3.0.4: resolution: {integrity: sha512-AW8PKd6iX3vAZ0vA43nOUOnbq/X5ihgU+mSXXqunMkeQADGiqw/PY0JNeYtD5sr0PAy51YPgAPbDoeapv9r8WA==} - dev: true /@rollup/pluginutils@4.2.1: resolution: {integrity: sha512-iKnFXr7NkdZAIHiIWE+BX5ULi/ucVFYWD6TbAV+rZctiRTY2PL6tsIKhoIOaoskiWAkgu+VsbXgUVDNLHf+InQ==} @@ -5803,7 +5792,6 @@ packages: resolution: {integrity: sha512-6YOoWjruKj1uLf3INHH7D3qTXwFfEsg1kf3c0uDdSBJwfa/llkwIjrAGV7j7mVgGNbzTQ3HiHKKDXl6bJPD97w==} dependencies: '@types/node': 18.11.9 - dev: true /@types/yargs-parser@21.0.0: resolution: {integrity: sha512-iO9ZQHkZxHn4mSakYV0vFHAVDyEOIJQrV2uZ06HxEPcx+mt8swXoZHIbaaJ2crJYFfErySgktuTZ3BeLz+XmFA==} @@ -6228,7 +6216,6 @@ packages: /@whatwg-node/events@0.1.1: resolution: {integrity: sha512-AyQEn5hIPV7Ze+xFoXVU3QTHXVbWPrzaOkxtENMPMuNL6VVHrp4hHfDt9nrQpjO7BgvuM95dMtkycX5M/DZR3w==} engines: {node: '>=16.0.0'} - dev: true /@whatwg-node/fetch@0.8.1(@types/node@18.11.9): resolution: {integrity: sha512-Fkd1qQHK2tAWxKlC85h9L86Lgbq3BzxMnHSnTsnzNZMMzn6Xi+HlN8/LJ90LxorhSqD54td+Q864LgwUaYDj1Q==} @@ -6248,7 +6235,6 @@ packages: dependencies: '@whatwg-node/node-fetch': 0.4.7 urlpattern-polyfill: 9.0.0 - dev: true /@whatwg-node/node-fetch@0.3.0(@types/node@18.11.9): resolution: {integrity: sha512-mPM8WnuHiI/3kFxDeE0SQQXAElbz4onqmm64fEGCwYEcBes2UsvIDI8HwQIqaXCH42A9ajJUPv4WsYoN/9oG6w==} @@ -6272,7 +6258,6 @@ packages: fast-querystring: 1.1.1 fast-url-parser: 1.1.3 tslib: 2.5.0 - dev: true /@wry/context@0.7.3: resolution: {integrity: sha512-Nl8WTesHp89RF803Se9X3IiHjdmLBrIvPMaJkl+rKVJAYyPsz1TEUbu89943HpvujtSJgDUx9W4vZw3K1Mr3sA==} @@ -6631,6 +6616,26 @@ packages: resolution: {integrity: sha512-sRpyiNrx2dEYIMmUXprS8nlpRg2Drs8m9ElX9vVEXaCB4XEAJhKfs7IcX0IwShjuOAjLR6wzIrgoptz1n19i1A==} hasBin: true + /astro-graphql-plugin@0.0.7(astro@2.10.15)(graphql@16.8.0): + resolution: {integrity: sha512-8ktD5lT6Acj1y6hVNHsLDRSmJqQRAaJ8rylZJKLbLzjf29hnrXG/ek5gMP3gT+FAnvMUbBmDwM2m8Q9BPJZ+nA==} + peerDependencies: + astro: ^2.0.0-beta.0 + dependencies: + '@graphql-tools/graphql-file-loader': 8.0.0(graphql@16.8.0) + '@graphql-tools/json-file-loader': 8.0.0(graphql@16.8.0) + '@graphql-tools/load': 8.0.0(graphql@16.8.0) + '@graphql-tools/url-loader': 8.0.0(@types/node@18.11.9)(graphql@16.8.0) + astro: 2.10.15(sharp@0.32.5) + fs-extra: 11.1.1 + marked: 2.0.3 + transitivePeerDependencies: + - '@types/node' + - bufferutil + - encoding + - graphql + - utf-8-validate + dev: false + /astro@2.10.15(sharp@0.32.5): resolution: {integrity: sha512-7jgkCZexxOX541g2kKHGOcDDUVKYc+sGi87GtLOkbWwTsKqEIp9GU0o7DpKe1rhItm9VVEiHz4uxvMh3wGmJdA==} engines: {node: '>=16.12.0', npm: '>=6.14.0'} @@ -7810,7 +7815,6 @@ packages: /dataloader@2.2.2: resolution: {integrity: sha512-8YnDaaf7N3k/q5HnTJVuzSyLETjoZjVmHc4AeKAzOvKHEFQKcn64OKBfzHYtE9zGjctNM7V9I0MfnUVLpi7M5g==} - dev: true /dateformat@4.6.3: resolution: {integrity: sha512-2P0p0pFGzHS5EMnhdxQi7aJN+iMheud0UhG4dlE1DLAlvL8JHjJJTX/CSm4JXwV0Ka5nGk3zC5mcb5bUQUxxMA==} @@ -7908,10 +7912,6 @@ packages: optional: true dev: true - /deep-diff@1.0.2: - resolution: {integrity: sha512-aWS3UIVH+NPGCD1kki+DCU9Dua032iSsO43LqQpcs4R3+dVv7tX0qBGjiVHJHjplsoUM2XRO/KB92glqc68awg==} - dev: false - /deep-equal@1.0.1: resolution: {integrity: sha512-bHtC0iYvWhyaTzvV3CZgPeZQqCOBGyGsVV7v4eevpdkLHfiSrXUdBG+qAuSz4RI70sszvjQ1QSZ98An1yNwpSw==} dev: false @@ -9086,7 +9086,6 @@ packages: /extract-files@11.0.0: resolution: {integrity: sha512-FuoE1qtbJ4bBVvv94CC7s0oTnKUGvQs+Rjf1L2SJFfS+HTVVjhPFtehPdQ0JiGPqVNfSSZvL5yzHHQq2Z4WNhQ==} engines: {node: ^12.20 || >= 14.13} - dev: true /fast-copy@3.0.0: resolution: {integrity: sha512-4HzS+9pQ5Yxtv13Lhs1Z1unMXamBdn5nA4bEi1abYpDNSpSp7ODYQ1KPMF6nTatfEzgH6/zPvXKU1zvHiUjWlA==} @@ -9094,7 +9093,6 @@ packages: /fast-decode-uri-component@1.0.1: resolution: {integrity: sha512-WKgKWg5eUxvRZGwW8FvfbaH7AXSh2cL+3j5fMGzUMCxWBJ3dV3a7Wz8y2f/uQ0e3B6WmodD3oS54jTQ9HVTIIg==} - dev: true /fast-deep-equal@3.1.3: resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} @@ -9146,7 +9144,6 @@ packages: resolution: {integrity: sha512-qR2r+e3HvhEFmpdHMv//U8FnFlnYjaC6QKDuaXALDkw2kvHO8WDjxH+f/rHGR4Me4pnk8p9JAkRNTjYHAKRn2Q==} dependencies: fast-decode-uri-component: 1.0.1 - dev: true /fast-redact@3.1.2: resolution: {integrity: sha512-+0em+Iya9fKGfEQGcd62Yv6onjBmmhV1uh86XVfOU8VwAe6kaFdQCWI9s0/Nnugx5Vd9tdbZ7e6gE2tR9dzXdw==} @@ -9161,7 +9158,6 @@ packages: resolution: {integrity: sha512-5jOCVXADYNuRkKFzNJ0dCCewsZiYo0dz8QNYljkOpFC6r2U4OBmKtvm/Tsuh4w1YYdDqDb31a8TVhBJ2OJKdqQ==} dependencies: punycode: 1.4.1 - dev: true /fastq@1.13.0: resolution: {integrity: sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==} @@ -9344,6 +9340,15 @@ packages: universalify: 2.0.0 dev: true + /fs-extra@11.1.1: + resolution: {integrity: sha512-MGIE4HOvQCeUCzmlHs0vXpih4ysz4wg9qiSAu6cd42lVwPbTM1TjV7RusoyQqMmk/95gdQZX72u+YW+c3eEpFQ==} + engines: {node: '>=14.14'} + dependencies: + graceful-fs: 4.2.10 + jsonfile: 6.1.0 + universalify: 2.0.0 + dev: false + /fs-extra@8.1.0: resolution: {integrity: sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==} engines: {node: '>=6 <7 || >=8'} @@ -9657,23 +9662,6 @@ packages: - utf-8-validate dev: true - /graphql-markdown@7.0.0(graphql@16.8.0): - resolution: {integrity: sha512-gJoc1gKxmZNa8gtUnR6a694Unm3QYGTX8we3DH/xvj0BavJWcGB+MNlg7A6PeP/BwcO9DpMIO+ElcrOOS+8R0g==} - engines: {node: '>=14.0.0'} - hasBin: true - peerDependencies: - graphql: ^14.0.2 || ^15.0.0 || ^16.0.0 - dependencies: - deep-diff: 1.0.2 - graphql: 16.8.0 - lodash.isplainobject: 4.0.6 - minimist: 1.2.6 - node-fetch: 2.6.12 - resolve-from: 5.0.0 - transitivePeerDependencies: - - encoding - dev: false - /graphql-middleware@6.1.35(graphql@16.8.0): resolution: {integrity: sha512-azawK7ApUYtcuPGRGBR9vDZu795pRuaFhO5fgomdJppdfKRt7jwncuh0b7+D3i574/4B+16CNWgVpnGVlg3ZCg==} peerDependencies: @@ -9722,7 +9710,6 @@ packages: graphql: '>=0.11 <=16' dependencies: graphql: 16.8.0 - dev: true /graphql@16.8.0: resolution: {integrity: sha512-0oKGaR+y3qcS5mCu1vb7KG+a89vjn06C7Ihq/dDl3jA+A8B3TKomvi3CiEcVLJQGalbu8F52LxkOym7U5sSfbg==} @@ -10699,7 +10686,6 @@ packages: ws: '*' dependencies: ws: 8.13.0 - dev: true /isstream@0.1.2: resolution: {integrity: sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g==} @@ -11443,7 +11429,6 @@ packages: universalify: 2.0.0 optionalDependencies: graceful-fs: 4.2.10 - dev: true /jsonify@0.0.0: resolution: {integrity: sha512-trvBk1ki43VZptdBI5rIlG4YOzyeH/WefQt5rj1grasPn4iiZWKet8nkgc4GlsAylaztn0qZfUYOiTsASJFdNA==} @@ -11761,6 +11746,7 @@ packages: /lodash.isplainobject@4.0.6: resolution: {integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA==} + dev: true /lodash.memoize@4.1.2: resolution: {integrity: sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==} @@ -11902,6 +11888,12 @@ packages: resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} dev: false + /marked@2.0.3: + resolution: {integrity: sha512-5otztIIcJfPc2qGTN8cVtOJEjNJZ0jwa46INMagrYfk0EvqtRuEHLsEe0LrFS0/q+ZRKT0+kXK7P2T1AN5lWRA==} + engines: {node: '>= 8.16.2'} + hasBin: true + dev: false + /mathjax-full@3.2.2: resolution: {integrity: sha512-+LfG9Fik+OuI8SLwsiR02IVdjcnRCy5MufYLi0C3TdMT56L/pjB0alMVGgoWJF8pN9Rc7FESycZB9BMNWIid5w==} dependencies: @@ -12198,7 +12190,6 @@ packages: optional: true dependencies: '@types/node': 18.11.9 - dev: true /methods@1.1.2: resolution: {integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==} @@ -14086,7 +14077,6 @@ packages: /punycode@1.4.1: resolution: {integrity: sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==} - dev: true /punycode@2.1.1: resolution: {integrity: sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==} @@ -16079,7 +16069,6 @@ packages: /universalify@2.0.0: resolution: {integrity: sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==} engines: {node: '>= 10.0.0'} - dev: true /unixify@1.0.0: resolution: {integrity: sha512-6bc58dPYhCMHHuwxldQxO3RRNZ4eCogZ/st++0+fcC1nr0jiGUtAdBJ2qzmLQWSxbtz42pWt4QQMiZ9HvZf5cg==} @@ -16131,7 +16120,6 @@ packages: /urlpattern-polyfill@9.0.0: resolution: {integrity: sha512-WHN8KDQblxd32odxeIgo83rdVDE2bvdkb86it7bMhYZwWKJz0+O0RK/eZiHYnM+zgt/U7hAHOlCQGfjjvSkw2g==} - dev: true /util-deprecate@1.0.2: resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} @@ -16161,11 +16149,6 @@ packages: hasBin: true dev: false - /uuid@9.0.0: - resolution: {integrity: sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg==} - hasBin: true - dev: false - /uuid@9.0.1: resolution: {integrity: sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA==} hasBin: true