Skip to content

Commit a3c2886

Browse files
authored
docs: fixing open payments links (#3462)
After restructuring the Open Payments docs, several of the links in the Rafiki docs would be broken without this fix
1 parent 9510f99 commit a3c2886

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

packages/documentation/src/content/docs/integration/deployment/services/auth-service.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ When a request comes from a client with an account known to your local instance
3232

3333
When a request comes from a client registered with another instance of Rafiki, the `auth` service resolves the client's key endpoint (for example, `https://wallet.example.com/alice/jwks.json`) to retrieve the client's public keys, then filters out the correct key using the key id (`kid`) in the client's signature.
3434

35-
Review the <LinkOut href="https://openpayments.dev/introduction/client-keys/">Open Payments documentation</LinkOut> for more information about client keys.
35+
Review the <LinkOut href="https://openpayments.dev/identity/client-keys/">Open Payments documentation</LinkOut> for more information about client keys.
3636

3737
## Identity provider (IdP)
3838

@@ -44,7 +44,7 @@ You must integrate with an [IdP](/integration/requirements/open-payments/idp) wh
4444
Rafiki’s [`frontend`](/integration/deployment/services/frontend-service) service requires an IdP for authentication and user management of your [Rafiki Admin](/admin/admin-user-guide) users. Out of the box, Rafiki uses Ory Kratos, a cloud-based user management system. Kratos is for internal use only and **cannot** be used as your customer-facing Open Payments authorization server.
4545
:::
4646

47-
For more information about interactive grants and how they work with identity providers, review the [Identity Provider](/integration/requirements/open-payments/idp) page and the <LinkOut href="https://openpayments.dev/introduction/grants/">Grant negotiation and authorization</LinkOut> page in the Open Payments docs.
47+
For more information about interactive grants and how they work with identity providers, review the [Identity Provider](/integration/requirements/open-payments/idp) page and the <LinkOut href="https://openpayments.dev/identity/grants/">Grant negotiation and authorization</LinkOut> page in the Open Payments docs.
4848

4949
## GraphQL Auth Admin API
5050

packages/documentation/src/content/docs/integration/deployment/services/backend-service.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You must also set the environment variables for the `backend` service.
2929

3030
The `backend` service exposes the Open Payments APIs, which are auth-protected using an opinionated version of the Grant Negotiation and Authorization Protocol (GNAP). Review the [`auth`](/integration/deployment/services/auth-service) service page for more details about grant authorization and authentication.
3131

32-
The `backend` service allows you to manage Open Payments <LinkOut href="https://openpayments.dev/introduction/op-concepts/#incoming-payment">incoming payments</LinkOut>, <LinkOut href="https://openpayments.dev/introduction/op-concepts/#quote">quotes</LinkOut>, and <LinkOut href='https://openpayments.dev/introduction/op-concepts/#outgoing-payment'>outgoing payments</LinkOut>. Quotes and outgoing payments call the ILP connector, described in the next section, to send ILP packets. Quoting sends unfulfillable probe packets, for example to determine a transaction’s cost before executing the payment. Outgoing payments send packets as part of executing the payment.
32+
The `backend` service allows you to manage Open Payments <LinkOut href="https://openpayments.dev/concepts/resources/#incoming-payment">incoming payments</LinkOut>, <LinkOut href="https://openpayments.dev/concepts/resources/#quote">quotes</LinkOut>, and <LinkOut href='https://openpayments.dev/concepts/resources/#outgoing-payment'>outgoing payments</LinkOut>. Quotes and outgoing payments call the ILP connector, described in the next section, to send ILP packets. Quoting sends unfulfillable probe packets, for example to determine a transaction’s cost before executing the payment. Outgoing payments send packets as part of executing the payment.
3333

3434
## Interledger connector
3535

packages/documentation/src/content/docs/integration/playground/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ The sequence of steps outlined below corresponds to the interactions depicted in
331331

332332
:::note
333333

334-
You have to go through an interaction flow by selecting the `redirect` link in the grant request's response. More information about the interaction flow can be found <LinkOut href ='https://openpayments.dev/introduction/grants/'>here</LinkOut>.
334+
You have to go through an interaction flow by selecting the `redirect` link in the grant request's response. More information about the interaction flow can be found <LinkOut href ='https://openpayments.dev/identity/grants/'>here</LinkOut>.
335335
:::
336336

337337
8. Continues the grant request

packages/documentation/src/content/docs/integration/requirements/open-payments/idp.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ We provide Ory Kratos, a cloud-based user management system, for the identity an
2424

2525
In Open Payments, grants indicate a resource owner, such as an account holder, has given a piece of software, such as a mobile app, permission (consent) to act on their behalf.
2626

27-
Rafiki's implementation of an Open Payments authorization server requires that consent is collected via an interactive grant before an <LinkOut href="https://openpayments.dev/introduction/op-concepts/#outgoing-payment">outgoing payment</LinkOut> request is issued. A grant is interactive when explicit interaction by a resource owner (for example, the software's end user) is required to approve or deny the grant. Tapping an _Approve_ button to authorize a payment is an example of an explicit interaction.
27+
Rafiki's implementation of an Open Payments authorization server requires that consent is collected via an interactive grant before an <LinkOut href="https://openpayments.dev/concepts/resources/#outgoing-payment">outgoing payment</LinkOut> request is issued. A grant is interactive when explicit interaction by a resource owner (for example, the software's end user) is required to approve or deny the grant. Tapping an _Approve_ button to authorize a payment is an example of an explicit interaction.
2828

