@platformatic/control 2.32.0 → 2.34.0

package/index.d.ts

@@ -76,6 +76,7 @@ declare namespace control {
     getRuntimeConfig(pid: number): Promise<void>;
     getRuntimeServiceConfig(pid: number, serviceId?: string): Promise<void>;
     getRuntimeEnv(pid: number): Promise<void>;
+    getRuntimeOpenapi(pid: number, serviceId: string): Promise<unknown>;
     getRuntimeServiceEnv(pid: number, serviceId: string): Promise<unknown>;
     reloadRuntime(pid: number, options?: object): Promise<ChildProcess>;
     restartRuntime(pid: number): Promise<void>;
@@ -122,6 +123,7 @@ declare namespace control {
     export const FailedToGetRuntimeMetadata: FastifyError;
     export const FailedToGetRuntimeServices: FastifyError;
     export const FailedToGetRuntimeEnv: FastifyError;
+    export const FailedToGetRuntimeOpenapi: FastifyError;
     export const FailedToStreamRuntimeLogs: FastifyError;
     export const FailedToStopRuntime: FastifyError;
     export const FailedToReloadRuntime: FastifyError;

package/index.test-d.ts

@@ -13,6 +13,7 @@ expectType<Promise<Metric[]>>(api.getRuntimeMetrics(runtime.pid, {}))
 expectType<Promise<Metric[]>>(api.getRuntimeMetrics(runtime.pid, { format: 'json' }))
 expectType<Promise<string>>(api.getRuntimeMetrics(runtime.pid, { format: 'text' }))
 expectType<Promise<Runtime[]>>(api.getRuntimes())
+expectType<Promise<unknown>>(api.getRuntimeOpenapi(runtime.pid, service.services[0].id))
 expectType<string[]>(runtime.argv)
 expectType<number>(runtime.uptimeSeconds)
 expectType<string | null>(runtime.packageVersion)
@@ -31,6 +32,7 @@ expectType<Promise<void>>(api.close())
 expectType<FastifyError>(errors.FailedToGetRuntimeAllLogs)
 expectType<FastifyError>(errors.FailedToGetRuntimeConfig)
 expectType<FastifyError>(errors.FailedToGetRuntimeEnv)
+expectType<FastifyError>(errors.FailedToGetRuntimeOpenapi)
 expectType<FastifyError>(errors.FailedToGetRuntimeHistoryLogs)
 expectError<string>(errors.FailedToGetRuntimeHistoryLogs)
 expectError<number>(errors.FailedToGetRuntimeHistoryLogs)

package/lib/errors.js

@@ -11,6 +11,7 @@ module.exports = {
   FailedToGetRuntimeMetadata: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_METADATA`, 'Failed to get runtime metadata %s.'),
   FailedToGetRuntimeServices: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICES`, 'Failed to get runtime services %s.'),
   FailedToGetRuntimeEnv: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ENV`, 'Failed to get runtime environment variables %s.'),
+  FailedToGetRuntimeOpenapi: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_OPENAPI`, 'Failed to get runtime OpenAPI schema %s.'),
   FailedToStreamRuntimeLogs: createError(`${ERROR_PREFIX}_FAILED_TO_STREAM_RUNTIME_LOGS`, 'Failed to stream runtime logs %s.'),
   FailedToStopRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_STOP_RUNTIME`, 'Failed to stop the runtime %s.'),
   FailedToReloadRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_RELOAD_RUNTIME`, 'Failed to reload the runtime %s.'),

package/lib/runtime-api-client.js

@@ -156,6 +156,23 @@ class RuntimeApiClient {
     return runtimeEnv
   }
 
+  async getRuntimeOpenapi (pid, serviceId) {
+    const client = this.#getUndiciClient(pid)
+
+    const { statusCode, body } = await client.request({
+      path: `/api/v1/services/${serviceId}/openapi-schema`,
+      method: 'GET'
+    })
+
+    if (statusCode !== 200) {
+      const error = await body.text()
+      throw new errors.FailedToGetRuntimeOpenapi(error)
+    }
+
+    const openapi = await body.json()
+    return openapi
+  }
+
   async getRuntimeServiceEnv (pid, serviceId) {
     const client = this.#getUndiciClient(pid)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/control",
-  "version": "2.32.0",
+  "version": "2.34.0",
   "description": "Platformatic Control",
   "main": "index.js",
   "bin": {
@@ -25,8 +25,8 @@
     "split2": "^4.2.0",
     "tsd": "^0.31.0",
     "typescript": "^5.5.4",
-    "@platformatic/runtime": "2.32.0",
-    "@platformatic/service": "2.32.0"
+    "@platformatic/service": "2.34.0",
+    "@platformatic/runtime": "2.34.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -37,7 +37,7 @@
     "table": "^6.8.1",
     "undici": "^7.0.0",
     "ws": "^8.16.0",
-    "@platformatic/utils": "2.32.0"
+    "@platformatic/utils": "2.34.0"
   },
   "scripts": {
     "test": "pnpm run lint && pnpm run unit && tsd",