Fixing API linting errors (adding description to model fields)
The API is generated from the Django models. Some fields still lack a proper description, which reflects as additional API documentation. Linting with npx graphql lint
yields:
❯ npx graphql lint
olki/olki_back/schema.graphql
12:3 The field `Activate.success` is missing a description. fields-have-descriptions
13:3 The field `Activate.errors` is missing a description. fields-have-descriptions
18:3 The field `Activity.fid` is missing a description. fields-have-descriptions
19:3 The field `Activity.url` is missing a description. fields-have-descriptions
23:3 The field `Activity.actor` is missing a description. fields-have-descriptions
24:3 The field `Activity.recipients` is missing a description. fields-have-descriptions
25:3 The field `Activity.uuid` is missing a description. fields-have-descriptions
26:3 The field `Activity.creationDate` is missing a description. fields-have-descriptions
27:3 The field `Activity.type` is missing a description. fields-have-descriptions
28:3 The field `Activity.objectId` is missing a description. fields-have-descriptions
29:3 The field `Activity.targetId` is missing a description. fields-have-descriptions
30:3 The field `Activity.relatedObjectId` is missing a description. fields-have-descriptions
34:3 The field `Activity.payload` is missing a description. fields-have-descriptions
35:3 The field `Activity.inReplyTo` is missing a description. fields-have-descriptions
38:1 The object type `ActivityConnection` is missing a description. types-have-descriptions
44:3 The field `ActivityConnection.totalCount` is missing a description. fields-have-descriptions
60:3 The field `Actor.fid` is missing a description. fields-have-descriptions
61:3 The field `Actor.url` is missing a description. fields-have-descriptions
62:3 The field `Actor.user` is missing a description. fields-have-descriptions
63:3 The field `Actor.outboxUrl` is missing a description. fields-have-descriptions
64:3 The field `Actor.inboxUrl` is missing a description. fields-have-descriptions
65:3 The field `Actor.followingUrl` is missing a description. fields-have-descriptions
66:3 The field `Actor.followersUrl` is missing a description. fields-have-descriptions
67:3 The field `Actor.sharedInboxUrl` is missing a description. fields-have-descriptions
68:3 The field `Actor.type` is missing a description. fields-have-descriptions
69:3 The field `Actor.name` is missing a description. fields-have-descriptions
70:3 The field `Actor.summary` is missing a description. fields-have-descriptions
71:3 The field `Actor.preferredUsername` is missing a description. fields-have-descriptions
72:3 The field `Actor.publicKey` is missing a description. fields-have-descriptions
73:3 The field `Actor.privateKey` is missing a description. fields-have-descriptions
74:3 The field `Actor.creationDate` is missing a description. fields-have-descriptions
75:3 The field `Actor.lastFetchDate` is missing a description. fields-have-descriptions
76:3 The field `Actor.manuallyApprovesFollowers` is missing a description. fields-have-descriptions
77:3 The field `Actor.followers` is missing a description. fields-have-descriptions
78:3 The field `Actor.icon` is missing a description. fields-have-descriptions
79:3 The field `Actor.image` is missing a description. fields-have-descriptions
80:3 The field `Actor.corporaOwned` is missing a description. fields-have-descriptions
81:3 The field `Actor.noteSet` is missing a description. fields-have-descriptions
82:3 The field `Actor.following` is missing a description. fields-have-descriptions
83:3 The field `Actor.outboxActivities` is missing a description. fields-have-descriptions
84:3 The field `Actor.inboxActivities` is missing a description. fields-have-descriptions
85:3 The field `Actor.profileUrl` is missing a description. fields-have-descriptions
86:3 The field `Actor.fullUsername` is missing a description. fields-have-descriptions
89:1 The object type `ActorConnection` is missing a description. types-have-descriptions
106:1 The enum `ActorType` should be sorted alphabetically. enum-values-sorted-alphabetically
127:1 The interface type `AuthorInterface` is missing a description. types-have-descriptions
128:3 The field `AuthorInterface.name` is missing a description. fields-have-descriptions
129:3 The field `AuthorInterface.orcid` is missing a description. fields-have-descriptions
134:3 The field `ChangePassword.success` is missing a description. fields-have-descriptions
141:3 The field `Corpus.createdAt` is missing a description. fields-have-descriptions
142:3 The field `Corpus.updatedAt` is missing a description. fields-have-descriptions
146:3 The field `Corpus.title` is missing a description. fields-have-descriptions
147:3 The field `Corpus.description` is missing a description. fields-have-descriptions
165:3 The field `Corpus.draft` is missing a description. fields-have-descriptions
166:3 The field `Corpus.commentsAllowed` is missing a description. fields-have-descriptions
167:3 The field `Corpus.commentsOnlyLocal` is missing a description. fields-have-descriptions
168:3 The field `Corpus.commentsOnlyVisibleIfApproved` is missing a description. fields-have-descriptions
175:3 The field `Corpus.actor` is missing a description. fields-have-descriptions
176:3 The field `Corpus.authors` is missing a description. fields-have-descriptions
177:3 The field `Corpus.tags` is missing a description. fields-have-descriptions
181:3 The field `Corpus.commentsCount` is missing a description. fields-have-descriptions
184:1 The object type `CorpusAuthor` is missing a description. types-have-descriptions
185:3 The field `CorpusAuthor.email` is missing a description. fields-have-descriptions
186:3 The field `CorpusAuthor.affiliation` is missing a description. fields-have-descriptions
187:3 The field `CorpusAuthor.role` is missing a description. fields-have-descriptions
191:3 The field `CorpusAuthor.name` is missing a description. fields-have-descriptions
192:3 The field `CorpusAuthor.orcid` is missing a description. fields-have-descriptions
195:1 The object type `CorpusConnection` is missing a description. types-have-descriptions
201:3 The field `CorpusConnection.totalCount` is missing a description. fields-have-descriptions
213:1 The input object type `CreateActorInput` is missing a description. types-have-descriptions
214:3 The input value `CreateActorInput.username` is missing a description. input-object-values-have-descriptions
215:3 The input value `CreateActorInput.clientMutationId` is missing a description. input-object-values-have-descriptions
220:3 The field `CreateActorPayload.username` is missing a description. fields-have-descriptions
221:3 The field `CreateActorPayload.errors` is missing a description. fields-have-descriptions
222:3 The field `CreateActorPayload.clientMutationId` is missing a description. fields-have-descriptions
225:1 The input object type `CreateCorpusInput` is missing a description. types-have-descriptions
230:3 The input value `CreateCorpusInput.title` is missing a description. input-object-values-have-descriptions
231:3 The input value `CreateCorpusInput.description` is missing a description. input-object-values-have-descriptions
244:3 The input value `CreateCorpusInput.draft` is missing a description. input-object-values-have-descriptions
250:3 The input value `CreateCorpusInput.commentsAllowed` is missing a description. input-object-values-have-descriptions
251:3 The input value `CreateCorpusInput.commentsOnlyLocal` is missing a description. input-object-values-have-descriptions
252:3 The input value `CreateCorpusInput.commentsOnlyVisibleIfApproved` is missing a description. input-object-values-have-descriptions
256:3 The input value `CreateCorpusInput.tags` is missing a description. input-object-values-have-descriptions
257:3 The input value `CreateCorpusInput.authors` is missing a description. input-object-values-have-descriptions
258:3 The input value `CreateCorpusInput.clientMutationId` is missing a description. input-object-values-have-descriptions
263:3 The field `CreateCorpusPayload.corpus` is missing a description. fields-have-descriptions
264:3 The field `CreateCorpusPayload.errors` is missing a description. fields-have-descriptions
265:3 The field `CreateCorpusPayload.clientMutationId` is missing a description. fields-have-descriptions
268:1 The input object type `CreateNoteInput` is missing a description. types-have-descriptions
282:3 The input value `CreateNoteInput.language` is missing a description. input-object-values-have-descriptions
283:3 The input value `CreateNoteInput.clientMutationId` is missing a description. input-object-values-have-descriptions
286:1 The object type `CreateNotePayload` is missing a description. types-have-descriptions
287:3 The field `CreateNotePayload.note` is missing a description. fields-have-descriptions
288:3 The field `CreateNotePayload.errors` is missing a description. fields-have-descriptions
289:3 The field `CreateNotePayload.clientMutationId` is missing a description. fields-have-descriptions
301:3 The field `DeleteAccount.success` is missing a description. fields-have-descriptions
302:3 The field `DeleteAccount.errors` is missing a description. fields-have-descriptions
307:3 The field `DeleteCorpus.success` is missing a description. fields-have-descriptions
308:3 The field `DeleteCorpus.errors` is missing a description. fields-have-descriptions
316:3 The field `DeleteNote.success` is missing a description. fields-have-descriptions
317:3 The field `DeleteNote.errors` is missing a description. fields-have-descriptions
371:1 The input object type `EditCorpusInput` is missing a description. types-have-descriptions
379:3 The input value `EditCorpusInput.title` is missing a description. input-object-values-have-descriptions
380:3 The input value `EditCorpusInput.description` is missing a description. input-object-values-have-descriptions
393:3 The input value `EditCorpusInput.draft` is missing a description. input-object-values-have-descriptions
399:3 The input value `EditCorpusInput.commentsAllowed` is missing a description. input-object-values-have-descriptions
400:3 The input value `EditCorpusInput.commentsOnlyLocal` is missing a description. input-object-values-have-descriptions
401:3 The input value `EditCorpusInput.commentsOnlyVisibleIfApproved` is missing a description. input-object-values-have-descriptions
405:3 The input value `EditCorpusInput.tags` is missing a description. input-object-values-have-descriptions
406:3 The input value `EditCorpusInput.authors` is missing a description. input-object-values-have-descriptions
407:3 The input value `EditCorpusInput.clientMutationId` is missing a description. input-object-values-have-descriptions
412:3 The field `EditCorpusPayload.corpus` is missing a description. fields-have-descriptions
413:3 The field `EditCorpusPayload.errors` is missing a description. fields-have-descriptions
414:3 The field `EditCorpusPayload.clientMutationId` is missing a description. fields-have-descriptions
417:1 The object type `ErrorType` is missing a description. types-have-descriptions
418:3 The field `ErrorType.field` is missing a description. fields-have-descriptions
419:3 The field `ErrorType.messages` is missing a description. fields-have-descriptions
424:3 The field `File.filetype` is missing a description. fields-have-descriptions
425:3 The field `File.hash` is missing a description. fields-have-descriptions
426:3 The field `File.name` is missing a description. fields-have-descriptions
427:3 The field `File.description` is missing a description. fields-have-descriptions
428:3 The field `File.url` is missing a description. fields-have-descriptions
429:3 The field `File.size` is missing a description. fields-have-descriptions
439:1 The input object type `GlobalPreferencesMutationInput` is missing a description. types-have-descriptions
440:3 The input value `GlobalPreferencesMutationInput.general_SiteTitle` is not camel cased. input-object-values-are-camel-cased
443:3 The input value `GlobalPreferencesMutationInput.general_SiteDescription` is not camel cased. input-object-values-are-camel-cased
449:3 The input value `GlobalPreferencesMutationInput.general_SiteTos` is not camel cased. input-object-values-are-camel-cased
454:3 The input value `GlobalPreferencesMutationInput.general_SiteRules` is not camel cased. input-object-values-are-camel-cased
459:3 The input value `GlobalPreferencesMutationInput.general_SiteSubjects` is not camel cased. input-object-values-are-camel-cased
462:3 The input value `GlobalPreferencesMutationInput.general_RegistrationAllowed` is not camel cased. input-object-values-are-camel-cased
466:3 The input value `GlobalPreferencesMutationInput.clientMutationId` is missing a description. input-object-values-have-descriptions
469:1 The object type `GlobalPreferencesMutationPayload` is missing a description. types-have-descriptions
470:3 The field `GlobalPreferencesMutationPayload.general_SiteTitle` is not camel cased. fields-are-camel-cased
473:3 The field `GlobalPreferencesMutationPayload.general_SiteDescription` is not camel cased. fields-are-camel-cased
479:3 The field `GlobalPreferencesMutationPayload.general_SiteTos` is not camel cased. fields-are-camel-cased
484:3 The field `GlobalPreferencesMutationPayload.general_SiteRules` is not camel cased. fields-are-camel-cased
489:3 The field `GlobalPreferencesMutationPayload.general_SiteSubjects` is not camel cased. fields-are-camel-cased
492:3 The field `GlobalPreferencesMutationPayload.general_RegistrationAllowed` is not camel cased. fields-are-camel-cased
496:3 The field `GlobalPreferencesMutationPayload.errors` is missing a description. fields-have-descriptions
497:3 The field `GlobalPreferencesMutationPayload.clientMutationId` is missing a description. fields-have-descriptions
502:3 The field `ImportCorpus.success` is missing a description. fields-have-descriptions
503:3 The field `ImportCorpus.errors` is missing a description. fields-have-descriptions
521:3 The field `Login.success` is missing a description. fields-have-descriptions
522:3 The field `Login.errors` is missing a description. fields-have-descriptions
523:3 The field `Login.token` is missing a description. fields-have-descriptions
524:3 The field `Login.user` is missing a description. fields-have-descriptions
538:3 The field `Mutations.createNote` is missing a description. fields-have-descriptions
557:3 The field `Mutations.editProfile` is missing a description. fields-have-descriptions
587:3 The field `Mutations.verifyToken` is missing a description. fields-have-descriptions
588:3 The field `Mutations.refreshToken` is missing a description. fields-have-descriptions
589:3 The field `Mutations.revokeToken` is missing a description. fields-have-descriptions
590:3 The field `Mutations.editPreferencesGeneral` is missing a description. fields-have-descriptions
606:3 The field `Note.summary` is missing a description. fields-have-descriptions
616:3 The field `Note.fid` is missing a description. fields-have-descriptions
617:3 The field `Note.tags` is missing a description. fields-have-descriptions
620:1 The object type `NoteConnection` is missing a description. types-have-descriptions
626:3 The field `NoteConnection.totalCount` is missing a description. fields-have-descriptions
640:3 The field `OnNewNotificationsForUser.count` is missing a description. fields-have-descriptions
662:3 The field `Profile.createdAt` is missing a description. fields-have-descriptions
663:3 The field `Profile.user` is missing a description. fields-have-descriptions
664:3 The field `Profile.name` is missing a description. fields-have-descriptions
665:3 The field `Profile.bio` is missing a description. fields-have-descriptions
666:3 The field `Profile.indexed` is missing a description. fields-have-descriptions
667:3 The field `Profile.private` is missing a description. fields-have-descriptions
671:3 The field `Profile.avatar` is missing a description. fields-have-descriptions
674:1 The input object type `ProfileMutationInput` is missing a description. types-have-descriptions
675:3 The input value `ProfileMutationInput.image` is missing a description. input-object-values-have-descriptions
676:3 The input value `ProfileMutationInput.name` is missing a description. input-object-values-have-descriptions
677:3 The input value `ProfileMutationInput.bio` is missing a description. input-object-values-have-descriptions
678:3 The input value `ProfileMutationInput.indexed` is missing a description. input-object-values-have-descriptions
679:3 The input value `ProfileMutationInput.private` is missing a description. input-object-values-have-descriptions
680:3 The input value `ProfileMutationInput.id` is missing a description. input-object-values-have-descriptions
681:3 The input value `ProfileMutationInput.clientMutationId` is missing a description. input-object-values-have-descriptions
684:1 The object type `ProfileMutationPayload` is missing a description. types-have-descriptions
685:3 The field `ProfileMutationPayload.profile` is missing a description. fields-have-descriptions
686:3 The field `ProfileMutationPayload.errors` is missing a description. fields-have-descriptions
687:3 The field `ProfileMutationPayload.clientMutationId` is missing a description. fields-have-descriptions
717:3 The field `Queries.corpora` is missing a description. fields-have-descriptions
731:5 The input value `corpora.tagsName_In` is not camel cased. input-object-values-are-camel-cased
732:5 The input value `corpora.tagsCode_In` is not camel cased. input-object-values-are-camel-cased
733:5 The input value `corpora.tagsName_AllIn` is not camel cased. input-object-values-are-camel-cased
734:5 The input value `corpora.tagsCode_AllIn` is not camel cased. input-object-values-are-camel-cased
735:5 The input value `corpora.authorsName_AllIn` is not camel cased. input-object-values-are-camel-cased
736:5 The input value `corpora.authorsOrcid_AllIn` is not camel cased. input-object-values-are-camel-cased
737:5 The input value `corpora.organizations_AllIn` is not camel cased. input-object-values-are-camel-cased
740:3 The field `Queries.ownCorpora` is missing a description. fields-have-descriptions
754:5 The input value `ownCorpora.tagsName_In` is not camel cased. input-object-values-are-camel-cased
755:5 The input value `ownCorpora.tagsCode_In` is not camel cased. input-object-values-are-camel-cased
756:5 The input value `ownCorpora.tagsName_AllIn` is not camel cased. input-object-values-are-camel-cased
757:5 The input value `ownCorpora.tagsCode_AllIn` is not camel cased. input-object-values-are-camel-cased
758:5 The input value `ownCorpora.authorsName_AllIn` is not camel cased. input-object-values-are-camel-cased
759:5 The input value `ownCorpora.authorsOrcid_AllIn` is not camel cased. input-object-values-are-camel-cased
760:5 The input value `ownCorpora.organizations_AllIn` is not camel cased. input-object-values-are-camel-cased
763:3 The field `Queries.userCorpora` is missing a description. fields-have-descriptions
778:5 The input value `userCorpora.tagsName_In` is not camel cased. input-object-values-are-camel-cased
779:5 The input value `userCorpora.tagsCode_In` is not camel cased. input-object-values-are-camel-cased
780:5 The input value `userCorpora.tagsName_AllIn` is not camel cased. input-object-values-are-camel-cased
781:5 The input value `userCorpora.tagsCode_AllIn` is not camel cased. input-object-values-are-camel-cased
782:5 The input value `userCorpora.authorsName_AllIn` is not camel cased. input-object-values-are-camel-cased
783:5 The input value `userCorpora.authorsOrcid_AllIn` is not camel cased. input-object-values-are-camel-cased
784:5 The input value `userCorpora.organizations_AllIn` is not camel cased. input-object-values-are-camel-cased
800:17 The input value `alreadyCloned.clonedFrom_Contains` is not camel cased. input-object-values-are-camel-cased
801:3 The field `Queries.hasActor` is missing a description. fields-have-descriptions
802:3 The field `Queries.user` is missing a description. fields-have-descriptions
803:3 The field `Queries.users` is missing a description. fields-have-descriptions
803:78 The input value `users.profile_Name` is not camel cased. input-object-values-are-camel-cased
803:100 The input value `users.profile_Name_Icontains` is not camel cased. input-object-values-are-camel-cased
803:132 The input value `users.profile_Name_Istartswith` is not camel cased. input-object-values-are-camel-cased
803:166 The input value `users.actor_PreferredUsername` is not camel cased. input-object-values-are-camel-cased
803:199 The input value `users.actor_PreferredUsername_Icontains` is not camel cased. input-object-values-are-camel-cased
803:242 The input value `users.actor_PreferredUsername_Istartswith` is not camel cased. input-object-values-are-camel-cased
804:3 The field `Queries.debug` is missing a description. fields-have-descriptions
812:1 The object type `Refresh` is missing a description. types-have-descriptions
813:3 The field `Refresh.token` is missing a description. fields-have-descriptions
814:3 The field `Refresh.payload` is missing a description. fields-have-descriptions
819:3 The field `Register.success` is missing a description. fields-have-descriptions
820:3 The field `Register.errors` is missing a description. fields-have-descriptions
825:3 The field `ResetPassword.success` is missing a description. fields-have-descriptions
830:3 The field `ResetPasswordConfirm.success` is missing a description. fields-have-descriptions
831:3 The field `ResetPasswordConfirm.errors` is missing a description. fields-have-descriptions
834:1 The object type `Revoke` is missing a description. types-have-descriptions
835:3 The field `Revoke.revoked` is missing a description. fields-have-descriptions
838:1 The object type `Subscriptions` is missing a description. types-have-descriptions
839:3 The field `Subscriptions.onNewNotificationsForUser` is missing a description. fields-have-descriptions
867:3 The field `User.createdAt` is missing a description. fields-have-descriptions
868:3 The field `User.updatedAt` is missing a description. fields-have-descriptions
869:3 The field `User.lastLogin` is missing a description. fields-have-descriptions
878:3 The field `User.firstName` is missing a description. fields-have-descriptions
879:3 The field `User.lastName` is missing a description. fields-have-descriptions
888:3 The field `User.dateJoined` is missing a description. fields-have-descriptions
892:3 The field `User.email` is missing a description. fields-have-descriptions
893:3 The field `User.lastActivity` is missing a description. fields-have-descriptions
894:3 The field `User.profile` is missing a description. fields-have-descriptions
895:3 The field `User.actor` is missing a description. fields-have-descriptions
896:3 The field `User.name` is missing a description. fields-have-descriptions
897:3 The field `User.orcid` is missing a description. fields-have-descriptions
898:3 The field `User.isSetup` is missing a description. fields-have-descriptions
901:1 The object type `UserConnection` is missing a description. types-have-descriptions
924:1 The object type `Verify` is missing a description. types-have-descriptions
925:3 The field `Verify.payload` is missing a description. fields-have-descriptions
928:1 The object type `Viewer` is missing a description. types-have-descriptions
929:3 The field `Viewer.user` is missing a description. fields-have-descriptions
✖ 242 errors detected
Linting errors were found