2929
Interactive grants can be optional for incoming payments and quotes; however, they're enabled by default in Rafiki (the `LIST_ALL_ACCESS_INTERACTION` environment variable is `true`). When a grant request includes a `list-all` action for incoming payments and quotes, the request requires interaction. The `list-all` action is used when the client asks to list resources that it did not create.
3030

@@ -33,7 +33,7 @@ If `LIST_ALL_ACCESS_INTERACTION` is `false`, you can still force interactive gra
3333
- `QUOTE_INTERACTION`
3434
- `INCOMING_PAYMENT_INTERACTION`
3535

36-
See the <LinkOut href="https://openpayments.dev/introduction/grants/">Open Payments documentation</LinkOut> for more information on grant negotiation and authorization.
36+
See the <LinkOut href="https://openpayments.dev/identity/grants/">Open Payments documentation</LinkOut> for more information on grant negotiation and authorization.
3737

3838
## Authorization servers
3939

packages/documentation/src/content/docs/integration/requirements/open-payments/wallet-keys.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'
88

99
Creating a public-private key pair for each wallet address is not required when integrating with Rafiki.
1010

11-
You only need to create key pairs for wallet addresses if you want to allow your account holders to use/be Open Payments clients under their wallet addresses. For more information, review the Open Payments documentation about <LinkOut href="https://openpayments.dev/resources/glossary/#client">clients</LinkOut> and <LinkOut href="https://openpayments.dev/introduction/client-keys/">client keys</LinkOut>.
11+
You only need to create key pairs for wallet addresses if you want to allow your account holders to use/be Open Payments clients under their wallet addresses. For more information, review the Open Payments documentation about <LinkOut href="https://openpayments.dev/resources/glossary/#client">clients</LinkOut> and <LinkOut href="https://openpayments.dev/identity/client-keys/">client keys</LinkOut>.
1212

1313
## Create a wallet address key pair
1414

packages/documentation/src/content/docs/overview/concepts/open-payments.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tableOfContents:
66

77
import { LinkOut } from '@interledger/docs-design-system'
88

9-
Rafiki follows the <LinkOut href='https://openpayments.dev'>Open Payments</LinkOut> standard to enable third-party clients to securely retrieve account information and initiate payments from your customers’ accounts with their consent. The standard describes a uniform way to create and manage grants and resources for <LinkOut href='https://openpayments.dev/introduction/op-concepts/#resource-types'>incoming payments, quotes, and outgoing payments</LinkOut>.
9+
Rafiki follows the <LinkOut href='https://openpayments.dev'>Open Payments</LinkOut> standard to enable third-party clients to securely retrieve account information and initiate payments from your customers’ accounts with their consent. The standard describes a uniform way to create and manage grants and resources for <LinkOut href='https://openpayments.dev/concepts/resources/#resource-types'>incoming payments, quotes, and outgoing payments</LinkOut>.
1010

1111
### Example use case - retrieve account information
1212

@@ -16,16 +16,16 @@ Some of your customers use a third-party application that allows them to create
1616

1717
We strongly encourage you to familiarize yourself with the Open Payments standard. Extensive documentation is available on the <LinkOut href="https://openpayments.dev">Open Payments</LinkOut> website. We recommend you start by reviewing all the pages within the _Intro to Open Payments_ section. Here are a few links to get you started.
1818

19-
- <LinkOut href='https://openpayments.dev/introduction/op-concepts/'>
20-
Open Payments concepts
19+
- <LinkOut href='https://openpayments.dev/overview/getting-started/'>
20+
Getting started with Open Payments
2121
</LinkOut>
22-
- <LinkOut href='https://openpayments.dev/introduction/client-keys/'>
22+
- <LinkOut href='https://openpayments.dev/identity/client-keys/'>
2323
Client keys
2424
</LinkOut>
25-
- <LinkOut href='https://openpayments.dev/introduction/http-signatures/'>
25+
- <LinkOut href='https://openpayments.dev/identity/http-signatures/'>
2626
HTTP message signatures
2727
</LinkOut>
28-
- <LinkOut href='https://openpayments.dev/introduction/grants/'>
28+
- <LinkOut href='https://openpayments.dev/identity/grants/'>
2929
Grant negotiation and authorization
3030
</LinkOut>
3131

@@ -35,4 +35,4 @@ Rafiki’s [`backend`](/integration/deployment/services/backend-service) service
3535

3636
## Rafiki's auth service
3737

38-
Rafiki’s [`auth`](/integration/deployment/services/auth-service) service is a reference implementation of an opinionated Open Payments authorization server. The authorization server is responsible for delegating authorization (via grants) to clients to use the Open Payments APIs, resolving <LinkOut href="https://openpayments.dev/introduction/client-keys/">clients’ public keys</LinkOut> to authenticate and authorize incoming requests, and creating payments and quotes on the backend. Open Payments leverages the Grant Negotiation and Authorization Protocol (GNAP) for delegating authorization. You can learn more about the protocol by reviewing its <LinkOut href="https://datatracker.ietf.org/doc/html/draft-ietf-gnap-core-protocol">specification</LinkOut>.
38+
Rafiki’s [`auth`](/integration/deployment/services/auth-service) service is a reference implementation of an opinionated Open Payments authorization server. The authorization server is responsible for delegating authorization (via grants) to clients to use the Open Payments APIs, resolving <LinkOut href="https://openpayments.dev/identity/client-keys/">clients’ public keys</LinkOut> to authenticate and authorize incoming requests, and creating payments and quotes on the backend. Open Payments leverages the Grant Negotiation and Authorization Protocol (GNAP) for delegating authorization. You can learn more about the protocol by reviewing its <LinkOut href="https://datatracker.ietf.org/doc/html/draft-ietf-gnap-core-protocol">specification</LinkOut>.

0 commit comments

Comments
 (0)