relationship-meta example incorrectly shows link-meta instead of relationship-meta

[oliverlangan]

data/addon/-private/system/references/reference.ts

Line 153 in 24e69e2

links: {

The example for DS.Reference#meta shows a metadata block as a descendant of the links object, which does not actually work.

relationships: {
  user: {
    links: {
      related: {
        href: '/articles/1/author',
        meta: {
          lastUpdated: 1458014400000
        }
      }
    }
  }
}

According to the JSON:API spec, meta is allowed as a sibling/alternative to links. This actually works in Ember Data using model.hasMany(relationship).meta(), so the example should be updated:

relationships: {
  user: {
    links: {
      related: '/articles/1/author',
    },
    meta: {
      lastUpdated: 1458014400000
    }
  }
}

[oliverlangan]

A coworker pointed out that the metadata shown in the docs is indeed valid JSON:API syntax. However, this is still a valid issue because the meta method does not return that information.

[runspired]

@oliverlangan right, meta method is for the relationship-meta, not the link-meta

[snewcomer]

This can be closed!