@nylorun/runtime 0.19.0-beta → 0.19.1-beta

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.19.1-beta
+
+### Patch Changes
+
+- 4b499ee: **The Runtime API's reference lists the Service endpoints last.** The Runtime API's tag groups are now Agents, Sessions, Sandboxes, Artifacts and Service. Service holds what was the Runtime tag under Get started: `/health`, `/ready`, `/v1/me`, the JWKS and `/openapi/runtime.json`. Sandboxes and Artifacts are a group each. The document no longer lists the `/openapi.json` alias; the Runtime still serves it.
+
 ## 0.19.0-beta
 
 ### Major Changes

package/README.md

@@ -184,8 +184,9 @@ https://cdn.jsdelivr.net/npm/@nylorun/runtime@<version>/dist/management-openapi.
 ```
 
 Each document has described tags, in the order a developer uses them. The Runtime API's are
-grouped (`x-tagGroups`): Get started (Runtime), Agents (Agents, Definition files),
-Sessions (Sessions API, AG-UI, A2A) and Sandboxes & artifacts. The Management API's are
+grouped (`x-tagGroups`): Agents (Agents, Definition files), Sessions (Sessions API, AG-UI,
+A2A), Sandboxes, Artifacts and Service (health, readiness, `/v1/me`, the JWKS and the
+document; the `/openapi.json` alias is served but not listed). The Management API's are
 Tenant, Application keys, Models, Vaults, Signing keys and Settings. Each operation's
 `security` says which credentials it takes (application key and trusted issuer's token in
 the Runtime API; management key in the Management API), and its

package/dist/api/openapi.js

@@ -25,7 +25,10 @@ const bearer = (description, bearerFormat) => ({
     ...(bearerFormat ? { bearerFormat } : {}),
     description,
 });
-/** `/health`, `/ready` and `/openapi.json`: what every listener answers without a key. */
+/**
+ * `/health`, `/ready` and the documents: what every listener answers without a key. The
+ * `/openapi.json` alias is served but left out of the documents.
+ */
 function hostRoutes() {
     const registry = new OpenAPIRegistry();
     const route = (config) => registry.registerPath(config);
@@ -64,13 +67,6 @@ function hostRoutes() {
         description: "This document. `/openapi.json` is the same.",
         responses: { 200: { description: "The Runtime API's OpenAPI document" } },
     });
-    route({
-        method: "get",
-        path: "/openapi.json",
-        tags: ["Host"],
-        summary: "Get the Runtime API's document (alias)",
-        responses: { 200: { description: "The Runtime API's OpenAPI document" } },
-    });
     route({
         method: "get",
         path: "/openapi/management.json",
@@ -86,19 +82,6 @@ function tenantSchemes(registry) {
     registry.registerComponent("securitySchemes", "issuerToken", bearer("A JWT from a trusted issuer of the Host's identity file (Host feature `trusted-issuers`): one person, with the issuer's scopes, agents and sandbox grants, until it expires. Accepted from servers and browsers alike; CORS is the operator's proxy's.", "JWT"));
 }
 const RUNTIME_TAGS = [
-    {
-        name: "Runtime",
-        group: "Get started",
-        description: "Check a Runtime is up and speaks your protocol, ask who your credential is, and read the public keys of the tokens it signs. `/health`, `/ready`, the JWKS and the documents need no key.",
-        operations: [
-            "GET /health",
-            "GET /ready",
-            "GET /v1/me",
-            "GET /v1/access/jwks",
-            "GET /openapi/runtime.json",
-            "GET /openapi.json",
-        ],
-    },
     {
         name: "Agents",
         group: "Agents",
@@ -147,7 +130,7 @@ const RUNTIME_TAGS = [
     },
     {
         name: "Sandboxes",
-        group: "Sandboxes & artifacts",
+        group: "Sandboxes",
         description: "Isolated machines an agent works in: create or find one, watch its lifecycle, stop, reset or delete it. In `@nylorun/agents`.",
         operations: [
             "PUT /v1/sandboxes/{sandboxId}",
@@ -161,7 +144,7 @@ const RUNTIME_TAGS = [
     },
     {
         name: "Artifacts",
-        group: "Sandboxes & artifacts",
+        group: "Artifacts",
         description: "Files and folders agents and people produce, versioned, with short-lived capability links to share them. In `@nylorun/agents`.",
         operations: [
             "POST /v1/artifacts",
@@ -178,6 +161,18 @@ const RUNTIME_TAGS = [
             "DELETE /v1/artifacts/{artifactId}",
         ],
     },
+    {
+        name: "Service",
+        group: "Service",
+        description: "Check a Runtime is up and speaks your protocol, ask who your credential is, and read the public keys of the tokens it signs. `/health`, `/ready`, the JWKS and the documents need no key.",
+        operations: [
+            "GET /health",
+            "GET /ready",
+            "GET /v1/me",
+            "GET /v1/access/jwks",
+            "GET /openapi/runtime.json",
+        ],
+    },
 ];
 const MANAGEMENT_TAGS = [
     {

package/dist/management-openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.2.0",
   "info": {
     "title": "Nylorun Management API",
-    "version": "0.19.0-beta",
+    "version": "0.19.1-beta",
     "x-nylorun-protocol": {
       "min": 4,
       "max": 8,