Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Field Mapping Validator

integration.field_mapping_validate

ProductionBounded custom (Class B)Deterministicstrictfastv1.0.0
No network

Overview

You send sourceFields and targetFields with name, type and optional required, plus mappings with source, target and transform NONE, STRINGIFY, PARSE_INTEGER, PARSE_NUMBER, PARSE_BOOLEAN, ISO_DATE or ISO_DATETIME. allowManyToOne defaults to false. Names compare as exact Unicode. This does not apply mappings or evaluate expressions.

A silently lossy mapping corrupts a sync before the first write.

Reliability

Deterministic type lattice; names compare as exact Unicode. MAPPING_INVALID — trigger: duplicate names or an unknown transform; retryable: no; next: send unique names and the published enum. MAPPING_LIMIT_EXCEEDED — trigger: more than 2,000 fields or mappings; retryable: no; next: split the schema.

Context footprint

Verdict and field names only. A successful call costs 1 execution credit.

When to use it

When two declared field lists must be wired with a published transform.

When you need to apply the mapping or evaluate an expression language.

Scope

Note
Validates source-to-target field mappings against two declared schemas and a published transform set.

Non-goals

  • Does not apply mappings
  • Does not evaluate expressions
  • Does not resolve nested object schemas

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

validation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input2 MB

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
sourceFieldsarrayYesBounded array of 1 through 10001 source fields; runtime accepts at most 2000.
targetFieldsarrayYesBounded array of 1 through 10001 target fields; runtime accepts at most 2000.
mappingsarrayYesBounded array of 0 through 10001 mappings; runtime accepts at most 2000.
allowManyToOnebooleanNoWhether two sources may share a target. Omit it for false.

Output schema

FieldTypeRequiredDescription
validbooleanYesTrue when no ERROR diagnostic was raised.
allowManyToOnebooleanYesApplied many-to-one setting.
mappedCountintegerYesHow many distinct targets were mapped.
unmappedRequiredTargetsarrayYesBounded array of 0 through 2000 required target names that have no mapping.
unusedSourcesarrayYesBounded array of 0 through 2000 declared source names that were not mapped.
diagnosticsarrayYesBounded array of 0 through 500 closed findings, each with code, severity, message, path, source and details.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"integration.field_mapping_validate","input":{"sourceFields":[{"name":"id","type":"STRING"}],"targetFields":[{"name":"id","type":"STRING"}],"mappings":[{"source":"id","target":"id"}]}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("integration.field_mapping_validate", {"mappings":[{"source":"id","target":"identifier","transform":"NONE"}],"targetFields":[{"name":"identifier","required":true,"type":"STRING"}],"sourceFields":[{"type":"STRING","name":"id"}]});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.
MAPPING_INVALID400NoThe request payload failed this skill's input validation.
MAPPING_LIMIT_EXCEEDED429NoA size, quota, rate, or time limit was exceeded.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not apply mappings
  • Does not evaluate expressions
  • Does not resolve nested object schemas
  • Running the mapping
  • Arbitrary transform languages

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "integration.field_mapping_validate",
  "input": {
    "mappings": [
      {
        "source": "id",
        "target": "identifier",
        "transform": "NONE"
      }
    ],
    "targetFields": [
      {
        "name": "identifier",
        "required": true,
        "type": "STRING"
      }
    ],
    "sourceFields": [
      {
        "type": "STRING",
        "name": "id"
      }
    ]
  }
}

Examples

STRING to STRING with NONE is valid

Inputjson
{
  "mappings": [
    {
      "source": "id",
      "target": "identifier",
      "transform": "NONE"
    }
  ],
  "targetFields": [
    {
      "name": "identifier",
      "required": true,
      "type": "STRING"
    }
  ],
  "sourceFields": [
    {
      "type": "STRING",
      "name": "id"
    }
  ]
}
Expected outputjson
{
  "allowManyToOne": false,
  "valid": true,
  "mappedCount": 1,
  "unusedSources": [],
  "unmappedRequiredTargets": [],
  "diagnostics": []
}
Tip
Exact type match under NONE is valid.

NUMBER to INTEGER under NONE is invalid

Inputjson
{
  "mappings": [
    {
      "source": "amount",
      "target": "count",
      "transform": "NONE"
    }
  ],
  "targetFields": [
    {
      "name": "count",
      "required": true,
      "type": "INTEGER"
    }
  ],
  "sourceFields": [
    {
      "type": "NUMBER",
      "name": "amount"
    }
  ]
}
Expected outputjson
{
  "allowManyToOne": false,
  "valid": false,
  "mappedCount": 1,
  "unusedSources": [],
  "unmappedRequiredTargets": [],
  "diagnostics": [
    {
      "code": "LOSSY_MAPPING",
      "severity": "ERROR",
      "message": "The declared transform cannot take this source type to this target type.",
      "path": "/mappings/0/transform",
      "source": "squillify",
      "details": {}
    }
  ]
}
Tip
LOSSY_MAPPING makes valid false.
  • Reject NUMBER to INTEGER under NONE
  • Require every required target to be mapped

Avoid for

  • Running the mapping
  • Arbitrary transform languages

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

validationintegration