Merge pull request #230 from interledger/224/mk/post-quote-update

224/mk/post quote update
interledger · Dec 9, 2022 · ae0e924 · ae0e924
2 parents 54f4bdc + a1f363d
commit ae0e924
Showing 1 changed file with 31 additions and 11 deletions.
diff --git a/openapi/resource-server.yaml b/openapi/resource-server.yaml
@@ -576,17 +576,37 @@ paths:
                     assetCode: USD
                     assetScale: 2
             schema:
-              type: object
-              additionalProperties: false
-              properties:
-                receiver:
-                  $ref: ./schemas.yaml#/components/schemas/receiver
-                receiveAmount:
-                  $ref: ./schemas.yaml#/components/schemas/amount
-                sendAmount:
-                  $ref: ./schemas.yaml#/components/schemas/amount
-              required:
-                - receiver
+              oneOf:
+                - description: Create quote for an `receiver` that is an Incoming Payment with an `incomingAmount`
+                  properties:
+                    receiver:
+                      $ref: ./schemas.yaml#/components/schemas/receiver
+                  required:
+                    - receiver
+                  additionalProperties: false
+                - description: Create a quote with a fixed-receive amount
+                  properties:
+                    receiver:
+                      $ref: ./schemas.yaml#/components/schemas/receiver
+                    receiveAmount:
+                      description: The fixed amount that would be paid into the receiving payment pointer given a successful outgoing payment.
+                      $ref: ./schemas.yaml#/components/schemas/amount
+                  required:
+                    - receiver
+                    - receiveAmount
+                  additionalProperties: false
+                - description: Create a quote with a fixed send amount
+                  properties:
+                    receiver:
+                      $ref: ./schemas.yaml#/components/schemas/receiver
+                    sendAmount:
+                      description: The fixed amount that would be sent from the sending payment pointer given a successful outgoing payment.
+                      $ref: ./schemas.yaml#/components/schemas/amount
+                  required:
+                    - receiver
+                    - sendAmount
+                  additionalProperties: false
+
         description: |-
           A subset of the quotes schema is accepted as input to create a new quote.