GraphQL API renamings (#6197)

keystonejs · Jul 27, 2021 · 4d9f89f · 4d9f89f · vercel · Jul 27, 2021
1 parent 686c0f1
commit 4d9f89f
Show file tree

Hide file tree

Showing 54 changed files with 406 additions and 386 deletions.
diff --git a/.changeset/strange-crabs-glow.md b/.changeset/strange-crabs-glow.md
@@ -0,0 +1,12 @@
+---
+'@keystone-next/keystone': major
+'@keystone-next/types': major
+'@keystone-next/fields-document': patch
+'@keystone-next/fields': patch
+---
+
+The generated CRUD queries, and some of the input types, in the GraphQL API have been renamed.
+
+If you have a list called `Item`, the query for multiple values, `allItems` will be renamed to `items`. The query for a single value, `Item`, will be renamed to `item`.
+
+Also, the input type used in the `updateItems` mutation has been renamed from `ItemsUpdateInput` to `ItemUpdateArgs`.
diff --git a/examples-staging/assets-cloud/schema.graphql b/examples-staging/assets-cloud/schema.graphql
@@ -143,7 +143,7 @@ input FileFieldInput {
   ref: String
 }
 
-input PostsUpdateInput {
+input PostUpdateArgs {
   id: ID!
   data: PostUpdateInput
 }
@@ -227,7 +227,7 @@ input PostRelateToManyInput {
   disconnectAll: Boolean
 }
 
-input AuthorsUpdateInput {
+input AuthorUpdateArgs {
   id: ID!
   data: AuthorUpdateInput
 }
@@ -254,33 +254,33 @@ type Mutation {
   createPost(data: PostCreateInput): Post
   createPosts(data: [PostsCreateInput]): [Post]
   updatePost(id: ID!, data: PostUpdateInput): Post
-  updatePosts(data: [PostsUpdateInput]): [Post]
+  updatePosts(data: [PostUpdateArgs]): [Post]
   deletePost(id: ID!): Post
   deletePosts(ids: [ID!]): [Post]
   createAuthor(data: AuthorCreateInput): Author
   createAuthors(data: [AuthorsCreateInput]): [Author]
   updateAuthor(id: ID!, data: AuthorUpdateInput): Author
-  updateAuthors(data: [AuthorsUpdateInput]): [Author]
+  updateAuthors(data: [AuthorUpdateArgs]): [Author]
   deleteAuthor(id: ID!): Author
   deleteAuthors(ids: [ID!]): [Author]
 }
 
 type Query {
-  allPosts(
+  posts(
     where: PostWhereInput! = {}
     orderBy: [PostOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [Post!]
-  Post(where: PostWhereUniqueInput!): Post
+  post(where: PostWhereUniqueInput!): Post
   postsCount(where: PostWhereInput! = {}): Int
-  allAuthors(
+  authors(
     where: AuthorWhereInput! = {}
     orderBy: [AuthorOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [Author!]
-  Author(where: AuthorWhereUniqueInput!): Author
+  author(where: AuthorWhereUniqueInput!): Author
   authorsCount(where: AuthorWhereInput! = {}): Int
   keystone: KeystoneMeta!
 }

diff --git a/examples-staging/assets-local/schema.graphql b/examples-staging/assets-local/schema.graphql
@@ -122,7 +122,7 @@ The `Upload` scalar type represents a file upload.
 """
 scalar Upload
 
-input PostsUpdateInput {
+input PostUpdateArgs {
   id: ID!
   data: PostUpdateInput
 }
@@ -205,7 +205,7 @@ input PostRelateToManyInput {
   disconnectAll: Boolean
 }
 
-input AuthorsUpdateInput {
+input AuthorUpdateArgs {
   id: ID!
   data: AuthorUpdateInput
 }
@@ -232,33 +232,33 @@ type Mutation {
   createPost(data: PostCreateInput): Post
   createPosts(data: [PostsCreateInput]): [Post]
   updatePost(id: ID!, data: PostUpdateInput): Post
-  updatePosts(data: [PostsUpdateInput]): [Post]
+  updatePosts(data: [PostUpdateArgs]): [Post]
   deletePost(id: ID!): Post
   deletePosts(ids: [ID!]): [Post]
   createAuthor(data: AuthorCreateInput): Author
   createAuthors(data: [AuthorsCreateInput]): [Author]
   updateAuthor(id: ID!, data: AuthorUpdateInput): Author
-  updateAuthors(data: [AuthorsUpdateInput]): [Author]
+  updateAuthors(data: [AuthorUpdateArgs]): [Author]
   deleteAuthor(id: ID!): Author
   deleteAuthors(ids: [ID!]): [Author]
 }
 
 type Query {
-  allPosts(
+  posts(
     where: PostWhereInput! = {}
     orderBy: [PostOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [Post!]
-  Post(where: PostWhereUniqueInput!): Post
+  post(where: PostWhereUniqueInput!): Post
   postsCount(where: PostWhereInput! = {}): Int
-  allAuthors(
+  authors(
     where: AuthorWhereInput! = {}
     orderBy: [AuthorOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [Author!]
-  Author(where: AuthorWhereUniqueInput!): Author
+  author(where: AuthorWhereUniqueInput!): Author
   authorsCount(where: AuthorWhereInput! = {}): Int
   keystone: KeystoneMeta!
 }

diff --git a/examples-staging/auth/schema.graphql b/examples-staging/auth/schema.graphql
@@ -62,7 +62,7 @@ input UserUpdateInput {
   isAdmin: Boolean
 }
 
-input UsersUpdateInput {
+input UserUpdateArgs {
   id: ID!
   data: UserUpdateInput
 }
@@ -90,7 +90,7 @@ type Mutation {
   createUser(data: UserCreateInput): User
   createUsers(data: [UsersCreateInput]): [User]
   updateUser(id: ID!, data: UserUpdateInput): User
-  updateUsers(data: [UsersUpdateInput]): [User]
+  updateUsers(data: [UserUpdateArgs]): [User]
   deleteUser(id: ID!): User
   deleteUsers(ids: [ID!]): [User]
   authenticateUserWithPassword(
@@ -134,13 +134,13 @@ input CreateInitialUserInput {
 }
 
 type Query {
-  allUsers(
+  users(
     where: UserWhereInput! = {}
     orderBy: [UserOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [User!]
-  User(where: UserWhereUniqueInput!): User
+  user(where: UserWhereUniqueInput!): User
   usersCount(where: UserWhereInput! = {}): Int
   authenticatedItem: AuthenticatedItem
   keystone: KeystoneMeta!

diff --git a/examples-staging/basic/schema.graphql b/examples-staging/basic/schema.graphql
@@ -168,7 +168,7 @@ input PostRelateToManyInput {
   disconnectAll: Boolean
 }
 
-input UsersUpdateInput {
+input UserUpdateArgs {
   id: ID!
   data: UserUpdateInput
 }
@@ -245,7 +245,7 @@ input UserRelateToOneInput {
   disconnectAll: Boolean
 }
 
-input PhoneNumbersUpdateInput {
+input PhoneNumberUpdateArgs {
   id: ID!
   data: PhoneNumberUpdateInput
 }
@@ -325,7 +325,7 @@ input PostUpdateInput {
   author: UserRelateToOneInput
 }
 
-input PostsUpdateInput {
+input PostUpdateArgs {
   id: ID!
   data: PostUpdateInput
 }
@@ -354,19 +354,19 @@ type Mutation {
   createUser(data: UserCreateInput): User
   createUsers(data: [UsersCreateInput]): [User]
   updateUser(id: ID!, data: UserUpdateInput): User
-  updateUsers(data: [UsersUpdateInput]): [User]
+  updateUsers(data: [UserUpdateArgs]): [User]
   deleteUser(id: ID!): User
   deleteUsers(ids: [ID!]): [User]
   createPhoneNumber(data: PhoneNumberCreateInput): PhoneNumber
   createPhoneNumbers(data: [PhoneNumbersCreateInput]): [PhoneNumber]
   updatePhoneNumber(id: ID!, data: PhoneNumberUpdateInput): PhoneNumber
-  updatePhoneNumbers(data: [PhoneNumbersUpdateInput]): [PhoneNumber]
+  updatePhoneNumbers(data: [PhoneNumberUpdateArgs]): [PhoneNumber]
   deletePhoneNumber(id: ID!): PhoneNumber
   deletePhoneNumbers(ids: [ID!]): [PhoneNumber]
   createPost(data: PostCreateInput): Post
   createPosts(data: [PostsCreateInput]): [Post]
   updatePost(id: ID!, data: PostUpdateInput): Post
-  updatePosts(data: [PostsUpdateInput]): [Post]
+  updatePosts(data: [PostUpdateArgs]): [Post]
   deletePost(id: ID!): Post
   deletePosts(ids: [ID!]): [Post]
   authenticateUserWithPassword(
@@ -416,29 +416,29 @@ type RandomNumber {
 }
 
 type Query {
-  allUsers(
+  users(
     where: UserWhereInput! = {}
     orderBy: [UserOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [User!]
-  User(where: UserWhereUniqueInput!): User
+  user(where: UserWhereUniqueInput!): User
   usersCount(where: UserWhereInput! = {}): Int
-  allPhoneNumbers(
+  phoneNumbers(
     where: PhoneNumberWhereInput! = {}
     orderBy: [PhoneNumberOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [PhoneNumber!]
-  PhoneNumber(where: PhoneNumberWhereUniqueInput!): PhoneNumber
+  phoneNumber(where: PhoneNumberWhereUniqueInput!): PhoneNumber
   phoneNumbersCount(where: PhoneNumberWhereInput! = {}): Int
-  allPosts(
+  posts(
     where: PostWhereInput! = {}
     orderBy: [PostOrderByInput!]! = []
     first: Int
     skip: Int! = 0
   ): [Post!]
-  Post(where: PostWhereUniqueInput!): Post
+  post(where: PostWhereUniqueInput!): Post
   postsCount(where: PostWhereInput! = {}): Int
   authenticatedItem: AuthenticatedItem
   randomNumber: RandomNumber