feat(api-headless-cms): optional validation (#3562)

webiny · Oct 23, 2023 · 26edf52 · 26edf52
1 parent ed3ef6a
commit 26edf52
Show file tree

Hide file tree

Showing 20 changed files with 570 additions and 129 deletions.
diff --git a/apps/api/graphql/src/test.ts b/apps/api/graphql/src/test.ts
diff --git a/packages/api-aco/__tests__/snapshots/customAppsSchema.ts b/packages/api-aco/__tests__/snapshots/customAppsSchema.ts
@@ -134,7 +134,7 @@ export const createCustomAppsSchemaSnapshot = () => {
         }
 
         input AcoSearchRecordCustomTestingApp_LocationInput {
-          folderId: String!
+          folderId: String
         }
 
         input AcoSearchRecordCustomTestingApp_Data_IdentityInput {
@@ -155,11 +155,11 @@ export const createCustomAppsSchemaSnapshot = () => {
 
         input AcoSearchRecordCustomTestingAppCreateInput {
           id: ID
-          type: String!
-          title: String!
+          type: String
+          title: String
           content: String
-          location: AcoSearchRecordCustomTestingApp_LocationInput!
-          data: AcoSearchRecordCustomTestingApp_DataInput!
+          location: AcoSearchRecordCustomTestingApp_LocationInput
+          data: AcoSearchRecordCustomTestingApp_DataInput
           tags: [String!]
         }
         

diff --git a/packages/api-aco/__tests__/snapshots/defaultAppsSchema.ts b/packages/api-aco/__tests__/snapshots/defaultAppsSchema.ts
@@ -110,7 +110,7 @@ export const createDefaultAppsSchemaSnapshot = () => {
         }
 
         input AcoSearchRecordWebiny_LocationInput {
-          folderId: String!
+          folderId: String
         }
 
         input AcoSearchRecordWebiny_Data_IdentityInput {
@@ -129,11 +129,11 @@ export const createDefaultAppsSchemaSnapshot = () => {
 
         input AcoSearchRecordWebinyCreateInput {
           id: ID
-          type: String!
-          title: String!
+          type: String
+          title: String
           content: String
-          location: AcoSearchRecordWebiny_LocationInput!
-          data: AcoSearchRecordWebiny_DataInput!
+          location: AcoSearchRecordWebiny_LocationInput
+          data: AcoSearchRecordWebiny_DataInput
           tags: [String!]
         }
         

diff --git a/packages/api-file-manager/__tests__/mocks/file.sdl.ts b/packages/api-file-manager/__tests__/mocks/file.sdl.ts
@@ -130,10 +130,10 @@ export default /* GraphQL */ `
     input FmFileCreateInput {
         id: ID!
         location: FmFile_LocationInput
-        name: String!
-        key: String!
-        type: String!
-        size: Number!
+        name: String
+        key: String
+        type: String
+        size: Number
         meta: FmFile_MetaInput
         tags: [String!]
         aliases: [String!]

diff --git a/packages/api-headless-cms/__tests__/contentAPI/fieldValidations.test.ts b/packages/api-headless-cms/__tests__/contentAPI/fieldValidations.test.ts
@@ -140,30 +140,6 @@ describe("fieldValidations", () => {
                 }
             }
         });
-
-        /**
-         * GraphQL response must break when not sending required value.
-         */
-        const [requiredResponse] = await createFruit({
-            data: {
-                ...defaultFruitData,
-                name: undefined
-            }
-        });
-
-        expect(requiredResponse).toEqual({
-            errors: [
-                {
-                    message: expect.any(String),
-                    locations: [
-                        {
-                            column: expect.any(Number),
-                            line: expect.any(Number)
-                        }
-                    ]
-                }
-            ]
-        });
     });
     /**
      * testing minLength and maxLength of the array

diff --git a/packages/api-headless-cms/__tests__/contentAPI/republish.entries.test.ts b/packages/api-headless-cms/__tests__/contentAPI/republish.entries.test.ts
@@ -296,7 +296,10 @@ describe("Republish entries", () => {
             category: {
                 entryId: applePublished.id,
                 modelId: categoryModel.modelId
-            }
+            },
+            price: 1,
+            color: "red",
+            image: "https://webiny.com/gala.png"
         });
         const { entry: goldenEntry } = createEntry(
             productModel,
@@ -305,7 +308,10 @@ describe("Republish entries", () => {
                 category: {
                     entryId: bananaPublished.id,
                     modelId: categoryModel.modelId
-                }
+                },
+                price: 1,
+                color: "white",
+                image: "https://webiny.com/golden.png"
             },
             5
         );

diff --git a/packages/api-headless-cms/__tests__/contentAPI/snapshots/category.manage.ts b/packages/api-headless-cms/__tests__/contentAPI/snapshots/category.manage.ts
@@ -37,8 +37,8 @@ export default /* GraphQL */ `
     input CategoryApiNameWhichIsABitDifferentThanModelIdInput {
         id: ID
         wbyAco_location: WbyAcoLocationInput
-        title: String!
-        slug: String!
+        title: String
+        slug: String
     }
 
     input CategoryApiNameWhichIsABitDifferentThanModelIdGetWhereInput {
@@ -158,11 +158,11 @@ export default /* GraphQL */ `
     }
 
     extend type Mutation {
-        createCategoryApiNameWhichIsABitDifferentThanModelId(data: CategoryApiNameWhichIsABitDifferentThanModelIdInput!): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
+        createCategoryApiNameWhichIsABitDifferentThanModelId(data: CategoryApiNameWhichIsABitDifferentThanModelIdInput!, options: CreateCmsEntryOptionsInput): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
 
-        createCategoryApiNameWhichIsABitDifferentThanModelIdFrom(revision: ID!, data: CategoryApiNameWhichIsABitDifferentThanModelIdInput): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
+        createCategoryApiNameWhichIsABitDifferentThanModelIdFrom(revision: ID!, data: CategoryApiNameWhichIsABitDifferentThanModelIdInput, options: CreateRevisionCmsEntryOptionsInput): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
 
-        updateCategoryApiNameWhichIsABitDifferentThanModelId(revision: ID!, data: CategoryApiNameWhichIsABitDifferentThanModelIdInput!): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
+        updateCategoryApiNameWhichIsABitDifferentThanModelId(revision: ID!, data: CategoryApiNameWhichIsABitDifferentThanModelIdInput!, options: UpdateCmsEntryOptionsInput): CategoryApiNameWhichIsABitDifferentThanModelIdResponse
     
         moveCategoryApiNameWhichIsABitDifferentThanModelId(revision: ID!, folderId: ID!): CategoryApiNameWhichIsABitDifferentThanModelIdMoveResponse
 

diff --git a/packages/api-headless-cms/__tests__/contentAPI/snapshots/page.manage.ts b/packages/api-headless-cms/__tests__/contentAPI/snapshots/page.manage.ts
@@ -227,7 +227,7 @@ export default /* GraphQL */ `
     }
 
     input PageModelApiName_Content_HeroInput {
-        title: String!
+        title: String
     }
 
     input PageModelApiName_Content_SimpleTextInput {
@@ -257,7 +257,7 @@ export default /* GraphQL */ `
     }
 
     input PageModelApiName_Content_AuthorInput {
-        author: RefFieldInput!
+        author: RefFieldInput
         authors: [RefFieldInput!]
     }
 
@@ -437,16 +437,18 @@ export default /* GraphQL */ `
     }
 
     extend type Mutation {
-        createPageModelApiName(data: PageModelApiNameInput!): PageModelApiNameResponse
+        createPageModelApiName(data: PageModelApiNameInput!, options: CreateCmsEntryOptionsInput): PageModelApiNameResponse
 
         createPageModelApiNameFrom(
             revision: ID!
             data: PageModelApiNameInput
+            options: CreateRevisionCmsEntryOptionsInput
         ): PageModelApiNameResponse
 
         updatePageModelApiName(
             revision: ID!
             data: PageModelApiNameInput!
+            options: UpdateCmsEntryOptionsInput
         ): PageModelApiNameResponse
 
         movePageModelApiName(revision: ID!, folderId: ID!): PageModelApiNameMoveResponse

diff --git a/packages/api-headless-cms/__tests__/contentAPI/snapshots/product.manage.ts b/packages/api-headless-cms/__tests__/contentAPI/snapshots/product.manage.ts
@@ -140,7 +140,7 @@ export default /* GraphQL */ `
         name: String
         price: Number
         image: String
-        category: RefFieldInput!
+        category: RefFieldInput
         categories: [RefFieldInput]
         longText: [String]
     }
@@ -149,27 +149,27 @@ export default /* GraphQL */ `
         name: String
         price: Number
         images: [String]
-        category: RefFieldInput!
+        category: RefFieldInput
         options: [ProductApiSingular_Variant_OptionsInput!]
     }
 
     input ProductApiSingular_FieldsObjectInput {
-        text: String!
+        text: String
     }
 
 
     input ProductApiSingularInput {
         id: ID
         wbyAco_location: WbyAcoLocationInput
-        title: String!
-        category: RefFieldInput!
-        price: Number!
+        title: String
+        category: RefFieldInput
+        price: Number
         inStock: Boolean
         itemsInStock: Number
         availableOn: Date
-        color: String!
+        color: String
         availableSizes: [String!]
-        image: String!
+        image: String
         richText: JSON
         variant: ProductApiSingular_VariantInput
         fieldsObject: ProductApiSingular_FieldsObjectInput
@@ -360,11 +360,11 @@ export default /* GraphQL */ `
     }
 
     extend type Mutation {
-        createProductApiSingular(data: ProductApiSingularInput!): ProductApiSingularResponse
+        createProductApiSingular(data: ProductApiSingularInput!, options: CreateCmsEntryOptionsInput): ProductApiSingularResponse
 
-        createProductApiSingularFrom(revision: ID!, data: ProductApiSingularInput): ProductApiSingularResponse
+        createProductApiSingularFrom(revision: ID!, data: ProductApiSingularInput, options: CreateRevisionCmsEntryOptionsInput): ProductApiSingularResponse
 
-        updateProductApiSingular(revision: ID!, data: ProductApiSingularInput!): ProductApiSingularResponse
+        updateProductApiSingular(revision: ID!, data: ProductApiSingularInput!, options: UpdateCmsEntryOptionsInput): ProductApiSingularResponse
         
         moveProductApiSingular(revision: ID!, folderId: ID!): ProductApiSingularMoveResponse
 

diff --git a/packages/api-headless-cms/__tests__/contentAPI/snapshots/review.manage.ts b/packages/api-headless-cms/__tests__/contentAPI/snapshots/review.manage.ts
@@ -39,7 +39,7 @@ export default /* GraphQL */ `
     input ReviewApiModelInput {
         id: ID
         wbyAco_location: WbyAcoLocationInput
-        text: String!
+        text: String
         product: RefFieldInput
         rating: Number
         author: RefFieldInput
@@ -170,11 +170,11 @@ export default /* GraphQL */ `
     }
 
     extend type Mutation {
-        createReviewApiModel(data: ReviewApiModelInput!): ReviewApiModelResponse
+        createReviewApiModel(data: ReviewApiModelInput!, options: CreateCmsEntryOptionsInput): ReviewApiModelResponse
 
-        createReviewApiModelFrom(revision: ID!, data: ReviewApiModelInput): ReviewApiModelResponse
+        createReviewApiModelFrom(revision: ID!, data: ReviewApiModelInput, options: CreateRevisionCmsEntryOptionsInput): ReviewApiModelResponse
 
-        updateReviewApiModel(revision: ID!, data: ReviewApiModelInput!): ReviewApiModelResponse
+        updateReviewApiModel(revision: ID!, data: ReviewApiModelInput!, options: UpdateCmsEntryOptionsInput): ReviewApiModelResponse
         
         moveReviewApiModel(revision: ID!, folderId: ID!): ReviewApiModelMoveResponse