Add support for readOnly and writeOnly fields

packages/openapi-to-graphql/lib/types/oas3.d.ts

@@ -25,6 +25,8 @@ export declare type SchemaObject = {
     anyOf?: (SchemaObject | ReferenceObject)[];
     oneOf?: (SchemaObject | ReferenceObject)[];
     not?: (SchemaObject | ReferenceObject)[];
+    readOnly?: boolean;
+    writeOnly?: boolean;
 };
 export declare type ReferenceObject = {
     $ref: string;

packages/openapi-to-graphql/src/schema_builder.ts

@@ -512,7 +512,7 @@ function createOrReuseList<TSource, TContext, TArgs>({
     }
     return listObjectType
   } else {
-    throw new Error(`Cannot create list item object type '${itemsName}' in list 
+    throw new Error(`Cannot create list item object type '${itemsName}' in list
     '${name}' with schema '${JSON.stringify(itemsSchema)}'`)
   }
 }
@@ -616,6 +616,16 @@ function createFields<TSource, TContext, TArgs>({
     const fieldTypeDefinition = fieldTypeDefinitions[fieldTypeKey]
     const fieldSchema = fieldTypeDefinition.schema
 
+    // readOnly fields should not be included for Input types
+    if (isInputObjectType && fieldSchema?.readOnly) {
+      continue
+    }
+
+    // writeOnly fields should not be included for non-Input types
+    if (!isInputObjectType && fieldSchema?.writeOnly) {
+      continue
+    }
+
     // Get object type describing the property
     const objectType = getGraphQLType({
       def: fieldTypeDefinition,

packages/openapi-to-graphql/src/types/oas3.ts

@@ -34,6 +34,8 @@ export type SchemaObject = {
   anyOf?: (SchemaObject | ReferenceObject)[]
   oneOf?: (SchemaObject | ReferenceObject)[]
   not?: (SchemaObject | ReferenceObject)[]
+  readOnly?: boolean
+  writeOnly?: boolean
 }
 
 export type ReferenceObject = {

packages/openapi-to-graphql/test/example_api7.test.ts

@@ -1,6 +1,14 @@
 'use strict'
 
-import { graphql, parse, validate, execute, subscribe } from 'graphql'
+import {
+  graphql,
+  parse,
+  validate,
+  execute,
+  subscribe,
+  GraphQLSchema,
+  GraphQLObjectType
+} from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import { createServer } from 'http'
@@ -23,7 +31,7 @@ const MQTT_PORT = 1885
 oas.servers[0].variables.port.default = String(HTTP_PORT)
 oas.servers[1].variables.port.default = String(MQTT_PORT)
 
-let createdSchema
+let createdSchema: GraphQLSchema
 let wsServer
 let mqttClient
 let subscriptionServer
@@ -182,3 +190,15 @@ test('Receive data from the subscription after creating a new instance', () => {
     }, 500)
   })
 })
+
+test('should filter out readOnly properties from Input types', () => {
+  const device = createdSchema.getType('Device') as GraphQLObjectType
+  const deviceProps = Object.keys(device.getFields())
+
+  expect(deviceProps).toEqual(['id', 'name', 'status', 'userName'])
+
+  const deviceInput = createdSchema.getType('DeviceInput') as GraphQLObjectType
+  const deviceInputProps = Object.keys(deviceInput.getFields())
+
+  expect(deviceInputProps).toEqual(['name', 'status', 'userName'])
+})

packages/openapi-to-graphql/test/fixtures/example_oas7.json

@@ -177,6 +177,10 @@
         "type": "object",
         "description": "A device is an object connected to the network",
         "properties": {
+          "id": {
+            "type": "string",
+            "readOnly": true
+          },
           "name": {
             "type": "string",
             "description": "The device name in the network"