GraphQL: как определить входные параметры / ограничения

Question

Я ищу способ включить дополнительную информацию в схему, чтобы потребитель API знал, что ожидается. Подумайте о макс. Длине строки или чего-то подобного. Я ожидаю, что это будет в схеме, так как это в основном заменяет документацию API, верно?

Я нашел это: https://github.com/confuser/graphql-constraint-directive, что похоже на то, что я хочу, однако мне не нужна реализация / применение, поскольку django уже делает это. Я просто хочу сообщить об этих ограничениях в полях ввода.

Я очень новичок во всем этом, так что, может быть, мне не хватает концепции graphql? Или как мне добавить такую ​​информацию в схему?

РЕДАКТИРОВАТЬ: Может быть, это не только для документирования, но и рассказать клиенту, как визуализировать поля и / или иметь возможность выполнить некоторую проверку интерфейса. В основном, как запрос OPTIONS или что-то.

Answer 1

Если все, что вам нужно сделать, это документировать что-либо об определенном поле или типе, вы можете установить description для любого из них. Добавление описания, кажется, не обрисовано в общих чертах в официальных документах, но есть эта проблема об этом.

class MyType(graphene.ObjectType):
    class Meta:
        description = "Some description for MyType"

    my_field = graphene.String(description="Some description for myField")