Generate JSON Schema

generateJsonSchema Mutation

Generates a JSON Schema definition from provided JSON data. This utility mutation helps create standardized schema definitions for dynamic data structures in the pyck system.

Arguments

Name	Type	Description
jsonData	String!	Required JSON string from which to generate the schema

Return Type

GenerateJsonSchemaResponse! - Contains the generated JSON Schema.

Response Fields

GenerateJsonSchemaResponse:

Field	Type	Description
jsonSchema	String!	The generated JSON Schema as a string

Usage Example

mutation {
  generateJsonSchema(
    jsonData: "{\"name\": \"John Doe\", \"age\": 30, \"email\": \"[email protected]\", \"active\": true}"
  ) {
    jsonSchema
  }
}

JavaScript Example

const generateJsonSchemaMutation = `
  mutation GenerateJsonSchema($jsonData: String!) {
    generateJsonSchema(jsonData: $jsonData) {
      jsonSchema
    }
  }
`;

const sampleData = {
  name: "John Doe",
  age: 30,
  email: "[email protected]",
  active: true,
  preferences: {
    theme: "dark",
    notifications: true
  },
  tags: ["customer", "premium"]
};

const variables = {
  jsonData: JSON.stringify(sampleData)
};

// Using fetch or your preferred GraphQL client
const response = await fetch('/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: generateJsonSchemaMutation,
    variables: variables
  })
});

const result = await response.json();
const generatedSchema = JSON.parse(result.data.generateJsonSchema.jsonSchema);
console.log('Generated JSON Schema:', generatedSchema);

Expected Response

The generated JSON Schema will follow the JSON Schema specification and might look like:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "age": {
      "type": "integer"
    },
    "email": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": ["name", "age", "email", "active"]
}

Notes

• The input must be valid JSON string format

• The generated schema follows JSON Schema Draft 7 specification

• Complex nested objects and arrays are supported

• The schema can be used for validation in data type definitions

• This is useful for creating dynamic data validation rules based on example data