Uploaded image for project: 'REST Client'
  1. REST Client
  2. MGNLRESTCL-41

Verify Configuration of REST Clients

    XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Neutral
    • None
    • None
    • None
    • None
    • Declarative REST 3, Declarative REST 7
    • 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.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                czimmermann Christopher Zimmermann
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD