Skip to content

Commit

Permalink
[MODFIN-352] Removed HTML tags from RAML descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
damien-git committed Apr 10, 2024
1 parent 1411dce commit af8db80
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions ramls/release-encumbrance.raml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ documentation:
- title: Release encumbrance API
content: |
This documents the API calls that release any remaining money encumbered back to the budget's available pool.
It should only be used by the UI, and only to release a single encumbrance - <tt>batch-all-or-nothing</tt> should be used otherwise.
It should only be used by the UI, and only to release a single encumbrance - batch-all-or-nothing should be used otherwise.
types:
errors: !include raml-util/schemas/errors.schema
Expand All @@ -28,10 +28,10 @@ traits:
displayName: Finance release encumbrance
description: |
Finance release encumbrance APIs.
It should only be used by the UI, and only to release a single encumbrance - <tt>batch-all-or-nothing</tt> should be used otherwise.
It should only be used by the UI, and only to release a single encumbrance - batch-all-or-nothing should be used otherwise.
post:
is: [validate]
description: Release encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)
description: Release encumbrance (use only in UI for a single encumbrance - use batch-all-or-nothing otherwise)
responses:
204:
description: "Encumbrance successfully released"
Expand Down
8 changes: 4 additions & 4 deletions ramls/transaction.raml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ resourceTypes:
/finance:
/allocations:
displayName: Create a transaction allocation
description: Create an allocation; DEPRECATED - use <tt>batch-all-or-nothing</tt> instead
description: Create an allocation; DEPRECATED - use batch-all-or-nothing instead
type:
post-with-201:
requestSchema: transaction
Expand All @@ -38,11 +38,11 @@ resourceTypes:
responseExample: !include acq-models/mod-finance/examples/transaction_allocation.sample
is: [validate]
post:
description: Create an allocation by transaction; DEPRECATED - use <tt>batch-all-or-nothing</tt> instead
description: Create an allocation by transaction; DEPRECATED - use batch-all-or-nothing instead

/transfers:
displayName: Create a transaction transfer
description: Create a transfer; DEPRECATED - use <tt>batch-all-or-nothing</tt> instead
description: Create a transfer; DEPRECATED - use batch-all-or-nothing instead
type:
post-with-201:
requestSchema: transaction
Expand All @@ -51,7 +51,7 @@ resourceTypes:
responseExample: !include acq-models/mod-finance/examples/transaction_transfer.sample
is: [validate]
post:
description: Create a transfer by transaction; DEPRECATED - use <tt>batch-all-or-nothing</tt> instead
description: Create a transfer by transaction; DEPRECATED - use batch-all-or-nothing instead

/transactions:
displayName: Transactions
Expand Down
6 changes: 3 additions & 3 deletions ramls/unrelease-encumbrance.raml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ documentation:
- title: Unrelease encumbrance API
content: |
This documents the API calls that unrelease any remaining money encumbered back to the budget's available pool.
It should only be used by the UI, and only to unrelease a single encumbrance - <tt>batch-all-or-nothing</tt> should be used otherwise
It should only be used by the UI, and only to unrelease a single encumbrance - batch-all-or-nothing should be used otherwise
types:
errors: !include raml-util/schemas/errors.schema
Expand All @@ -28,10 +28,10 @@ traits:
displayName: Finance unrelease encumbrance
description: |
Finance unrelease encumbrance APIs.
It should only be used by the UI, and only to release a single encumbrance - <tt>batch-all-or-nothing</tt> should be used otherwise.
It should only be used by the UI, and only to release a single encumbrance - batch-all-or-nothing should be used otherwise.
post:
is: [validate]
description: Unrelease encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)
description: Unrelease encumbrance (use only in UI for a single encumbrance - use batch-all-or-nothing otherwise)
responses:
204:
description: "Encumbrance successfully unreleased"
Expand Down

0 comments on commit af8db80

Please sign in to comment.