feat: remove query param from paths already with unique id

interledger · Oct 11, 2023 · 8b42dfc · 8b42dfc
1 parent e860b72
commit 8b42dfc
Show file tree

Hide file tree

Showing 11 changed files with 103 additions and 168 deletions.
diff --git a/openapi/resource-server.yaml b/openapi/resource-server.yaml
@@ -671,7 +671,6 @@ paths:
       description: A client can fetch the latest state of an incoming payment to determine the amount received into the wallet address.
     parameters:
       - $ref: '#/components/parameters/id'
-      - $ref: '#/components/parameters/wallet-address'
   '/incoming-payments/{id}/complete':
     post:
       summary: Complete an Incoming Payment
@@ -712,21 +711,6 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           description: Incoming Payment Not Found
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              additionalProperties: false
-              properties:
-                walletAddress:
-                  $ref: ./schemas.yaml#/components/schemas/walletAddress
-              required:
-                - walletAddress
-            examples:
-              Complete incoming payment for https://openpayments.guide/alice:
-                value:
-                  walletAddress: 'https://openpayments.guide/alice/'
       description: |-
         A client with the appropriate permissions MAY mark a non-expired **incoming payment** as `completed` indicating that the client is not going to make any further payments toward this **incoming payment**, even though the full `incomingAmount` may not have been received.
 
@@ -785,7 +769,6 @@ paths:
         - $ref: '#/components/parameters/signature'
     parameters:
       - $ref: '#/components/parameters/id'
-      - $ref: '#/components/parameters/wallet-address'
   '/quotes/{id}':
     get:
       summary: Get a Quote

