metarhia / contracts Goto Github PK

Metarhia core docs and contracts specifications 📒

License: MIT License

metarhia impress metacom serverless metaserverless contract

contracts's Introduction

Metarhia specification

Technology stack core contracts and short specifications. Not everything in this specification is the current state of the art in the technology stack. Here we describe how it should be. For the latest information, see the documentation here: https://github.com/metarhia/Docs

Languages: English | Русский

contracts's People

Contributors

Stargazers

Watchers

Forkers

olewar georgolden leonpolak nau7ilus lutsenkods sarnakov

contracts's Issues

Transport protocol contract

API endpoint contract

Error in specification Database.md

https://github.com/metarhia/Contracts/blob/master/doc/Database.md#L72
Should be:

Entity - entity, have own id for primary key;

Schema and generated SQL from metadomain:

Unit.js:

({
  Registry: {},

  name: { type: 'string', unique: true },
  parent: '?Unit',
});

CREATE TABLE "Unit" (
  "id" bigint generated always as identity,
  "name" varchar NOT NULL,
  "parentId" bigint NULL
);

ALTER TABLE "Unit" ADD CONSTRAINT "pkUnit" PRIMARY KEY ("id");
ALTER TABLE "Unit" ADD CONSTRAINT "fkUnitId" FOREIGN KEY ("id") REFERENCES "Identifier" ("id");
ALTER TABLE "Unit" ADD CONSTRAINT "fkUnitParent" FOREIGN KEY ("parentId") REFERENCES "Unit" ("id");

Role.js:

({
  Entity: {},

  name: { type: 'string', unique: true },
  active: { type: 'boolean', default: true },
  unit: 'Unit',
});

CREATE TABLE "Role" (
  "roleId" bigint generated always as identity,
  "name" varchar NOT NULL,
  "active" boolean NOT NULL DEFAULT true,
  "unitId" bigint NOT NULL
);

ALTER TABLE "Role" ADD CONSTRAINT "pkRole" PRIMARY KEY ("roleId");
ALTER TABLE "Role" ADD CONSTRAINT "fkRoleUnit" FOREIGN KEY ("unitId") REFERENCES "Unit" ("id");

How to describe an array of specified objects?

I have tried to validate a return-value at the "api.example.countries" method from the example reposytory.
It returns something like this:

{
  result: "success",
  data: [{
    countryId: "1",
    name: "Soviet Union"
  }]
}

I have modified this method:

({
  access: 'public',

  returns: {
    result: 'string',
    data: {
      type: 'array',
      value: {
        countryId: 'string',
        name: 'string',
      },
    },
  },

  method: .....
});

And now I see an error in the browser console on a method call:
Invalid result type: Field "data" expected to be array of [object Object].
Of cause I can define the data as

data: {
  type: 'array',
  value: 'object'
}

But it is not strict.

So how I can define a schema in a right way?

Error-handling guidelines

When we throw and when return Error instance to escalate error-handling

metarhia / contracts Goto Github PK

contracts's Introduction

Metarhia specification

contracts's People

Contributors

Stargazers

Watchers

Forkers

contracts's Issues

Transport protocol contract

API endpoint contract

Error in specification Database.md

How to describe an array of specified objects?

Error-handling guidelines

Scheduler task contract

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent