addedInput schema / additionalProperties
Added value: +false
addedInput schema / properties / barcodeType
Added value: +{
+ "description": "Alias for type; used when type is absent.",
+ "enum": [
+ "upc",
+ "ean13",
+ "code128",
+ "code39",
+ "itf14",
+ "codabar"
+ ],
+ "type": "string"
+}
addedInput schema / properties / data / description
Added value: +"Value to encode; format depends on type (e.g. 12 digits for upc, 13 for ean13, alphanumeric for code128). Trimmed before validation. (inputData is accepted as an alias.)"
addedInput schema / properties / inputData
Added value: +{
+ "description": "Alias for data; used when data is absent.",
+ "type": "string"
+}
addedInput schema / properties / settings / additionalProperties
Added value: +false
addedInput schema / properties / settings / description
Added value: +"Rendering options applied to the serviceUrl; invalid values fall back to the listed default."
addedInput schema / properties / settings / properties / addQuietZone / default
Added value: +true
addedInput schema / properties / settings / properties / addQuietZone / description
Added value: +"Include the mandatory blank margin around the barcode."
addedInput schema / properties / settings / properties / height / default
Added value: +80
addedInput schema / properties / settings / properties / height / description
Added value: +"Barcode height in pixels (mapped to the renderer height scale)."
addedInput schema / properties / settings / properties / height / enum
Added value: +[
+ 50,
+ 80,
+ 120,
+ 150
+]
addedInput schema / properties / settings / properties / showText / default
Added value: +true
addedInput schema / properties / settings / properties / showText / description
Added value: +"Print the human-readable text below the barcode."
addedInput schema / properties / settings / properties / width / default
Added value: +2
addedInput schema / properties / settings / properties / width / description
Added value: +"Module scale factor for the rendered bars."
addedInput schema / properties / settings / properties / width / enum
Added value: +[
+ 1,
+ 2,
+ 3,
+ 4
+]
removedInput schema / properties / settings / required
Removed value: -[
- "width",
- "height",
- "showText",
- "addQuietZone"
-]
addedInput schema / properties / type / default
Added value: +"code128"
addedInput schema / properties / type / description
Added value: +"Barcode symbology. Unknown values fall back to code128. (barcodeType is accepted as an alias.)"
addedInput schema / properties / type / enum
Added value: +[
+ "upc",
+ "ean13",
+ "code128",
+ "code39",
+ "itf14",
+ "codabar"
+]
changedInput schema / required
Previous value: -[
- "type",
- "data",
- "settings"
-]New value: +[
+ "data"
+]
changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "error": {
+ "description": "Present only on failure; reason the payload could not be built.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Barcode payload, validation, and render details.",
+ "properties": {
+ "bcid": {
+ "description": "bwip-js barcode identifier for the renderer (e.g. upca, ean13).",
+ "type": "string"
+ },
+ "checksumInfo": {
+ "description": "Check-digit/check-character scheme for this type.",
+ "type": "string"
+ },
+ "data": {
+ "description": "The trimmed input value that was validated.",
+ "type": "string"
+ },
+ "formatDescription": {
+ "description": "What the symbology is used for.",
+ "type": "string"
+ },
+ "formatHelp": {
+ "description": "HTML requirements/help snippet for this type.",
+ "type": "string"
+ },
+ "formatInfo": {
+ "description": "Short allowed-character/length summary.",
+ "type": "string"
+ },
+ "heightScale": {
+ "description": "Renderer height-scale value derived from settings.height.",
+ "type": "integer"
+ },
+ "industryUsage": {
+ "description": "Typical industries that use this symbology.",
+ "type": "string"
+ },
+ "inputLabel": {
+ "description": "UI label describing the expected input for this type.",
+ "type": "string"
+ },
+ "maxLength": {
+ "description": "Maximum allowed input length for this type.",
+ "type": "integer"
+ },
+ "placeholder": {
+ "description": "Example value for this type.",
+ "type": "string"
+ },
+ "serviceUrl": {
+ "description": "bwipjs-api.metafloor.com image URL a client fetches to render the barcode; empty string when data is missing or invalid.",
+ "type": "string"
+ },
+ "settings": {
+ "description": "The normalized rendering settings actually applied.",
+ "properties": {
+ "addQuietZone": {
+ "description": "Whether a quiet-zone margin is included.",
+ "type": "boolean"
+ },
+ "height": {
+ "description": "Applied height in pixels.",
+ "type": "integer"
+ },
+ "showText": {
+ "description": "Whether human-readable text is shown.",
+ "type": "boolean"
+ },
+ "width": {
+ "description": "Applied module scale (1-4).",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "Normalized symbology (upc, ean13, code128, code39, itf14, codabar).",
+ "type": "string"
+ },
+ "typeDisplay": {
+ "description": "Human-readable symbology name (e.g. UPC-A, Code 128).",
+ "type": "string"
+ },
+ "valid": {
+ "description": "Whether data is a valid value for type.",
+ "type": "boolean"
+ },
+ "validationMessage": {
+ "description": "Human-readable validation outcome.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "success": {
+ "description": "Whether the payload was built.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+}