[MGNLRESTCL-41] Verify Configuration of REST Clients Created: 14/Feb/19  Updated: 28/Oct/19  Resolved: 28/Oct/19

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

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Christopher Zimmermann
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon MGNLRESTCL-53 Declarative REST clients Closed
supersession
supersedes MGNLRESTCL-49 Conceptualize versatile definitions Closed
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)
Date of First Response:
Epic Link: Easy Outbound REST
Sprint: Declarative REST 3, Declarative REST 7
Story Points: 5

 Description   

As a developer, I want to configure REST clients in one place that I can easily use from anywhere in the system that needs to make REST requests, so that I can fulfill my integration requirements.

Currently Java is required to provision REST Clients. It should be possible with configuration and light development as well.

Example:

  • A centrally-configured-REST-connection (REST Client) could be used to access content in a template, a fieldtype, an app, a content type, a p13n trait, a search result supplier, an external DAM connector.
  • A REST Client could be used to perform a REST request in a command, an action, a workflow step, a scheduled task.

Concrete examples:

  • When an item is published via an action, a REST request is performed to a remote system which does something with the newly published content - such as pushing it to a CDN (Netlify).

Acceptance Criteria:

  • I can configure the REST connection with light development. 
    • Use Yaml files, includes, decorations. Can supply in light modules.
  • Configured REST clients show up in definitions app and problems view.
  • I can configure the REST connection in less than 15 minutes.

Notes

A benefit is that a developer can configure the core details about a connection in one place, and then easily use that connection throughout the system. In contrast, if developers configure connections in multiple places, its more likely that one will not be updated correctly, and its hard to get an overview of all of the external systems used.

This becomes even more important when the endpoints require mapping configurations and authentication credentials: passwords, secrets, tokens, and the like.



 Comments   
Comment by Christopher Zimmermann [ 28/Oct/19 ]

Closing as done. Acceptance criteria are met.

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