Skip to content

Commit

Permalink
[MODFIN-346] - Implement unrelease encumbrance endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
azizbekxm committed Jan 8, 2024
1 parent 5db86e5 commit a0cc24c
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions ramls/unrelease-encumbrance.raml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#%RAML 1.0

title: Unreleased encumbrance
version: v1
protocols: [ HTTP, HTTPS ]
Expand All @@ -16,33 +17,44 @@ types:

traits:
validate: !include raml-util/traits/validation.raml
language: !include raml-util/traits/language.raml

/finance/unreleased-encumbrance/{id}:
/finance/unrelease-encumbrance/{id}:
uriParameters:
id:
description: The UUID of an encumbrance
type: UUID
displayName: Finance release encumbrance
description: Finance release encumbrance APIs
is: [validate, language]
displayName: Finance unrelease encumbrance
description: Finance unrelease encumbrance APIs
post:
description: Release encumbrance
is: [validate]
description: Unrelease encumbrance
responses:
204:
description: "Encumbrance successfully released"
description: "Encumbrance successfully unreleased"
400:
description: "Bad request, malformed query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
body:
text/plain:
example: "Transaction type is not encumbrance"
application/json:
example:
strict: false
value: !include raml-util/examples/errors.sample
404:
description: "Encumbrance with a given ID not found"
body:
text/plain:
example: "Encumbrance not found"
application/json:
example:
strict: false
value: !include raml-util/examples/errors.sample
500:
description: "Internal server error, e.g. due to misconfiguration"
body:
text/plain:
example: "internal server error, contact administrator"
application/json:
example:
strict: false
value: !include raml-util/examples/errors.sample

0 comments on commit a0cc24c

Please sign in to comment.