Boyka Framework
Boyka Framework config file
boyka-config.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
boyka-config.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
api | object | Collection of API configurations |
listeners_package | string | Package name where all the Boyka listener implementations are placed |
ui | object | UI Configurations for Web and Mobile |
ui.delay | object | UI interaction delay settings |
ui.delay.before_click | number | Delay before clicking on an element (in ms) |
ui.delay.before_mouse_move | number | Delay before moving of mouse (in ms) |
ui.delay.before_swipe | number | Delay before swiping on the device screen or inside an element (in ms) default: 500 |
ui.delay.before_tap | number | Delay before tapping on an element (in ms) |
ui.delay.before_typing | number | Delay before typing any text in an element (in ms) |
ui.logging | object | UI logging related settings |
ui.logging.enable | boolean | If true, any log files generated by Selenium or Appium would be saved default: true |
ui.logging.exclude_logs | array<string> | List of type of logs which you want to exclude from |
ui.logging.path | string | Path where the logs should be saved default: "./logs" |
ui.mobile | object | Mobile related settings |
ui.screenshot | object | UI screenshot related settings |
ui.screenshot.enabled | boolean | Set to true to enable screenshots default: false |
ui.screenshot.extension | string | Screenshot file extension default: "png" |
ui.screenshot.path | string | Path where the screenshots will be saved default: "./screenshots" |
ui.screenshot.prefix | string | Prefix of the screenshot file name default: "SCR" |
ui.timeout | object | UI timeout related settings |
ui.timeout.explicit_wait | number | Explicit wait for the element to wait for a particular condition to succeed (in seconds) default: 10 |
ui.timeout.highlight_delay | number | Delay while Highlighting the element (in ms) default: 100 |
ui.timeout.implicit_wait | number | Implicit wait for Appium to find the element (in seconds) default: 1 |
ui.timeout.page_load_timeout | number | Page load timeout (in seconds) default: 30 |
ui.timeout.script_timeout | number | Script load timeout (in seconds) default: 10 |
ui.web | object | Web related settings |
data | object | Test Data related settings |
data.extension | string | Data file extension default: "xlsx" |
data.external | boolean | Is data file external or not default: false |
data.path | string | Test data file path default: "test-data" |
data.type | string | Test data source for test data driven testing one of: "EXCEL" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 164 properties, 88% carrying a description, max nesting depth 14.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
maximum | JSON Schema Validation, draft 2020-12 | §6.2.2 — "maximum" |
minimum | JSON Schema Validation, draft 2020-12 | §6.2.4 — "minimum" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.