api-builder-plugin-fn-json

About

This plugin installs the JSON flow-node to be used within Axway API Builder's flow editor. The flow-node provides two methods:

Stringify

The Stringify method converts a JavaScript value to a JSON string.

| Param | Type | Required | Description | | --- | --- | --- | --- | | value | any | y | The JavaScript value to be JSON encoded. | | space | number/string | | A string or number that's used to insert white space into the output JSON string for readability purposes. If this is a number, it indicates the number of space characters to use as white space; this number is capped at 10. If this is a string, its maximum length is 10; the string is used as white space. If this parameter is not provided, no white space is used. |

Parse

The Parse method parses a JSON string constructing the JavaScript value or object described by the string.

| Param | Type | Required | Description | | --- | --- | --- | --- | | json | string | y | The JSON string to parse. |

Getting started

1. Follow the Getting Started Guide

Install

After creating your API Builder service (api-builder init), you can install this plugin using npm:

npm install --no-optional @axway/api-builder-plugin-fn-json

The "JSON" flow-node will then be available in the tools panel when creating or editing Flows.

Changes

5.0.2

• #7538: Update @axway/api-builder-sdk dependency.

5.0.1

• #7517: Update @axway/api-builder-sdk dependency.

5.0.0

• #6089: Breaking change: requires minimum Node.js version 16.x.

4.1.6

• #7470: Update @axway/api-builder-test-utils devDependency.

4.1.5

• #7495: Updated README.md.

4.1.4

• #7466: Update @axway/api-builder-sdk dependency.

4.1.3

• #7474: Internal dev-dependency move.

4.1.2

• #7412: Pin in-house dependencies.

4.1.1

• #7403: Internal dev-dependency change.

4.1.0

• #6933: Replace peerDependency on @axway/api-builder-runtime with engines.apibuilder.

4.0.3

• #7057: Updated documentation links.

4.0.2

• #7010: Internal refactor of unit-tests.

4.0.1

• #6558: Fixed schema for Value parameter of Stringify method to remove incorrect string type limitation.

4.0.0

WARNING: Installing this release can cause your application to emit a MISSING_KEY error(s) on startup and cause flows to be uneditable in the UI. If you encounter this issue, please contact Axway Support ([email protected]) so that we may assist you with your upgrade.

• #6453: Breaking change: Updated Stringify method to have Error output.
• #6453: Changed the initialType on Stringify method from a string a selector.

3.0.0

• #6453: Updated Parse method description and output schema to return any valid type.
• #6453: Updated Parse output to return object with a message.

2.0.16

• #6417: Migrate from axway-flow-sdk to @axway/[email protected].

2.0.15

• #6315: Internal chore.

2.0.14

• #6116: Internal cleanup chore.

2.0.13

• #6074: Internal CI chore

2.0.4 - 2.0.12

• #5891: Bump axway-flow-sdk dependency

2.0.3

• #5711: Internal cleanup of npm scripts.

2.0.2

• #5708: Internal changes to update mocha configuration

2.0.1

• #5707: Internal cleanup to code coverage during build process.

2.0.0

• #5742: Update axway-flow-sdk dependency to fix security vulnerability on dot module.
• #5742: Breaking Change: Minimum supported version of API Builder is now 4.5.0

1.0.14

• #5050: Updating license text.

1.0.8

• #4757: Changed SCM repository and associated internal cleanup.

License

This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here: https://support.axway.com/en/auth/general-conditions; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.