@get-enlace/nest 0.0.2 → 0.0.4

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.
Files changed (2) hide show
  1. package/README.md +10 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -37,6 +37,16 @@ export class AppModule {}
37
37
 
38
38
  `spec` accepts a file path, a URL, or an already-parsed OpenAPI 3.x object.
39
39
 
40
+ ### What Enlace needs from your spec
41
+
42
+ Whatever produces it, `servers[0].url` needs to be your API's real, reachable base URL — Enlace
43
+ sends every request in a chain straight there from the browser. `operationId` is optional (Enlace
44
+ falls back to a synthetic `METHOD /path` label without one) but is what shows on the node and in
45
+ the operation search — `@nestjs/swagger` sets one per route by default (`ControllerName_methodName`).
46
+
47
+ Already serving `@nestjs/swagger`'s own Swagger UI from that same document? Handing it to Enlace
48
+ too doesn't change how that keeps working — they're independent consumers of the same object.
49
+
40
50
  ### Custom mount path
41
51
 
42
52
  By default the canvas is at `/enlace`. To change it:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@get-enlace/nest",
3
3
  "private": false,
4
- "version": "0.0.2",
4
+ "version": "0.0.4",
5
5
  "description": "Simple NestJS adapter for @get-enlace/ui. Early dev preview: no persistence yet (serves the spec + UI bundle only), install via the `dev` dist-tag on GitHub Packages.",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -36,7 +36,7 @@
36
36
  "reflect-metadata": "^0.1.13 || ^0.2.0"
37
37
  },
38
38
  "dependencies": {
39
- "@get-enlace/ui": "0.0.3",
39
+ "@get-enlace/ui": "0.0.4",
40
40
  "js-yaml": "^4.1.0"
41
41
  },
42
42
  "devDependencies": {