@spotto/contract 1.0.34-alpha.5 → 1.0.34-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -33
- package/dist/assets/index.d.ts +1 -0
- package/dist/assets/index.js +1 -0
- package/dist/assets/index.js.map +1 -1
- package/dist/assets/summary/index.d.ts +1 -0
- package/dist/assets/summary/index.js +18 -0
- package/dist/assets/summary/index.js.map +1 -0
- package/dist/assets/summary/summary.d.ts +9 -0
- package/dist/assets/summary/summary.js +3 -0
- package/dist/assets/summary/summary.js.map +1 -0
- package/dist/readers/[id]/patch/request.d.ts +1 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
# README
|
|
2
|
-
|
|
3
|
-
This repository is a source of truth / documentation for the spotto-api.
|
|
4
|
-
|
|
5
|
-
The repository consists of a series of typescript classes that document the API contract
|
|
6
|
-
between the spotto API and its clients
|
|
7
|
-
|
|
8
|
-
### How do I get set up?
|
|
9
|
-
|
|
10
|
-
1. Clone this repository
|
|
11
|
-
1. yarn install
|
|
12
|
-
1. run 'yarn start' to start a documentation server
|
|
13
|
-
|
|
14
|
-
### Contribution guidelines
|
|
15
|
-
|
|
16
|
-
When adding endpoints create a new folder / file for your endpoint.
|
|
17
|
-
Fill out file using others as a guide.
|
|
18
|
-
|
|
19
|
-
Any response and request shapes should be specified in the /types folder. The documentation server
|
|
20
|
-
is sometimes unable to understand more complicated interfaces. In these scenarios please create two
|
|
21
|
-
types files, one with a logical working type that can be used by other repositories. The other will
|
|
22
|
-
be simply for filling the response server.
|
|
23
|
-
|
|
24
|
-
Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.
|
|
25
|
-
|
|
26
|
-
- types
|
|
27
|
-
- objects
|
|
28
|
-
- objectTypes.ts
|
|
29
|
-
- objectTypesDocs.ts
|
|
30
|
-
|
|
31
|
-
### Who do I talk to?
|
|
32
|
-
|
|
33
|
-
- Repo owner or admin
|
|
1
|
+
# README
|
|
2
|
+
|
|
3
|
+
This repository is a source of truth / documentation for the spotto-api.
|
|
4
|
+
|
|
5
|
+
The repository consists of a series of typescript classes that document the API contract
|
|
6
|
+
between the spotto API and its clients
|
|
7
|
+
|
|
8
|
+
### How do I get set up?
|
|
9
|
+
|
|
10
|
+
1. Clone this repository
|
|
11
|
+
1. yarn install
|
|
12
|
+
1. run 'yarn start' to start a documentation server
|
|
13
|
+
|
|
14
|
+
### Contribution guidelines
|
|
15
|
+
|
|
16
|
+
When adding endpoints create a new folder / file for your endpoint.
|
|
17
|
+
Fill out file using others as a guide.
|
|
18
|
+
|
|
19
|
+
Any response and request shapes should be specified in the /types folder. The documentation server
|
|
20
|
+
is sometimes unable to understand more complicated interfaces. In these scenarios please create two
|
|
21
|
+
types files, one with a logical working type that can be used by other repositories. The other will
|
|
22
|
+
be simply for filling the response server.
|
|
23
|
+
|
|
24
|
+
Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.
|
|
25
|
+
|
|
26
|
+
- types
|
|
27
|
+
- objects
|
|
28
|
+
- objectTypes.ts
|
|
29
|
+
- objectTypesDocs.ts
|
|
30
|
+
|
|
31
|
+
### Who do I talk to?
|
|
32
|
+
|
|
33
|
+
- Repo owner or admin
|
package/dist/assets/index.d.ts
CHANGED
package/dist/assets/index.js
CHANGED
|
@@ -23,4 +23,5 @@ __exportStar(require("./post"), exports);
|
|
|
23
23
|
__exportStar(require("./suggestions"), exports);
|
|
24
24
|
__exportStar(require("./upload"), exports);
|
|
25
25
|
__exportStar(require("./errors"), exports);
|
|
26
|
+
__exportStar(require("./summary"), exports);
|
|
26
27
|
//# sourceMappingURL=index.js.map
|
package/dist/assets/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/assets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,0CAAuB;AACvB,6CAA0B;AAC1B,wCAAqB;AACrB,6CAA0B;AAC1B,yCAAsB;AACtB,gDAA6B;AAC7B,2CAAwB;AACxB,2CAAwB"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/assets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,0CAAuB;AACvB,6CAA0B;AAC1B,wCAAqB;AACrB,6CAA0B;AAC1B,yCAAsB;AACtB,gDAA6B;AAC7B,2CAAwB;AACxB,2CAAwB;AACxB,4CAAyB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './summary';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./summary"), exports);
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/assets/summary/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/assets/summary/summary.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spotto/contract",
|
|
3
3
|
"license": "ISC",
|
|
4
|
-
"version": "1.0.34-alpha.
|
|
4
|
+
"version": "1.0.34-alpha.7",
|
|
5
5
|
"description": "Spotto's API Contract type definitions",
|
|
6
6
|
"main": "./dist/index.js",
|
|
7
7
|
"files": [
|
|
@@ -15,5 +15,5 @@
|
|
|
15
15
|
"@types/geojson": "^7946.0.11",
|
|
16
16
|
"shx": "^0.3.4"
|
|
17
17
|
},
|
|
18
|
-
"gitHead": "
|
|
18
|
+
"gitHead": "96231125b80d46febbb1ab050ec90ef5969dab4c"
|
|
19
19
|
}
|