@supermodeltools/openapi-spec 0.3.8 → 0.4.0
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 +34 -1
- package/openapi.yaml +1 -1
- package/package.json +15 -1
package/README.md
CHANGED
|
@@ -1,2 +1,35 @@
|
|
|
1
1
|
# Supermodel OpenAPI Specification
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@supermodeltools/openapi-spec)
|
|
4
|
+
[](https://spec.openapis.org/oas/v3.0.0)
|
|
5
|
+
|
|
6
|
+
OpenAPI 3.0 specification for the [Supermodel API](https://docs.supermodeltools.com) - code graphing and static analysis.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install @supermodeltools/openapi-spec
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
The spec is available at `node_modules/@supermodeltools/openapi-spec/openapi.yaml`.
|
|
15
|
+
|
|
16
|
+
## Endpoints
|
|
17
|
+
|
|
18
|
+
| Method | Path | Description |
|
|
19
|
+
|--------|------|-------------|
|
|
20
|
+
| POST | `/v1/graphs/dependency` | File-level dependency graph |
|
|
21
|
+
| POST | `/v1/graphs/call` | Function-level call graph |
|
|
22
|
+
| POST | `/v1/graphs/domain` | Domain model classification |
|
|
23
|
+
| POST | `/v1/graphs/parse` | AST parse tree relationships |
|
|
24
|
+
| POST | `/v1/graphs/supermodel` | Full Supermodel IR bundle |
|
|
25
|
+
|
|
26
|
+
All endpoints accept a zipped repository snapshot and return graph data as JSON.
|
|
27
|
+
|
|
28
|
+
## Authentication
|
|
29
|
+
|
|
30
|
+
Requests require an API key via `X-Api-Key` header. Get your key from the [Supermodel Dashboard](https://supermodeltools.com/dashboard).
|
|
31
|
+
|
|
32
|
+
## Links
|
|
33
|
+
|
|
34
|
+
- [API Documentation](https://docs.supermodeltools.com)
|
|
35
|
+
- [API Terms of Service](https://supermodeltools.com/legal/api-terms)
|
package/openapi.yaml
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@supermodeltools/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Supermodel Public OpenAPI Specification",
|
|
5
5
|
"main": "openapi.yaml",
|
|
6
6
|
"files": [
|
|
@@ -10,6 +10,20 @@
|
|
|
10
10
|
"type": "git",
|
|
11
11
|
"url": "git+https://github.com/supermodeltools/openapi-spec.git"
|
|
12
12
|
},
|
|
13
|
+
"homepage": "https://docs.supermodeltools.com",
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/supermodeltools/openapi-spec/issues"
|
|
16
|
+
},
|
|
17
|
+
"keywords": [
|
|
18
|
+
"openapi",
|
|
19
|
+
"api",
|
|
20
|
+
"code-graph",
|
|
21
|
+
"dependency-graph",
|
|
22
|
+
"call-graph",
|
|
23
|
+
"static-analysis",
|
|
24
|
+
"code-analysis",
|
|
25
|
+
"supermodel"
|
|
26
|
+
],
|
|
13
27
|
"author": "Supermodel <abe@supermodel.software>",
|
|
14
28
|
"license": "UNLICENSED"
|
|
15
29
|
}
|