hasura / hasura/graphql-engine

Change GraphQL comment for user defined function and arguments

Open
#7,490 1 comment 0 reactions 0 assignees View on GitHub
k/v3-backlog
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

It would be very valuable for us to be able to define custom comments for tracked functions in the metadata.

Ideally, it should be possible to add custom comments on the following:

* The function itself: Currently the auto-generated comment reads something like:

```
execute function "my_function" which returns "my_schema.my_table"
```

A user-provided comment should entirely override the auto-generated comment, without disclosing what the underlying pg function is.

The auto-generated comment should ideally replace the `my_schema.my_table` with any custom GraphQL root name provided by the user.

* The function arguments: Currently, there is no way to add comments to those and there is no auto-generated comment either.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.