stadlar / IST-FUT-FMTH

Creative Commons Attribution 4.0 International
12 stars 22 forks source link

Claims - Add ClaimType to GetClaims Response to Indicate Optional Payment Claims #180

Closed thebingi closed 1 year ago

thebingi commented 1 year ago

Title: Add ClaimType to GetClaims Response to Indicate Optional Payment Claims

Description:

I propose adding a new property, "ClaimType," to the response object for the GetClaims operation to indicate whether the claims are optional payment claims. In the current system, the following types are available:

Suggested addition to the schema:

claimType:
  description: Claim type
  type: string
  enum:
    - "NormalClaim"
    - "OptionalPaymentClaim"
    - "RefundClaim"
    - "BalanceClaim"

By adding this new property, we can provide clearer information on the claim types and make it easier to distinguish between different types of claims in the GetClaims response.

Kristinn-Stefansson commented 1 year ago

Meeting TN-FMÞ-VH7-16 found that this change was reasonable in light of the backend system now supporting and even requiring this. This should also be added to the creation as a optional parameter with the NormalClaim as default. Having this well documented in the schema is key, especially in the case of BalanceClaims that might require validation by the service.

Kristinn-Stefansson commented 1 year ago

Approved according to agreement on TN-FMÞ-VH7-18 and PR merged