[MGNLRESTCL-139] Get rid of defaultValues in RestClient definition Created: 17/Jan/20  Updated: 24/Jan/20

Status: Open
Project: REST Client
Component/s: API
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Quach Hao Thien Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)

 Description   

As a developer, I want to declare RestCall parameters (such as query, header, cookie, and path) and assign its default value at the same place.

Current implementation:

call_1:
  path: /fixedpath/{page: "{pageParam}"}
  queryParameters: 
    id: "{idParam}"
    catalog: "fixedCatalog" # unmodifiable
  headers: 
    lang: "{langParam}"
    content-type: "application/json" # unmodifiable
  defaultValues: 
    pageParam: 1
    idParam: 001
    langParam: eng

Proposal:

call_1:
  path: /fixedpath/{page:1}
  queryParameters: 
    id: "{idParam:001}"
    catalog: "fixedCatalog" # unmodifiable
  headers: 
    lang: "{lang:eng}"
    content-type: "application/json" # unmodifiable

Acceptance criteria:

  • Remove defaultValues
  • Invocations can modify templated parameters
  • Invocations cannot modify fixed parameters
  • the Rest Client app could display all parameters for customization

 


Generated at Mon Feb 12 10:43:34 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.