Skip to content

Commit 93af403

Browse files
author
Nicki Nixon
committed
fix: escape HTML tags in OpenAPI spec to prevent C# SDK compilation errors
- Convert unescaped <br /> tags to XML-escaped &lt;br /&gt;&lt;br /&gt; format - Fix HTML escaping in endpoint descriptions across 7 locations: - Account transactions endpoint (line 597) - Member transactions endpoint (line 1770) - Tag transactions endpoint (line 2276) - User transactions endpoint (line 2399) - Transaction details endpoint (line 2432) - Repeating transactions endpoints (lines 2769, 2785) - Fix malformed <br></br> tag in microdeposit endpoint description - Resolve C# compilation errors: 'Invalid token >' in member declaration', 'XML comment has badly formed XML', and 'Invalid token &'' This ensures generated SDKs compile successfully across all target languages while preserving HTML formatting in API documentation.
1 parent 17518cc commit 93af403

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

openapi/mx_platform_api.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ paths:
339339
- processor token
340340
/transactions/enhance:
341341
post:
342-
description: Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
342+
description: Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. &lt;br /&gt;&lt;br /&gt;For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
343343
operationId: enhanceTransactions
344344
requestBody:
345345
content:
@@ -594,7 +594,7 @@ paths:
594594
$ref: '#/components/schemas/TransactionCreateResponseBody'
595595
get:
596596
description: |
597-
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter.
597+
Requests to this endpoint return a list of transactions associated with the specified account. &lt;br /&gt;&lt;br /&gt;Enhanced transaction data may be requested using the `includes` parameter.
598598
To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`.
599599
For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
600600
operationId: listTransactionsByAccount
@@ -1767,7 +1767,7 @@ paths:
17671767
- members
17681768
/users/{user_guid}/members/{member_guid}/transactions:
17691769
get:
1770-
description: Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
1770+
description: Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. &lt;br /&gt;&lt;br /&gt;Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
17711771
operationId: listTransactionsByMember
17721772
parameters:
17731773
- $ref: '#/components/parameters/memberGuid'
@@ -2273,7 +2273,7 @@ paths:
22732273
- tags
22742274
/users/{user_guid}/tags/{tag_guid}/transactions:
22752275
get:
2276-
description: Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
2276+
description: Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. &lt;br /&gt;&lt;br /&gt;Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
22772277
operationId: listTransactionsByTag
22782278
parameters:
22792279
- $ref: '#/components/parameters/userGuid'
@@ -2396,7 +2396,7 @@ paths:
23962396
- transaction rules
23972397
/users/{user_guid}/transactions:
23982398
get:
2399-
description: Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
2399+
description: Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. &lt;br /&gt;&lt;br /&gt;Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
24002400
operationId: listTransactions
24012401
parameters:
24022402
- $ref: '#/components/parameters/userGuid'
@@ -2429,7 +2429,7 @@ paths:
24292429
- $ref: '#/components/parameters/userGuid'
24302430
- $ref: '#/components/parameters/transactionGuid'
24312431
get:
2432-
description: Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
2432+
description: Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. &lt;br /&gt;&lt;br /&gt;Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
24332433
operationId: readTransaction
24342434
responses:
24352435
'200':
@@ -2766,7 +2766,7 @@ paths:
27662766
$ref: '#/components/schemas/NotificationResponseBody'
27672767
/users/{user_guid}/repeating_transactions:
27682768
get:
2769-
description: Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
2769+
description: Retrieve a list of all recurring transactions for a user. &lt;br /&gt;&lt;br /&gt;For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
27702770
operationId: repeatingTransactions
27712771
parameters:
27722772
- $ref: '#/components/parameters/userGuid'
@@ -2782,7 +2782,7 @@ paths:
27822782
- transactions
27832783
/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}:
27842784
get:
2785-
description: Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
2785+
description: Get a Specific Repeating Transaction. &lt;br /&gt;&lt;br /&gt;List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
27862786
operationId: specificRepeatingTransaction
27872787
parameters:
27882788
- $ref: '#/components/parameters/userGuid'
@@ -3027,7 +3027,7 @@ paths:
30273027
operationId: readUserMicrodeposit
30283028
summary: Read a microdeposit for a user
30293029
description: |
3030-
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
3030+
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. &lt;br /&gt;&lt;br /&gt; Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
30313031
responses:
30323032
'200':
30333033
description: OK
@@ -3524,8 +3524,8 @@ components:
35243524
type: string
35253525
instructional_text:
35263526
example: |
3527-
Some instructional text <a href="https://example.url.mxbank.com/instructions"
3528-
id="instructional_text">for end users</a>.
3527+
Some instructional text &lt;a href="https://example.url.mxbank.com/instructions"
3528+
id="instructional_text"&gt;for end users&lt;/a&gt;.
35293529
nullable: true
35303530
type: string
35313531
instructional_text_steps:

0 commit comments

Comments
 (0)