search

gentics / mesh-incubator

Project which is home for planned enhancements for Gentics Mesh
3 stars 0 forks source link

RAML definition for User nodeReference is incorrect #168

Open michaelbromley opened 6 years ago

michaelbromley commented 6 years ago

Gentics Mesh Version, operating system, or hardware.

Operating System

Problem

The RAML for the UserResponse object has an incomplete definition for the nodeReference property. The example response in the generated API docs is:

"nodeReference" : {
  "projectName" : "dummy",
  "uuid" : "8243be5d6b1f460d83be5d6b1f360da0"
}

Reproducer

Make a GET request to a user which has a nodeReference.

GET http://localhost:8080/api/v1/users/6b7b27b52564426cbb27b52564426cbe

Expected behaviour and actual behaviour

Per the RAML docs, the nodeReference should only contain a projectName and uuid. In fact, the real nodeReference looks like:

{
  "projectName": "demo",
  "uuid": "adaf48da8c124049af48da8c12a0493e",
  "displayName": "DeLorean DMC-12",
  "schema": {
    "name": "vehicle",
    "uuid": "2aa83a2b3cba40a1a83a2b3cba90a1de"
  }
}