Assorted fixes for the spec (#40)

pdp2121 · web-flow · commit 31db4dc4013a · 2025-03-27T10:07:46.000-04:00
diff --git a/docs/contributing/validation-rules-appendix.md b/docs/contributing/validation-rules-appendix.md
@@ -74,6 +74,7 @@ Reference: [Swagger OpenAPI Extensions](https://swagger.io/docs/specification/v3
 Users can define custom validations using vendor extensions (`x-custom-validation`), which allow adding extra constraints beyond standard OpenAPI rules.
 
 Custom validations can be applied on:
+
 1. Specific property
 2. Rules involving combinations of properties
 
@@ -249,7 +250,7 @@ Verifies requiredFields must be specified if dependentField is not empty.
 x-custom-validation:
   dependentPresence:
     - dependentField: { { fieldname } }
-      requiredFields: 
+      requiredFields:
         - { { fieldname } }
         - { { fieldname } }
 ```
@@ -317,11 +318,11 @@ Verify at least one within a set of fields is required.
 
 ```yaml
 x-custom-validation:
-    requireOneOf:
-      - fields:
-          - {{fieldname}}
-          - {{fieldname}}
-        message: 'Require at-least one of these fields.'
+  requireOneOf:
+    - fields:
+        - { { fieldname } }
+        - { { fieldname } }
+      message: 'Require at-least one of these fields.'
 ```
 
 **Example:**
@@ -335,7 +336,6 @@ x-custom-validation:
       message: 'Require at-least one of these LPTokenOut or Amount.'
 ```
 
-
 ### **requireExactlyOne**
 
 Verifies that exactly one field is present.
@@ -344,11 +344,11 @@ Verifies that exactly one field is present.
 
 ```yaml
 x-custom-validation:
-    requireExactlyOne:
-      - fields:
-          - {{fieldname}}
-          - {{fieldname}}
-        message: 'Exactly one field must be present.'
+  requireExactlyOne:
+    - fields:
+        - { { fieldname } }
+        - { { fieldname } }
+      message: 'Exactly one field must be present.'
 ```
 
 **Example:**
@@ -364,7 +364,6 @@ x-custom-validation:
       message: 'You must provide exactly one of Authorize, AuthorizeCredentials, Unauthorize, or UnauthorizeCredentials.'
 ```
 
-
 ### **conditionalRequiredOnFlag / conditionalForbiddenOnFlag**
 
 Verifies a field must (must not) be set if a flag is set/not set.
@@ -384,7 +383,6 @@ conditionalRequiredOnFlag:
 
 **Example (conditionalForbiddenOnFlag):**
 
-
 If asfAuthorizedNFTokenMinter is not set on SetFlag then NFTokenMinter field must be absent.
 
 ```yaml
@@ -416,7 +414,6 @@ conditionalGreaterThanOnFlag:
 
 **Example (conditionalLessThanOnFlag):**
 
-
 If tfSellNFToken is set on Flags then Amount field must be less than 0.
 
 ```yaml
@@ -429,6 +426,32 @@ conditionalLessThanOnFlag:
     message: 'Must be less than 0.'
 ```
 
+### **flagConflict**
+
+Verifies that only one flag in the list can be set.
+
+**Structure:**
+
+```yaml
+x-custom-validation:
+  flagConflict:
+    - flagField: Flags
+      flags:
+        - { { flag1 } }
+        - { { flag2 } }
+```
+
+**Example:**
+
+```yaml
+x-custom-validation:
+  flagConflict:
+    - flagField: Flags
+      flags:
+        - tfMPTLock
+        - tfMPTUnlock
+```
+
 ### **matchingCurrencyType**
 
 Verifies two amount fields must be XRP-XRP or IOU-IOU.
diff --git a/shared/base.yaml b/shared/base.yaml
@@ -221,10 +221,23 @@ components:
         The XRP Ledger has two kinds of money: XRP, and issued currencies. Both types have high precision, although their
         formats are different.
       oneOf:
-        - type: string
-          description: 'XRP represented as a string.'
+        - $ref: '#/components/schemas/XRP'
         - $ref: '#/components/schemas/IssuedCurrency'
 
+    XRP:
+      $id: XRP
+      properties:
+        currency:
+          type: string
+          description: ^
+            Specifies XRP as a currency, without a value. Normally, you will not use this
+            model as it does not specify an amount of XRP. In cases where you need to
+            specify an amount of XRP, you will use a string. However, for some book order
+            requests where currencies are specified without amounts, you may need to
+            specify the use of XRP, without a value. In these cases, you will use this
+            object.
+          default: XRP
+
     IssuedCurrency:
       $id: IssuedCurrency
       type: object
diff --git a/shared/requests/submit.yaml b/shared/requests/submit.yaml
@@ -114,6 +114,7 @@ components:
               XChainCommit: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
               XChainCreateBridge: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
               XChainModifyBridge: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+              OracleDelete: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransaction'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -161,6 +162,7 @@ components:
             - $ref: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
             - $ref: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
             - $ref: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+            - $ref: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
             # TODO: Add other transaction types here
 
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
@@ -223,6 +225,7 @@ components:
               XChainCommit: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
               XChainCreateBridge: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
               XChainModifyBridge: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+              OracleDelete: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransaction'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -270,6 +273,7 @@ components:
             - $ref: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
             - $ref: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
             - $ref: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+            - $ref: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
             # TODO: Add other transaction types here
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
       required:
@@ -353,6 +357,7 @@ components:
               AMMBid: '../transactions/amm_bid.yaml#/components/schemas/AMMBidTransaction'
               AMMCreate: '../transactions/amm_create.yaml#/components/schemas/AMMCreateTransaction'
               AMMDeposit: '../transactions/amm_deposit.yaml#/components/schemas/AMMDepositTransaction'
+              AMMDelete: '../transactions/amm_delete.yaml#/components/schemas/AMMDeleteTransaction'
               AMMVote: '../transactions/amm_vote.yaml#/components/schemas/AMMVoteTransaction'
               AMMWithdraw: '../transactions/amm_withdraw.yaml#/components/schemas/AMMWithdrawTransaction'
               CredentialAccept: '../transactions/credential_accept.yaml#/components/schemas/CredentialAcceptTransaction'
@@ -391,6 +396,7 @@ components:
               XChainCommit: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
               XChainCreateBridge: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
               XChainModifyBridge: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+              OracleDelete: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransaction'
@@ -401,6 +407,7 @@ components:
             - $ref: '../transactions/amm_bid.yaml#/components/schemas/AMMBidTransaction'
             - $ref: '../transactions/amm_create.yaml#/components/schemas/AMMCreateTransaction'
             - $ref: '../transactions/amm_deposit.yaml#/components/schemas/AMMDepositTransaction'
+            - $ref: '../transactions/amm_delete.yaml#/components/schemas/AMMDeleteTransaction'
             - $ref: '../transactions/amm_vote.yaml#/components/schemas/AMMVoteTransaction'
             - $ref: '../transactions/amm_withdraw.yaml#/components/schemas/AMMWithdrawTransaction'
             - $ref: '../transactions/credential_accept.yaml#/components/schemas/CredentialAcceptTransaction'
@@ -439,6 +446,7 @@ components:
             - $ref: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
             - $ref: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
             - $ref: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+            - $ref: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
             # TODO: Add other transaction types here
 
     SubmitSuccessResponseV2:
@@ -458,6 +466,7 @@ components:
               AMMBid: '../transactions/amm_bid.yaml#/components/schemas/AMMBidTransaction'
               AMMCreate: '../transactions/amm_create.yaml#/components/schemas/AMMCreateTransaction'
               AMMDeposit: '../transactions/amm_deposit.yaml#/components/schemas/AMMDepositTransaction'
+              AMMDelete: '../transactions/amm_delete.yaml#/components/schemas/AMMDeleteTransaction'
               AMMVote: '../transactions/amm_vote.yaml#/components/schemas/AMMVoteTransaction'
               AMMWithdraw: '../transactions/amm_withdraw.yaml#/components/schemas/AMMWithdrawTransaction'
               CredentialAccept: '../transactions/credential_accept.yaml#/components/schemas/CredentialAcceptTransaction'
@@ -496,6 +505,7 @@ components:
               XChainCommit: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
               XChainCreateBridge: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
               XChainModifyBridge: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+              OracleDelete: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransaction'
@@ -506,6 +516,7 @@ components:
             - $ref: '../transactions/amm_bid.yaml#/components/schemas/AMMBidTransaction'
             - $ref: '../transactions/amm_create.yaml#/components/schemas/AMMCreateTransaction'
             - $ref: '../transactions/amm_deposit.yaml#/components/schemas/AMMDepositTransaction'
+            - $ref: '../transactions/amm_delete.yaml#/components/schemas/AMMDeleteTransaction'
             - $ref: '../transactions/amm_vote.yaml#/components/schemas/AMMVoteTransaction'
             - $ref: '../transactions/amm_withdraw.yaml#/components/schemas/AMMWithdrawTransaction'
             - $ref: '../transactions/credential_accept.yaml#/components/schemas/CredentialAcceptTransaction'
@@ -544,6 +555,7 @@ components:
             - $ref: '../transactions/xchain_commit.yaml#/components/schemas/XChainCommitTransaction'
             - $ref: '../transactions/xchain_create_bridge.yaml#/components/schemas/XChainCreateBridgeTransaction'
             - $ref: '../transactions/xchain_modify_bridge.yaml#/components/schemas/XChainModifyBridgeTransaction'
+            - $ref: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteTransaction'
             # TODO: Add other transaction types here
 
     SubmitErrorResponse:
@@ -557,6 +569,7 @@ components:
             - $ref: '../transactions/amm_bid.yaml#/components/schemas/AMMBidErrorCode'
             - $ref: '../transactions/amm_create.yaml#/components/schemas/AMMCreateErrorCode'
             - $ref: '../transactions/amm_deposit.yaml#/components/schemas/AMMDepositErrorCode'
+            - $ref: '../transactions/amm_delete.yaml#/components/schemas/AMMDeleteErrorCode'
             - $ref: '../transactions/amm_vote.yaml#/components/schemas/AMMVoteErrorCode'
             - $ref: '../transactions/amm_withdraw.yaml#/components/schemas/AMMWithdrawErrorCode'
             - $ref: '../transactions/credential_accept.yaml#/components/schemas/CredentialAcceptErrorCode'
@@ -579,6 +592,7 @@ components:
             - $ref: '../transactions/nftoken_mint.yaml#/components/schemas/NFTokenMintErrorCode'
             - $ref: '../transactions/payment_channel_create.yaml#/components/schemas/PaymentChannelCreateErrorCode'
             - $ref: '../transactions/payment_channel_fund.yaml#/components/schemas/PaymentChannelFundErrorCode'
+            - $ref: '../transactions/oracle_delete.yaml#/components/schemas/OracleDeleteErrorCode'
             - enum:
                 - amendmentBlocked
                 - highFee
diff --git a/shared/transactions/amm_bid.yaml b/shared/transactions/amm_bid.yaml
@@ -19,12 +19,12 @@ components:
         - Asset2
       properties:
         Asset:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for one of the assets in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
         Asset2:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for the other asset in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
diff --git a/shared/transactions/amm_delete.yaml b/shared/transactions/amm_delete.yaml
@@ -18,12 +18,12 @@ components:
         - Asset2
       properties:
         Asset:
-          $ref: '../base.yaml#/components/schemas/CurrencyWithoutAmount'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for one of the assets in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
         Asset2:
-          $ref: '../base.yaml#/components/schemas/CurrencyWithoutAmount'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for the other asset in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
diff --git a/shared/transactions/amm_deposit.yaml b/shared/transactions/amm_deposit.yaml
@@ -17,12 +17,12 @@ components:
         - Asset2
       properties:
         Asset:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for one of the assets in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
         Asset2:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for the other asset in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
diff --git a/shared/transactions/amm_vote.yaml b/shared/transactions/amm_vote.yaml
@@ -15,12 +15,12 @@ components:
         - TradingFee
       properties:
         Asset:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for one of the assets in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
         Asset2:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for the other asset in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
diff --git a/shared/transactions/amm_withdraw.yaml b/shared/transactions/amm_withdraw.yaml
@@ -13,12 +13,12 @@ components:
         - Asset2
       properties:
         Asset:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for one of the assets in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
         Asset2:
-          $ref: '../base.yaml#/components/schemas/IssuedCurrency'
+          $ref: '../base.yaml#/components/schemas/Currency'
           description: |
             (Required) The definition for the other asset in the AMM's pool. In JSON, this is an object
             with currency and issuer fields (omit issuer for XRP).
diff --git a/shared/transactions/credential_accept.yaml b/shared/transactions/credential_accept.yaml
@@ -20,9 +20,6 @@ components:
         Issuer:
           type: string
           description: The address of the issuer that created the credential.
-      x-custom-validation:
-        validCredentialType:
-          field: CredentialType
 
     CredentialAcceptErrorCode:
       $id: CredentialAcceptErrorCode
diff --git a/shared/transactions/credential_create.yaml b/shared/transactions/credential_create.yaml
@@ -35,9 +35,6 @@ components:
           description: |
             Arbitrary additional data about the credential, such as the URL where users can look up an associated Verifiable Credential document. 
             If present, the minimum length is 1 byte and the maximum is 256 bytes.
-      x-custom-validation:
-        validCredentialType:
-          field: CredentialType
 
     CredentialCreateErrorCode:
       $id: CredentialCreateErrorCode
diff --git a/shared/transactions/credential_delete.yaml b/shared/transactions/credential_delete.yaml
@@ -28,8 +28,6 @@ components:
           - fields:
               - Subject
               - Issuer
-        validCredentialType:
-          field: CredentialType
 
     CredentialDeleteErrorCode:
       $id: CredentialDeleteErrorCode
diff --git a/shared/transactions/deposit_preauth.yaml b/shared/transactions/deposit_preauth.yaml
@@ -17,6 +17,9 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/AuthorizeCredentials'
+          minItems: 1
+          maxItems: 8
+          uniqueItems: true
           description: |
             (Optional) A set of credentials to authorize. (Requires the Credentials amendment.)
         Unauthorize:
@@ -27,6 +30,9 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/AuthorizeCredentials'
+          minItems: 1
+          maxItems: 8
+          uniqueItems: true
           description: |
             (Optional) A set of credentials whose preauthorization should be revoked. (Requires the
             Credentials amendment.)
diff --git a/shared/transactions/did_set.yaml b/shared/transactions/did_set.yaml
@@ -13,16 +13,19 @@ components:
         Data:
           type: string
           format: hex
+          maxLength: 256
           description: |
             (Optional) The public attestations of identity credentials associated with the DID.
         DIDDocument:
           type: string
           format: hex
+          maxLength: 256
           description: |
             (Optional) The DID document associated with the DID.
         URI:
           type: string
           format: hex
+          maxLength: 256
           description: |
             (Optional) The Universal Resource Identifier associated with the DID.
       x-custom-validation:
diff --git a/shared/transactions/mptoken_issuance_create.yaml b/shared/transactions/mptoken_issuance_create.yaml
diff --git a/shared/transactions/mptoken_issuance_set.yaml b/shared/transactions/mptoken_issuance_set.yaml
diff --git a/shared/transactions/oracle_delete.yaml b/shared/transactions/oracle_delete.yaml
