Merge pull request #13 from kaleido-io/types

Add generated types from OpenAPI

Author: awrichar

.eslintrc.json

@@ -20,7 +20,8 @@
     "node": true
   },
   "ignorePatterns": [
-    ".eslintrc.js"
+    ".eslintrc.js",
+    "lib/schema.ts"
   ],
   "rules": {
     "@typescript-eslint/interface-name-prefix": "off",
@@ -50,4 +51,4 @@
     "eol-last": "warn",
     "no-trailing-spaces": "warn"
   }
-}
+}

README.md

@@ -24,6 +24,16 @@ await firefly.sendBroadcast({
 });
 ```
 
+## Generated schemas
+
+The types for FireFly requests and responses are generated from the OpenAPI schema for FireFly. If you have
+the `firefly` repository cloned in a folder parallel to this one, you can run the following to re-generate
+the TypeScript interfaces from the latest FireFly definitions:
+
+```bash
+npm run schema
+```
+
 ## Git repositories
 
 There are multiple Git repos making up the Hyperledger FireFly project. Some others