@produce8/analytics-openapi-types 1.0.0-dev.20251215233108 → 1.0.0-dev.20251215234924
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 +14 -1
- package/openapi.json +1668 -0
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @produce8/analytics-openapi-types
|
|
2
2
|
|
|
3
|
-
TypeScript types
|
|
3
|
+
TypeScript types and OpenAPI specification from the Analytics Service.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -12,6 +12,8 @@ yarn add @produce8/analytics-openapi-types
|
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
|
+
### TypeScript Types
|
|
16
|
+
|
|
15
17
|
```typescript
|
|
16
18
|
import type {
|
|
17
19
|
paths,
|
|
@@ -25,6 +27,17 @@ const healthCheck: operations['HealthController_healthCheck'] = {
|
|
|
25
27
|
};
|
|
26
28
|
```
|
|
27
29
|
|
|
30
|
+
### OpenAPI JSON Spec
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
// Import the OpenAPI spec
|
|
34
|
+
import openApiSpec from '@produce8/analytics-openapi-types/openapi.json';
|
|
35
|
+
|
|
36
|
+
// Or resolve the path
|
|
37
|
+
import { resolve } from 'path';
|
|
38
|
+
const openApiPath = require.resolve('@produce8/analytics-openapi-types/openapi.json');
|
|
39
|
+
```
|
|
40
|
+
|
|
28
41
|
## Environment Tags
|
|
29
42
|
|
|
30
43
|
This package is published with different dist-tags based on the environment:
|