Make skip non-null with default (keystonejs#5777)

* Make skip non-null with default * WIP
johannesspohr · May 24, 2021 · 74bc778 · 74bc778
1 parent f52079f
commit 74bc778
Show file tree

Hide file tree

Showing 17 changed files with 102 additions and 97 deletions.
diff --git a/.changeset/dry-suits-think.md b/.changeset/dry-suits-think.md
@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': major
+---
+
+Updated the type of the `skip` argument to `allItems` from `Int` to `Int! = 0`.
diff --git a/docs/pages/apis/graphql.mdx b/docs/pages/apis/graphql.mdx
@@ -28,10 +28,10 @@ type Query {
   User(where: UserWhereUniqueInput!): User
 
   """ Search for all User items which match the where clause. """
-  allUsers(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int): [User]
+  allUsers(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int! = 0): [User]
 
   """ Perform a meta-query on all User items which match the where clause. """
-  _allUsersMeta(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int): _QueryMeta
+  _allUsersMeta(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int! = 0): _QueryMeta
 }
 
 type Mutation {
@@ -149,7 +149,7 @@ type User {
 ```graphql
 type Query {
   """ Search for all User items which match the where clause. """
-  allUsers(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int): [User]
+  allUsers(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int! = 0): [User]
 }
 
 input UserWhereInput {
@@ -202,7 +202,7 @@ type User {
 ```graphql
 type Query {
   """ Perform a meta-query on all User items which match the where clause. """
-  _allUsersMeta(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int): _QueryMeta
+  _allUsersMeta(where: UserWhereInput, search: String, sortBy: [SortUsersBy!], orderBy: String, first: Int, skip: Int! = 0): _QueryMeta
 }
 
 input UserWhereInput {

diff --git a/examples/auth/schema.graphql b/examples/auth/schema.graphql
@@ -172,7 +172,7 @@ type Query {
     sortBy: [SortUsersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [User]
 
   """
@@ -189,7 +189,7 @@ type Query {
     sortBy: [SortUsersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
   authenticatedItem: AuthenticatedItem
   keystone: KeystoneMeta!

diff --git a/examples/basic/schema.graphql b/examples/basic/schema.graphql
@@ -81,31 +81,31 @@ type User {
     sortBy: [SortPhoneNumbersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [PhoneNumber!]!
   _phoneNumbersMeta(
     where: PhoneNumberWhereInput
     search: String
     sortBy: [SortPhoneNumbersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
   posts(
     where: PostWhereInput
     search: String
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [Post!]!
   _postsMeta(
     where: PostWhereInput
     search: String
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
   randomNumber: Float
 }
@@ -553,7 +553,7 @@ type Query {
     sortBy: [SortUsersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [User]
 
   """
@@ -570,7 +570,7 @@ type Query {
     sortBy: [SortUsersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
 
   """
@@ -582,7 +582,7 @@ type Query {
     sortBy: [SortPhoneNumbersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [PhoneNumber]
 
   """
@@ -599,7 +599,7 @@ type Query {
     sortBy: [SortPhoneNumbersBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
 
   """
@@ -611,7 +611,7 @@ type Query {
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [Post]
 
   """
@@ -628,7 +628,7 @@ type Query {
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
   authenticatedItem: AuthenticatedItem
   randomNumber: RandomNumber

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -123,15 +123,15 @@ type Author {
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [Post!]!
   _postsMeta(
     where: PostWhereInput
     search: String
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
 }
 
@@ -298,7 +298,7 @@ type Query {
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [Post]
 
   """
@@ -315,7 +315,7 @@ type Query {
     sortBy: [SortPostsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
 
   """
@@ -327,7 +327,7 @@ type Query {
     sortBy: [SortAuthorsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): [Author]
 
   """
@@ -344,7 +344,7 @@ type Query {
     sortBy: [SortAuthorsBy!]
     orderBy: String
     first: Int
-    skip: Int
+    skip: Int! = 0
   ): _QueryMeta
   keystone: KeystoneMeta!
 }