Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Investigate how to get custom GraphQL Scalar descriptions into the docs #3002

Open
2 tasks
mkurapov opened this issue Sep 24, 2024 · 1 comment
Open
2 tasks
Labels
pkg: documentation Changes in the documentation package.

Comments

@mkurapov
Copy link
Contributor

Context

Currently, we have a few custom Scalars in our GraphQL schemas. The default GraphQL schemas correctly include the description (Boolean, Float, ID, etc) in our documentation on rafiki.dev (after being auto generated), but the custom scalars, JSONObject, UInt64, UInt8 do not have the descriptions added to them. We should figure out why, and make sure we can get those displaying properly.

Todos

  • Get Scalar descriptions working properly on Rafiki.dev (write your own if you have to)
  • Tag our writer @brad-dow once a PR is ready for review, so he can take a look
@mkurapov mkurapov added the pkg: documentation Changes in the documentation package. label Sep 24, 2024
@brad-dow
Copy link
Contributor

Here's the descriptions I've written. I'd love a technical review of these:

"""
The `UInt8` scalar type represents unsigned 8-bit whole numeric values, ranging from 0 to 255.
"""
scalar UInt8

"""
The `UInt64` scalar type represents unsigned 64-bit whole numeric values. It is capable of handling values that are larger than the JavaScript `Number` type limit (greater than 2^53).
"""
scalar UInt64

"""
The `JSONObject` scalar type represents JSON objects as specified by the [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) standard.
"""
scalar JSONObject

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: documentation Changes in the documentation package.
Projects
Status: Done
Development

No branches or pull requests

2 participants