Uploaded image for project: 'Magnolia REST Framework'
  1. Magnolia REST Framework
  2. MGNLREST-543

DOC: Specify endpoint types without Java classes (for DXCore and SaaS)

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Neutral
    • None
    • None
    • None
    • None
    • DevX 38
    • 2
    • Yes

    Description

      For actual implementation, see MGNLREST-522.

      DXCore 6.2

      Examples should use $type instead of class.
      Be sure that the $type for the delivery endpoint is documented.
      https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html

      For example here: 
      https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html#_properties

      ALSO All examples should have a $type (We made it optional to haave at type or class, but later decided that was a bad idea.

      Remove this note: "The property is optional since version 2.2.11 of the REST module."

      SaaS

      On SaaS docs there shoould not be any reference to java or classes. Only $type syntax shoould be documented:
      Also examples should use $type.
      https://docs.magnolia-cms.com/saas/developers/api/delivery-endpoint.html

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                mdrapela Martin Drápela
                mdrapela Martin Drápela
                DeveloperX
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:
                  Work Started:

                  Checklists

                    Task DoD