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

TriPSs · Oct 28, 2021 · 568f228 · 568f228
1 parent 3ef8346
commit 568f228
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 8 deletions.
diff --git a/packages/query-graphql/src/resolvers/create.resolver.ts b/packages/query-graphql/src/resolvers/create.resolver.ts
@@ -128,7 +128,7 @@ export const Creatable =
     class CreateResolverBase extends BaseClass {
       @ResolverMutation(
         () => DTOClass,
-        { name: createOneMutationName },
+        { name: createOneMutationName, description: opts?.one?.description },
         commonResolverOpts,
         {
           interceptors: [
@@ -156,7 +156,7 @@ export const Creatable =
 
       @ResolverMutation(
         () => [DTOClass],
-        { name: createManyMutationName },
+        { name: createManyMutationName, description: opts?.many?.description },
         { ...commonResolverOpts },
         {
           interceptors: [

diff --git a/packages/query-graphql/src/resolvers/delete.resolver.ts b/packages/query-graphql/src/resolvers/delete.resolver.ts
@@ -111,7 +111,7 @@ export const Deletable =
     class DeleteResolverBase extends BaseClass {
       @ResolverMutation(
         () => DeleteOneResponse,
-        { name: deleteOneMutationName },
+        { name: deleteOneMutationName, description: opts?.one?.description },
         commonResolverOpts,
         { interceptors: [HookInterceptor(HookTypes.BEFORE_DELETE_ONE, DTOClass), AuthorizerInterceptor(DTOClass)] },
         opts.one ?? {},
@@ -133,7 +133,7 @@ export const Deletable =
 
       @ResolverMutation(
         () => DMR,
-        { name: deleteManyMutationName },
+        { name: deleteManyMutationName, description: opts?.many?.description },
         commonResolverOpts,
         { interceptors: [HookInterceptor(HookTypes.BEFORE_DELETE_MANY, DTOClass), AuthorizerInterceptor(DTOClass)] },
         opts.many ?? {},

diff --git a/packages/query-graphql/src/resolvers/read.resolver.ts b/packages/query-graphql/src/resolvers/read.resolver.ts
@@ -71,7 +71,7 @@ export const Readable =
     class ReadResolverBase extends BaseClass {
       @ResolverQuery(
         () => DTOClass,
-        { nullable: true, name: readOneQueryName },
+        { name: readOneQueryName, description: opts?.one?.description },
         commonResolverOpts,
         { interceptors: [HookInterceptor(HookTypes.BEFORE_FIND_ONE, DTOClass), AuthorizerInterceptor(DTOClass)] },
         opts.one ?? {},
@@ -89,7 +89,7 @@ export const Readable =
 
       @ResolverQuery(
         () => QueryArgs.ConnectionType.resolveType,
-        { name: readManyQueryName },
+        { name: readManyQueryName, description: opts?.many?.description },
         commonResolverOpts,
         { interceptors: [HookInterceptor(HookTypes.BEFORE_QUERY_MANY, DTOClass), AuthorizerInterceptor(DTOClass)] },
         opts.many ?? {},

diff --git a/packages/query-graphql/src/resolvers/resolver.interface.ts b/packages/query-graphql/src/resolvers/resolver.interface.ts
@@ -7,6 +7,8 @@ import { PagingStrategies, QueryArgsTypeOpts } from '../types';
 type NamedEndpoint = {
   /** Specify to override the name of the graphql query or mutation * */
   name?: string;
+  /** Specify a description for the graphql query or mutation* */
+  description?: string;
 };
 
 export interface ResolverOpts extends ResolverMethodOpts, DTONamesOpts {

diff --git a/packages/query-graphql/src/resolvers/update.resolver.ts b/packages/query-graphql/src/resolvers/update.resolver.ts
@@ -136,7 +136,7 @@ export const Updateable =
     class UpdateResolverBase extends BaseClass {
       @ResolverMutation(
         () => DTOClass,
-        { name: updateOneMutationName },
+        { name: updateOneMutationName, description: opts?.one?.description },
         {
           interceptors: [
             HookInterceptor(HookTypes.BEFORE_UPDATE_ONE, UpdateDTOClass, DTOClass),
@@ -164,7 +164,7 @@ export const Updateable =
 
       @ResolverMutation(
         () => UMR,
-        { name: updateManyMutationName },
+        { name: updateManyMutationName, description: opts?.many?.description },
         {
           interceptors: [
             HookInterceptor(HookTypes.BEFORE_UPDATE_MANY, UpdateDTOClass, DTOClass),