Uploaded image for project: 'Magnolia GraphQL'
  1. Magnolia GraphQL
  2. MGNLGQL-10

GraphQL serves system and metadata properties

    XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Neutral
    • 1.0
    • None
    • None
    • Yes
    • HL & LD 14, HL & LD 15
    • 3

    Description

      User story:

      As a developer, I want some system and metadata properties available so that I have a consistent way to get these things.

      Notes:

      Consider putting all system/metadata properties under their own node, this can make it easier for client developers to keep metadata and actual content separate.

      _ underscores seem to be commonly used for these cases.

      Acceptance criteria:

      • Implement at least partial support for metadata mentioned: @id, @path, @name, @nodeType
      • GraphiQL is strict about property names, so we need a new convention rather then using colons and at-symbols as the delivery endpoint does.
      • A GUID should always be available on a response. It can be used by the client for caching on the client. It could be the node id. See: https://graphql.org/learn/caching/

       

      Metadata are included on a subnode - which prevents any naming clashes with content property names:

      {
        book(id: 1) {
          title
          isbn13
          _metadata {
            id
            name
            path
            nodeType
          }
        }
      }
      

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                jsimak Jaroslav Simak
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD