Syntax analysis

[yakupbeyoglu]

Syntax Analysis Checklist for JSON Structure

Example json can be found at https://github.com/yakupbeyoglu/ForgeAPI/issues/2#issue-2540546808

1. Overall Structure

• Root Object: Verify that the JSON starts with an object ({}) and not an array ([]) or a primitive value (e.g., string, number).

2. Table Definition

• Field Name: Check that the "table" field exists and is a string.
• Expected Value: Ensure the value of "table" is a valid table name (e.g., "posts").

3. Fields Array

• Field Name: Verify that the "fields" field is an array.

• Field Object Structure:

  • Each item in the "fields" array must be an object with at least "name" and "type" fields.
  • The "name" should be a string representing the column name.
  • The "type" should be a string specifying the data type (e.g., "bigIncrements", "string", "text", "unsignedBigInteger").

• Additional Properties (if applicable):

  • For "string" type fields, check if "length" is present and is a number.
  • For "foreign" type fields, ensure it is an object with valid properties:
  • "table" should be a string.
  • "references" should be a string.
  • "onDelete" , '"onUpdate"' should be a valid action string (e.g., "cascade").

4. Relations Array

• Relation Name: Ensure that the "relations" field is an array.
• Relation Object Structure:
  • Each item in the "relations" array must be an object with the following fields:
  • "type": a string indicating the type of relation (e.g., "belongsTo").
  • "model": a string representing the related model name (e.g., "User").
  • "foreignKey": a string representing the foreign key field.

5. Routes Array

• Route Name: Verify that the "routes" field is an array.
• Route Object Structure:
  • Each item in the "routes" array must be an object with at least the following fields:
  • "method": a string indicating the HTTP method (e.g., "GET", "POST").
  • "uri": a string representing the route URI.
  • "action": a string representing the action to be taken (e.g., "index", "store").
  • Optionally, check for additional fields:
  • "custom_sql": if present, it should be a string containing valid SQL.
  • "authorization": if present, it should be a valid authorization type (e.g., "public").
  • "authorization_groups": if present, it should be an array of strings representing role names.

6. Middleware Array

• Middleware Name: Verify that the "middleware" field is an array.
• Middleware Object Structure:
  • Each item in the "middleware" array must be an object with:
  • "name": a string indicating the middleware name (e.g., "auth").
  • "routes": an array of strings representing the routes to which this middleware applies.
  • Wild card based middleware can be used to handle :

    It can also     { "name": "auth", "routes":"/posts/*" }  // This means all routes need auth.

7. Authorization Groups

• Authorization Groups Name: Ensure that the "authorization_groups" field is an array.
• Authorization Group Object Structure:
  • Each item in the "authorization_groups" array must be an object with:
  • "role": a string representing the role name (e.g., "admin").
  • "description": a string describing the role.

Validation Steps

1. Check Required Fields: Ensure all required fields are present and correctly formatted.
2. Validate Data Types: Confirm that data types match the expected types for each field.
3. Verify Constraints: Check constraints such as field lengths and foreign key relationships.
4. Handle Nested Structures: Validate the structure and content of nested arrays and objects.
5. Error Handling: Report errors with details on missing fields, incorrect types, and structural issues.