diff --git a/.eslintrc.js b/.eslintrc.js index 5001d24d9b76175066ac3d5185d51ace55414a16..8119586f80c2273af5a7ac703e4d3a8bad8d7d45 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -4,6 +4,7 @@ module.exports = { plugins: ['@typescript-eslint'], extends: ["eslint:recommended", "plugin:@typescript-eslint/eslint-recommended", "plugin:@typescript-eslint/recommended", "plugin:storybook/recommended"], rules: { + "@typescript-eslint/no-empty-interface": "off", "@typescript-eslint/no-inferrable-types": "off", "@typescript-eslint/interface-name-prefix": [0], // "no-unused-vars": "off", diff --git a/src/atlasComponents/sapi/README.md b/src/atlasComponents/sapi/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d719baab09cef09adaf7ec9db3dfac29dea2f7cc --- /dev/null +++ b/src/atlasComponents/sapi/README.md @@ -0,0 +1,11 @@ +# SAPI (siibra-api) + +siibra-explorer gets the atlas metadata from siibra-api (http://github.com/fzj-inm1-bda/siibra-api) + +Production instance of siibra-api is at: https://siibra-api-stable.apps.hbp.eu/v2_0/docs + +As siibra-api implements openapi, the schema of the responses can be automatically populated by: + +```sh +npm run sapi-schema +``` diff --git a/src/plugin/README.md b/src/plugin/README.md index 8656ab3155dcd446795a36f562a66e3d06761eb1..335deac9af97ac0e8b0e13968fa84eeeb610eca4 100644 --- a/src/plugin/README.md +++ b/src/plugin/README.md @@ -42,6 +42,12 @@ Please note that the `handshake.init` needs to be responded to, *before* any oth ## API References +The API is generated automatically with the following script: + +```sh +npm run api-schema +``` + [handshake API](./handshake.md) [broadcast API](./broadcast.md)