Rules

Endpoint{apiBaseUrl}

JSON Schema content validation rules stored in S3. Rules define the structure and constraints for suggestion values.

List all rules in a folder

GET

{apiBaseUrl}

/rules/{folder}

Returns a list of rule summaries for the specified folder. Each summary includes metadata like the component key, deprecation status, and creator info. Requires authentication.

List all rules in a folder › path Parameters

folder

string · minLength: 1 · required

Rule folder name (e.g., "layout", "validation")

List all rules in a folder › Responses

Rules listed successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object[]

Get a single rule by folder and component key

GET

{apiBaseUrl}

/rules/{folder}/{componentKey}

Retrieves the full rule definition including its JSON Schema body. Returns an ETag header for optimistic concurrency on subsequent updates. Requires authentication.

Get a single rule by folder and component key › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key identifying the rule within the folder

Get a single rule by folder and component key › Responses

Rule retrieved successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.

Update an existing rule

PUT

{apiBaseUrl}

/rules/{folder}/{componentKey}

Updates a rule's JSON Schema body. Supports optimistic concurrency via the If-Match header (ETag from a previous GET). Set overwrite=true to bypass the concurrency check. Requires authentication.

Update an existing rule › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key of the rule to update

Update an existing rule › query Parameters

overwrite

boolean

Set to true to bypass ETag concurrency check

Default: false

Update an existing rule › Headers

If-Match

string

ETag from a previous GET for optimistic concurrency

Update an existing rule › Request Body

Request body for creating or updating a rule. The schemaJson field must be a valid JSON string.

schemaJson

string · required

Valid JSON string representing the rule's JSON Schema

Update an existing rule › Responses

Rule updated successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.

Create a new rule

POST

{apiBaseUrl}

/rules/{folder}/{componentKey}

Creates a new rule under the specified folder and component key. The schemaJson field must be a valid JSON string representing the rule's JSON Schema. Set overwrite=true to replace an existing rule. Requires authentication.

Create a new rule › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key for the new rule

Create a new rule › query Parameters

overwrite

boolean

Set to true to overwrite an existing rule

Default: false

Create a new rule › Request Body

Request body for creating or updating a rule. The schemaJson field must be a valid JSON string.

schemaJson

string · required

Valid JSON string representing the rule's JSON Schema

Create a new rule › Responses

Rule created successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.

Nodes Suggestions

List all rules in a folder

GET

{apiBaseUrl}

/rules/{folder}

Returns a list of rule summaries for the specified folder. Each summary includes metadata like the component key, deprecation status, and creator info. Requires authentication.

List all rules in a folder › path Parameters

folder

string · minLength: 1 · required

Rule folder name (e.g., "layout", "validation")

List all rules in a folder › Responses

Rules listed successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object[]

Get a single rule by folder and component key

GET

{apiBaseUrl}

/rules/{folder}/{componentKey}

Retrieves the full rule definition including its JSON Schema body. Returns an ETag header for optimistic concurrency on subsequent updates. Requires authentication.

Get a single rule by folder and component key › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key identifying the rule within the folder

Get a single rule by folder and component key › Responses

Rule retrieved successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.

Update an existing rule

PUT

{apiBaseUrl}

/rules/{folder}/{componentKey}

Updates a rule's JSON Schema body. Supports optimistic concurrency via the If-Match header (ETag from a previous GET). Set overwrite=true to bypass the concurrency check. Requires authentication.

Update an existing rule › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key of the rule to update

Update an existing rule › query Parameters

overwrite

boolean

Set to true to bypass ETag concurrency check

Default: false

Update an existing rule › Headers

If-Match

string

ETag from a previous GET for optimistic concurrency

Update an existing rule › Request Body

Request body for creating or updating a rule. The schemaJson field must be a valid JSON string.

schemaJson

string · required

Valid JSON string representing the rule's JSON Schema

Update an existing rule › Responses

Rule updated successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.

Create a new rule

POST

{apiBaseUrl}

/rules/{folder}/{componentKey}

Create a new rule › path Parameters

folder

string · minLength: 1 · required

Rule folder name

componentKey

string · minLength: 1 · required

Component key for the new rule

Create a new rule › query Parameters

overwrite

boolean

Set to true to overwrite an existing rule

Default: false

Create a new rule › Request Body

Request body for creating or updating a rule. The schemaJson field must be a valid JSON string.

schemaJson

string · required

Valid JSON string representing the rule's JSON Schema

Create a new rule › Responses

Rule created successfully

Standard response envelope wrapping all API responses. Every response includes a trace ID for debugging, a machine-readable status, and a human-readable message.

status

string · enum · required

Machine-readable status code

Enum values:

CREATED

ACCEPTED

NO_CONTENT

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

message

string · required

Human-readable status message

traceId

string

Unique request trace ID for debugging and log correlation

object

A full rule definition including its JSON Schema body and metadata. Returned by GET and create/update operations.