@ubio/protocol v7.7.0
ubio Automation Protocol
Terminology
Domain is a collection of input, output and type definitions. Domains are uniquely identified by id
which is a PascalCase string. Example: FlightBooking
.
Definition is a JSON Schema object, uniquely identified by id
, which consists of domain id
and definition key
, separated with dot. Example: Generic.Price
.
Definitions also have $id
attribute which is a fragment identifier used to uniquely reference definitions in JSON Schema validation. Example: #Generic.Price
.
Quick Start
To make changes to protocol src/schema/
files need to be updated and schema.json
regenerated.
Since current codebase may be not compatible with the recent version of nodejs, you may need docker-compose.yml
to test changes locally.
Additionally, protocol URL is hardcoded and points to production environment, thus you may need to temporary override it to see changes on http://localhost:8080/. Edit site/provider.js
but DO NOT commit it to GH repo with your other changes:
export const provider = new ProtocolProvider({
url: 'http://localhost:8080/schema.json', // ! \\
autoRefresh: true,
ttl: 60000
});
Build ./public
static files:
$ docker-compose run build
Run nginx
and open browser to test it:
$ docker-compose up nginx -d
$ open 'http://localhost:8080/'
Shut down and cleanup when done:
$ docker-compose down
Don't forget to revert site/provider.js
:
$ git checkout site/provider.js
Good luck!
3 months ago
4 months ago
4 months ago
4 months ago
7 months ago
8 months ago
9 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
12 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago