Validation of CreateBrowserInput

In the RESTful API v3, When I only set url of CreateBrowserInput Bluescape API accepts it, But if I add

"style": {
"frameless": true,
"width": 200,
"height": 200
}

to my payload Bluescape returns the following errors, it seems something is wrong in Bluescape validator, at least the response it not meaningful. I found that the width and height has a minimum 240 limitation, but the error response is misleading

[
  {
    path: '',
    code: 'required',
    message: "must have required property 'imageFormat'",
    info: { missingProperty: 'imageFormat' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'style' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'width' }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'height' }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'points'",
    info: { missingProperty: 'points' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'width' }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'height' }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'documentFormat'",
    info: { missingProperty: 'documentFormat' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'style' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style/width',
    code: 'minimum',
    message: 'must be >= 640',
    info: { comparison: '>=', limit: 640 }
  },
  {
    path: '/style/height',
    code: 'minimum',
    message: 'must be >= 240',
    info: { comparison: '>=', limit: 240 }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'videoFormat'",
    info: { missingProperty: 'videoFormat' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'style' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'name'",
    info: { missingProperty: 'name' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'cells'",
    info: { missingProperty: 'cells' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'width' }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'height' }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'start'",
    info: { missingProperty: 'start' }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'end'",
    info: { missingProperty: 'end' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'width' }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'height' }
  },
  {
    path: '',
    code: 'required',
    message: "must have required property 'assetPath'",
    info: { missingProperty: 'assetPath' }
  },
  {
    path: '',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'url' }
  },
  {
    path: '/type',
    code: 'enum',
    message: 'must be equal to one of the allowed values',
    info: { allowedValues: [Array] }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'width' }
  },
  {
    path: '/style',
    code: 'additionalProperties',
    message: 'must NOT have additional properties',
    info: { additionalProperty: 'height' }
  },
  {
    path: '',
    code: 'oneOf',
    message: 'must match exactly one schema in oneOf',
    info: { passingSchemas: null }
  }
]

hi @Amerehei,

Sorry to hear that you are having an issue with the createBrowserInput API.

We currently enforce max/min values for width height, so 200x200 will throw an error.

The range of values are:

width: [640 - 4320]
height: [240 - 3840]

Iā€™ll see if we can address the max/min values for a future release, and can keep you informed on progress for future release

You can view our API REST documentation here

I also agree that the error message is pretty cryptic - this is a bug.

1 Like

Hi @Amerehei ,

Good news! We have fixed the issue of creating 200x200 web browser elements. You can now create a browser with min of 200x200.

If you are still needing this feature, it will be part of 23.09.14 release which will be released on Thursday 9/12.

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.