@mercury-fw/channel-http 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mercury-fw/channel-http
 
+## 0.13.1
+
+### Patch Changes
+
+- f631dd5: README: a link to the package's page on Mercury's documentation site (https://lucabro81.github.io/mercury-fw/), published from this release on. The HTTP channel's README points to the HTTP API reference there, and the core's memory section to the page that explains it.
+
 ## 0.13.0
 
 ### Minor Changes

package/README.md

@@ -2,6 +2,8 @@
 
 Gives a [Mercury](https://github.com/lucabro81/mercury-fw) agent an HTTP surface to build a custom UI on: one conversational turn per request, streamed back as Server-Sent Events, plus confirmation and read-only routes over what the agent holds (conversations, the wiki, memory, its plugins).
 
+On Mercury's documentation site: [its page](https://lucabro81.github.io/mercury-fw/plugins/channel-http/).
+
 This version is written for version 6 of the channel contract, the one that brings the channels' texts in the person's language, and needs the framework at 0.59 or later, the first whose core gives channels its version (`GET /version`). A core with an older contract skips it, and the log says why.
 
 ```bash
@@ -35,7 +37,7 @@ It's active whenever it's declared in `mercury.config.ts`'s `channels` with an a
 
 **CORS** is enabled on every response and every route answers an `OPTIONS` preflight, so a browser UI on another origin can call it. The allowed origin is `HTTP_SURFACE_CORS_ORIGIN` (default `*`: the token travels in a header, never in a cookie the browser would send on its own).
 
-The full contract is described by an **OpenAPI document**, served raw at `GET /openapi.yaml` and published as a rendered docs page on GitHub Pages (see `packages/channels/channel-http/openapi.yaml`, the single source of truth).
+The full contract is described by an **OpenAPI document**, served raw at `GET /openapi.yaml` and published as [the HTTP API reference](https://lucabro81.github.io/mercury-fw/reference/http-api/) on the documentation site (see `packages/channels/channel-http/openapi.yaml`, the single source of truth).
 
 All responses are JSON except `POST /turn`, which streams `text/event-stream`. Every JSON response is either `{ "ok": true, ... }` or, on error, `{ "ok": false, "error": "<message>" }` with HTTP `400`/`401`/`500`.
 

package/dist/http-server.d.ts

@@ -47,9 +47,9 @@ export type TurnRequestDeps = {
 };
 /**
  * Serves the OpenAPI document that describes this surface — the single source
- * of truth in this package's `openapi.yaml`, also rendered as the GitHub Pages
- * API docs. Served raw as `text/yaml` (no YAML parser needed at runtime); most
- * tooling (Redoc, Swagger UI, Postman) reads YAML directly.
+ * of truth in this package's `openapi.yaml`, also rendered as the docs site's
+ * HTTP API reference. Served raw as `text/yaml` (no YAML parser needed at
+ * runtime); most tooling (Redoc, Swagger UI, Postman) reads YAML directly.
  */
 export declare function openApiResponse(corsOrigin?: string): Response;
 /**

package/http-server.ts

@@ -153,9 +153,9 @@ function preflight(origin: string): Response {
 
 /**
  * Serves the OpenAPI document that describes this surface — the single source
- * of truth in this package's `openapi.yaml`, also rendered as the GitHub Pages
- * API docs. Served raw as `text/yaml` (no YAML parser needed at runtime); most
- * tooling (Redoc, Swagger UI, Postman) reads YAML directly.
+ * of truth in this package's `openapi.yaml`, also rendered as the docs site's
+ * HTTP API reference. Served raw as `text/yaml` (no YAML parser needed at
+ * runtime); most tooling (Redoc, Swagger UI, Postman) reads YAML directly.
  */
 export function openApiResponse(corsOrigin = "*"): Response {
   const file = Bun.file(new URL("./openapi.yaml", import.meta.url));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/channel-http",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -21,8 +21,8 @@
     "@mercury-fw/channel-types": ">=0.59.0 <1.0.0"
   },
   "devDependencies": {
-    "@mercury-fw/channel-types": "0.59.0",
-    "@mercury-fw/plugin-types": "0.59.0",
+    "@mercury-fw/channel-types": "0.59.2",
+    "@mercury-fw/plugin-types": "0.59.2",
     "@mercury-fw/typescript-config": "*",
     "@types/bun": "^1.4.2",
     "typescript": "^6.0.3"