diff --git a/packages/open-payments/src/client/grant.ts b/packages/open-payments/src/client/grant.ts
@@ -2,7 +2,7 @@ import { HttpMethod } from '@interledger/openapi'
 import {
   GrantOrTokenRequestArgs,
   RouteDeps,
-  UnauthenticatedRequestArgs
+  UnauthenticatedResourceRequestArgs
 } from '.'
 import {
   getASPath,
@@ -19,7 +19,7 @@ export interface GrantRouteDeps extends RouteDeps {
 
 export interface GrantRoutes {
   request(
-    postArgs: UnauthenticatedRequestArgs,
+    postArgs: UnauthenticatedResourceRequestArgs,
     args: Omit<GrantRequest, 'client'>
   ): Promise<PendingGrant | Grant>
   continue(
@@ -47,7 +47,7 @@ export const createGrantRoutes = (deps: GrantRouteDeps): GrantRoutes => {
 
   return {
     request: (
-      { url }: UnauthenticatedRequestArgs,
+      { url }: UnauthenticatedResourceRequestArgs,
       args: Omit<GrantRequest, 'client'>
     ) =>
       post(

diff --git a/packages/open-payments/src/client/incoming-payment.test.ts b/packages/open-payments/src/client/incoming-payment.test.ts
@@ -56,15 +56,13 @@ describe('incoming-payment', (): void => {
 
       nock(serverAddress)
         .get('/incoming-payments/1')
-        .query({ 'wallet-address': walletAddress })
         .reply(200, incomingPayment)
 
       const result = await getIncomingPayment(
         { axiosInstance, logger },
         {
           url: `${serverAddress}/incoming-payments/1`,
-          accessToken,
-          walletAddress
+          accessToken
         },
         openApiValidators.successfulValidator
       )
@@ -87,7 +85,6 @@ describe('incoming-payment', (): void => {
 
       nock(serverAddress)
         .get('/incoming-payments/1')
-        .query({ 'wallet-address': walletAddress })
         .reply(200, incomingPayment)
 
       await expect(
@@ -98,8 +95,7 @@ describe('incoming-payment', (): void => {
           },
           {
             url: `${serverAddress}/incoming-payments/1`,
-            accessToken,
-            walletAddress
+            accessToken
           },
           openApiValidators.successfulValidator
         )
@@ -122,8 +118,7 @@ describe('incoming-payment', (): void => {
           },
           {
             url: `${serverAddress}/incoming-payments/1`,
-            accessToken,
-            walletAddress
+            accessToken
           },
           openApiValidators.failedValidator
         )
@@ -191,9 +186,10 @@ describe('incoming-payment', (): void => {
 
         const result = await createIncomingPayment(
           { axiosInstance, logger },
-          { url: serverAddress, walletAddress, accessToken },
+          { url: serverAddress, accessToken },
           openApiValidators.successfulValidator,
           {
+            walletAddress,
             incomingAmount,
             expiresAt,
             metadata
@@ -225,9 +221,9 @@ describe('incoming-payment', (): void => {
       await expect(
         createIncomingPayment(
           { axiosInstance, logger },
-          { url: serverAddress, walletAddress, accessToken },
+          { url: serverAddress, accessToken },
           openApiValidators.successfulValidator,
-          {}
+          { walletAddress }
         )
       ).rejects.toThrowError()
       scope.done()
@@ -243,9 +239,9 @@ describe('incoming-payment', (): void => {
       await expect(
         createIncomingPayment(
           { axiosInstance, logger },
-          { url: serverAddress, walletAddress, accessToken },
+          { url: serverAddress, accessToken },
           openApiValidators.failedValidator,
-          {}
+          { walletAddress }
         )
       ).rejects.toThrowError()
       scope.done()
@@ -266,8 +262,7 @@ describe('incoming-payment', (): void => {
         { axiosInstance, logger },
         {
           url: `${serverAddress}/incoming-payments/${incomingPayment.id}`,
-          accessToken,
-          walletAddress
+          accessToken
         },
         openApiValidators.successfulValidator
       )
@@ -291,8 +286,7 @@ describe('incoming-payment', (): void => {
           { axiosInstance, logger },
           {
             url: `${serverAddress}/incoming-payments/${incomingPayment.id}`,
-            accessToken,
-            walletAddress
+            accessToken
           },
           openApiValidators.successfulValidator
         )
@@ -315,8 +309,7 @@ describe('incoming-payment', (): void => {
           { axiosInstance, logger },
           {
             url: `${serverAddress}/incoming-payments/${incomingPayment.id}`,
-            accessToken,
-            walletAddress
+            accessToken
           },
           openApiValidators.failedValidator
         )
@@ -670,7 +663,7 @@ describe('incoming-payment', (): void => {
           openApi,
           axiosInstance,
           logger
-        }).get({ url, accessToken, walletAddress })
+        }).get({ url, accessToken })
 
         expect(getSpy).toHaveBeenCalledWith(
           {
@@ -679,11 +672,7 @@ describe('incoming-payment', (): void => {
           },
           {
             url,
-            accessToken,
-            walletAddress,
-            queryParams: {
-              'wallet-address': walletAddress
-            }
+            accessToken
           },
           true
         )
@@ -695,7 +684,7 @@ describe('incoming-payment', (): void => {
         const mockResponseValidator = ({ path, method }) =>
           path === '/incoming-payments/{id}' && method === HttpMethod.GET
 
-        const url = `${walletAddress}/incoming-payments/1`
+        const url = `${serverAddress}/incoming-payments/1`
 
         jest
           .spyOn(openApi, 'createResponseValidator')
@@ -712,7 +701,7 @@ describe('incoming-payment', (): void => {
           openApi,
           axiosInstance,
           logger
-        }).getPublic({ accessToken, url })
+        }).getPublic({ url })
 
         expect(getSpy).toHaveBeenCalledWith(
           {
@@ -775,6 +764,7 @@ describe('incoming-payment', (): void => {
 
         const url = `${serverAddress}/incoming-payments`
         const incomingPaymentCreateArgs = {
+          walletAddress,
           description: 'Invoice',
           incomingAmount: { assetCode: 'USD', assetScale: 2, value: '10' }
         }
@@ -793,7 +783,7 @@ describe('incoming-payment', (): void => {
           axiosInstance,
           logger
         }).create(
-          { url: serverAddress, walletAddress, accessToken },
+          { url: serverAddress, accessToken },
           incomingPaymentCreateArgs
         )
 
@@ -829,7 +819,7 @@ describe('incoming-payment', (): void => {
           openApi,
           axiosInstance,
           logger
-        }).complete({ url: incomingPaymentUrl, accessToken, walletAddress })
+        }).complete({ url: incomingPaymentUrl, accessToken })
 
         expect(postSpy).toHaveBeenCalledWith(
           {
@@ -838,10 +828,7 @@ describe('incoming-payment', (): void => {
           },
           {
             url: `${incomingPaymentUrl}/complete`,
-            accessToken,
-            body: {
-              walletAddress
-            }
+            accessToken
           },
           true
         )
@@ -854,7 +841,7 @@ describe('incoming-payment', (): void => {
         const mockResponseValidator = ({ path, method }) =>
           path === '/incoming-payments/{id}' && method === HttpMethod.GET
 
-        const url = `${walletAddress}/incoming-payments/1`
+        const url = `${serverAddress}/incoming-payments/1`
 
         jest
           .spyOn(openApi, 'createResponseValidator')