Skip to content

Add ability to provide query description for fulltext and vector queries #6207

@darrellwarde

Description

@darrellwarde

I would like to be able to provide API documentation for my fulltext and vector queries, preferably in their respective directives. For example:

type Movie @node @fulltext(indexes: [{ queryName: "moviesByTitle", queryDescription: "This query can be used to search for movies by title", fields: ["title"], indexName: "moviesByTitle" }]) {
    title: String!
}

In the output GraphQL, this would be put as the field description:

type Query {
    """
    This query can be used to search for movies by title
    """
    moviesByTitle: MoviesIndexConnection!
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions