Dash (-) not supported in resource name

[praihan]

The resource and attribute names are checked against the regex /^[A-Za-z0-9_]*$/. Is it possible to also support -, i.e. resource-name-is-like-this format? It could just be as easy as changing it to /^[A-Za-z0-9_\-]*$/.

[pmcnr-hx]

I will have to check the spec to see if - is allowed. I'll come back to you on this one.

[praihan]

We see here:

The values of type members MUST adhere to the same constraints as member names.

Which says

The following “globally allowed characters” MAY be used anywhere in a member name:

• U+0061 to U+007A, “a-z”
• U+0041 to U+005A, “A-Z”
• U+0030 to U+0039, “0-9”
• U+0080 and above (non-ASCII Unicode characters; not recommended, not URL safe)

Additionally, the following characters are allowed in member names, except as the first or last character:

• U+002D HYPHEN-MINUS, “-“
• U+005F LOW LINE, “_”
• U+0020 SPACE, “ “ (not recommended, not URL safe)

The requirements in the spec are pretty clear and should be simple to extract into a function instead of a regex test. Let me know what you think.

[pmcnr-hx]

You are correct @prshreshtha. You're welcome to submit a PR for review and eventual merging.

[praihan]

Sounds good. I'll make one soon.

[praihan]

It looks like GraphQL does not support dasherized field names. Any thoughts @pmcnr-hx? The same issue occurs with resources that start with a number.

[paparomeo]

Ah, yes... I seemed to recall there was a reason not prevent dashes. One options is to replace the - with _ on the fly. The other one is to disable GraphQL support if you prefer to use just use JSON:API with - on the names. I don't think GraphQL support should prevent us from fully supporting the JSON:API spec. Which option do you prefer?

[praihan]

@paparomeo there are trade-offs here. I don't think replacing - with _ will work without breaking the API since my-resource and my_resource will collide. I think the ability to disable GraphQL support to take full advantage of JSON:API is the way to go and document the stricter requirements when using GraphQL. This definitely needs some research.

[paparomeo]

Thanks for the investigation @prshreshtha. I should have some time soon to look into adding support for disabling GraphQL.

[queenvictoria]

You can already do part of this. And there is an issue here for the entire task. #256

From my current implementation

jsonApi.setConfig({
  port: PORT,
  base: `api/${API_ENV}/v${API_VERSION}`,
  graphiql: true, // <-----------
  swagger: {
    title: "JSON:API Server",
    version: "0.1.0",
    description: "",
    contact: {
      name: "API Contact",
      email: "[email protected]",
      url: "example.com"
    },
    license: {
    }
  },
  meta: function(request) {
    return {
      timestamp: parseInt(new Date().getTime()/1000),
      schema: `api/${API_ENV}/v${API_VERSION}/swagger.json`,
    };
  }
});

[praihan]

@queenvictoria You are correct that #256 does cover part of this issue. It is a pre-requisite to supporting dasherized names. But I don't see any work done for it.