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

Create a light module that demonstrate rest client usage

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • 2.0
    • None
    • None
    • None
    • Declarative REST 7, Declarative REST 8
    • 5

    Description

      User Story:

      As a developer, I want to quickly be able to try rest clients, so that I can understand, test, and use them in my projects.

      Notes

      Create a single git repository with a single or set of examples showing how declarative rest clients can be configured and used.

      These technical examples can use names of the exact feature that they are demonstrating, they dont have to be realistic scenarios.

      For example there could be a light module "linkfield"

      Things to include

      README should contain list of all the features demonstrated, and where its demonstrated in the file:

      • Rest clients - with all their usages techniques
        • Using the template parameters and defaultValues
        • paging
        • caching
        • timeout
        • OpenAPI
      • Rest client Authentication
        • basic
        • OAUTH2
        • (Other?)
      • Template
      • Template hitting a Magnolia deliveryEndpoint.
      • Link field
      • Select field
      • App - Browser SubApp
      • Findbar
      • JS Model
      • ... every other feature.

       

      Useful for:

      • Documenting what has been done in a ticket.
      • Assisting Docs team to write docs.

      Resources:

      JSModels samples project:

      https://git.magnolia-cms.com/projects/LIGHT-MODULES/repos/javascript-model-samples/browse

      Stories samples project:

      https://git.magnolia-cms.com/projects/LIGHT-MODULES/repos/stories-app-samples/browse

      Concept for Readme

      https://wiki.magnolia-cms.com/display/TEASYINT/Easy+Rest+Demo+Project

       

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                jfranco Jorge Franco
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR