feat(query-graphql): allow descriptions to be defined in relations

TriPSs · Oct 28, 2021 · 0fe9580 · 0fe9580
1 parent 568f228
commit 0fe9580
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/packages/query-graphql/src/resolvers/relations/helpers.ts b/packages/query-graphql/src/resolvers/relations/helpers.ts
@@ -9,4 +9,4 @@ export const flattenRelations = <RT extends ResolverRelation<unknown> | Resolver
 export const removeRelationOpts = <Relation>(
   opts: ResolverRelation<Relation> | ResolverRelationReference<unknown, Relation>,
 ): ResolverMethodOpts =>
-  omit(opts, 'DTO', 'keys', 'nullable', 'dtoName', 'relationName', 'disableRead', 'disableUpdate', 'disableRemove');
+  omit(opts, 'DTO', 'keys', 'nullable', 'dtoName', 'relationName', 'disableRead', 'disableUpdate', 'disableRemove', 'description');
diff --git a/packages/query-graphql/src/resolvers/relations/read-relations.resolver.ts b/packages/query-graphql/src/resolvers/relations/read-relations.resolver.ts
@@ -34,7 +34,7 @@ const ReadOneRelationMixin =
       @ResolverField(
         baseNameLower,
         () => relationDTO,
-        { nullable: relation.nullable, complexity: relation.complexity },
+        { nullable: relation.nullable, complexity: relation.complexity, description: relation?.description },
         commonResolverOpts,
         { interceptors: [AuthorizerInterceptor(DTOClass)] },
       )
@@ -86,7 +86,7 @@ const ReadManyRelationMixin =
       @ResolverField(
         pluralBaseNameLower,
         () => CT.resolveType,
-        { nullable: relation.nullable, complexity: relation.complexity },
+        { nullable: relation.nullable, complexity: relation.complexity, description: relation?.description },
         commonResolverOpts,
         { interceptors: [AuthorizerInterceptor(DTOClass)] },
       )

diff --git a/packages/query-graphql/src/resolvers/relations/relations.interface.ts b/packages/query-graphql/src/resolvers/relations/relations.interface.ts
@@ -68,6 +68,11 @@ export type ResolverRelation<Relation> = {
    */
   allowFiltering?: boolean;
 
+  /**
+   * Description of the relation.
+   */
+  description?: string;
+
   complexity?: Complexity;
 
   auth?: AuthorizerOptions<Relation>;