Registry / devops / axway-flow-schema

axway-flow-schema

library5.4.3jsnpmunverified

Provides the JSON Schema definitions for Axway flow configurations in the Axway API Builder platform (version 5.4.3 as of this entry). This package defines the structure and validation rules for Axway flow objects, including triggers, conditions, and actions. It is a core dependency for building and validating flows in Axway's integration platform. The schema is versioned and updated with each release to support new flow capabilities. Key differentiators: it is the official schema package for the Axway ecosystem, essential for flow validation, and follows the Axway General Conditions license.

devops

npm install axway-flow-schema

package ↗homepage ↗

INSTALL

IMPORT

SIG · AXWAY-FLOW-SCHEMA

axway-flow-schema

devopsjavascriptv5.4.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import schema from 'axway-flow-schema'

✗ const schema = require('axway-flow-schema')

Package exports a single JSON object as default. CommonJS require works, but ESM import is recommended for modern projects.

JSON Schema file path

✓ import { readFileSync } from 'fs'; const schema = JSON.parse(readFileSync(require.resolve('axway-flow-schema/flow-schema.json'), 'utf8'));

✗ import schema from 'axway-flow-schema/flow-schema.json'

When using Node.js, the JSON file is not directly importable in CommonJS or ESM without fs. Use require.resolve to get the path.

$ref resolution

✓ const $RefParser = require('@apidevtools/json-schema-ref-parser'); const schema = await $RefParser.dereference(require('axway-flow-schema'));

✗ const dereferenced = await $RefParser.dereference('axway-flow-schema');

The schema contains internal $ref pointers that need dereferencing before use with most validators.

Demonstrates importing the schema and using Ajv to validate a flow object against it.

import schema from 'axway-flow-schema'; // Default import of the JSON schema console.log(typeof schema); // 'object' console.log(schema.$id); // 'https://axway.com/schemas/flow/5.4.3' // Validate a flow object against the schema import Ajv from 'ajv'; const ajv = new Ajv(); const validate = ajv.compile(schema); const myFlow = { triggers: [/* ... */], actions: [/* ... */] }; const valid = validate(myFlow); if (!valid) console.log(validate.errors);

Debug

Known issues

gotchaThe package is licensed under Axway General Conditions, which restrict usage to Axway platform products. Redistribution of the schema without permission is prohibited.

fix

Ensure you are an authorized Axway licensee and comply with the license terms.

affects: >=1.0.0

deprecatedThe schema file location has changed in v5.0.0. Previously it was at 'axway-flow-schema/flow-schema.json' but now the default export is the schema object directly.

fix

Use the default import instead of reading the JSON file manually.

affects: >=5.0.0 <5.0.0

breakingVersion 5.0.0 introduced breaking changes in the schema structure, including new required fields and updated trigger/action definitions.

fix

Ensure flows conform to the updated schema; use schema validation to identify incompatibilities.

affects: >=5.0.0

Errors

Common errors & fixes

Cannot find module 'axway-flow-schema'

Package not installed or not in node_modules.

fix

Run: npm install axway-flow-schema

Validation failed: data must have required property 'triggers'

The flow object is missing a 'triggers' field, which is required by the schema.

fix

Add a 'triggers' array to the flow object.

Invalid ref: https://axway.com/schemas/flow/5.4.3#/definitions/action

The schema's $ref pointers cannot be resolved without dereferencing.

fix

Use a $ref parser like @apidevtools/json-schema-ref-parser to dereference the schema before validation.

Upgrade

Version history

5.4.3latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

13 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packageaxway-flow-schema ↗

homepagehttps://platform.axway.com ↗