@stackonward/cli 0.0.1 → 1.0.1

package/dist/resources/templates/go-backend/api/openapi/services/product-api/openapi.yaml

@@ -0,0 +1,222 @@
+openapi: 3.1.1
+jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
+info:
+  title: 产品 API
+  version: 1.0.0
+  description: 服务运行状态接口契约。
+  license:
+    name: 专有许可
+    identifier: LicenseRef-Proprietary
+servers:
+  - url: http://localhost:3000
+    description: 本地服务
+x-onex-documentation-locale: zh-CN
+tags:
+  - name: 运行状态
+    description: 健康检查及监控指标
+x-tagGroups:
+  - name: 服务运行
+    tags:
+      - 运行状态
+paths:
+  /health:
+    get:
+      operationId: productapiGetHealth
+      summary: 检查服务健康
+      description: 检查服务健康，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+        "503":
+          description: 服务暂不可用
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+    head:
+      operationId: productapiHeadHealth
+      summary: 检查服务健康
+      description: 检查服务健康，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+        "503":
+          description: 服务暂不可用
+  /health/liveness:
+    get:
+      operationId: productapiGetLiveness
+      summary: 检查进程存活
+      description: 检查进程存活，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+        "503":
+          description: 服务暂不可用
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+    head:
+      operationId: productapiHeadLiveness
+      summary: 检查进程存活
+      description: 检查进程存活，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+        "503":
+          description: 服务暂不可用
+  /health/readiness:
+    get:
+      operationId: productapiGetReadiness
+      summary: 检查服务就绪
+      description: 检查服务就绪，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+        "503":
+          description: 服务暂不可用
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+    head:
+      operationId: productapiHeadReadiness
+      summary: 检查服务就绪
+      description: 检查服务就绪，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+        "503":
+          description: 服务暂不可用
+  /health/startup:
+    get:
+      operationId: productapiGetStartup
+      summary: 检查启动状态
+      description: 检查启动状态，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+        "503":
+          description: 服务暂不可用
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResult"
+    head:
+      operationId: productapiHeadStartup
+      summary: 检查启动状态
+      description: 检查启动状态，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/health
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+        "503":
+          description: 服务暂不可用
+  /metrics:
+    get:
+      operationId: productapiGetMetrics
+      summary: 读取监控指标
+      description: 读取监控指标，供运行环境探测与监控采集使用。
+      tags:
+        - 运行状态
+      security: []
+      x-onex-audience: internal
+      x-onex-owner: core/metrics
+      x-onex-stability: stable
+      responses:
+        "200":
+          description: 检查成功
+          content:
+            text/plain:
+              schema:
+                type: string
+components:
+  schemas:
+    HealthResult:
+      type: object
+      required:
+        - status
+      properties:
+        status:
+          type: string
+          enum:
+            - up
+            - down
+        components:
+          type: object
+          additionalProperties:
+            type: object
+            required:
+              - status
+            properties:
+              status:
+                type: string
+                enum:
+                  - up
+                  - down
+              details:
+                type: object
+                additionalProperties: true

package/dist/resources/templates/go-backend/api/openapi/services/worker/conformance/runtime.arazzo.yaml

@@ -0,0 +1,65 @@
+arazzo: 1.0.1
+info:
+  title: 服务健康检查
+  version: 1.0.0
+sourceDescriptions:
+  - name: service
+    url: ../dist/internal.openapi.json
+    type: openapi
+workflows:
+  - workflowId: serviceHealth
+    steps:
+      - stepId: workerGetHealth
+        operationId: workerGetHealth
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerHeadHealth
+        operationId: workerHeadHealth
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerGetLiveness
+        operationId: workerGetLiveness
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerHeadLiveness
+        operationId: workerHeadLiveness
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerGetReadiness
+        operationId: workerGetReadiness
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerHeadReadiness
+        operationId: workerHeadReadiness
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerGetStartup
+        operationId: workerGetStartup
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerHeadStartup
+        operationId: workerHeadStartup
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200
+      - stepId: workerGetMetrics
+        operationId: workerGetMetrics
+        x-onex-covers: [healthy-response]
+        x-onex-fixture-profile: healthy-runtime
+        successCriteria:
+          - condition: $statusCode == 200

package/dist/resources/templates/go-backend/api/openapi/services/worker/dist/internal.openapi.json

@@ -0,0 +1,327 @@
+{
+  "components": {
+    "schemas": {
+      "HealthResult": {
+        "properties": {
+          "components": {
+            "additionalProperties": {
+              "properties": {
+                "details": {
+                  "additionalProperties": true,
+                  "type": "object"
+                },
+                "status": {
+                  "enum": [
+                    "up",
+                    "down"
+                  ],
+                  "type": "string"
+                }
+              },
+              "required": [
+                "status"
+              ],
+              "type": "object"
+            },
+            "type": "object"
+          },
+          "status": {
+            "enum": [
+              "up",
+              "down"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "status"
+        ],
+        "type": "object"
+      }
+    }
+  },
+  "info": {
+    "description": "服务运行状态接口契约。",
+    "license": {
+      "identifier": "LicenseRef-Proprietary",
+      "name": "专有许可"
+    },
+    "title": "后台任务 API",
+    "version": "1.0.0"
+  },
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "openapi": "3.1.1",
+  "paths": {
+    "/health": {
+      "get": {
+        "description": "检查服务健康，供运行环境探测与监控采集使用。",
+        "operationId": "workerGetHealth",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "检查成功"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查服务健康",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      },
+      "head": {
+        "description": "检查服务健康，供运行环境探测与监控采集使用。",
+        "operationId": "workerHeadHealth",
+        "responses": {
+          "200": {
+            "description": "检查成功"
+          },
+          "503": {
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查服务健康",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      }
+    },
+    "/health/liveness": {
+      "get": {
+        "description": "检查进程存活，供运行环境探测与监控采集使用。",
+        "operationId": "workerGetLiveness",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "检查成功"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查进程存活",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      },
+      "head": {
+        "description": "检查进程存活，供运行环境探测与监控采集使用。",
+        "operationId": "workerHeadLiveness",
+        "responses": {
+          "200": {
+            "description": "检查成功"
+          },
+          "503": {
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查进程存活",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      }
+    },
+    "/health/readiness": {
+      "get": {
+        "description": "检查服务就绪，供运行环境探测与监控采集使用。",
+        "operationId": "workerGetReadiness",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "检查成功"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查服务就绪",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      },
+      "head": {
+        "description": "检查服务就绪，供运行环境探测与监控采集使用。",
+        "operationId": "workerHeadReadiness",
+        "responses": {
+          "200": {
+            "description": "检查成功"
+          },
+          "503": {
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查服务就绪",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      }
+    },
+    "/health/startup": {
+      "get": {
+        "description": "检查启动状态，供运行环境探测与监控采集使用。",
+        "operationId": "workerGetStartup",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "检查成功"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResult"
+                }
+              }
+            },
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查启动状态",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      },
+      "head": {
+        "description": "检查启动状态，供运行环境探测与监控采集使用。",
+        "operationId": "workerHeadStartup",
+        "responses": {
+          "200": {
+            "description": "检查成功"
+          },
+          "503": {
+            "description": "服务暂不可用"
+          }
+        },
+        "security": [],
+        "summary": "检查启动状态",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/health",
+        "x-onex-stability": "stable"
+      }
+    },
+    "/metrics": {
+      "get": {
+        "description": "读取监控指标，供运行环境探测与监控采集使用。",
+        "operationId": "workerGetMetrics",
+        "responses": {
+          "200": {
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "description": "检查成功"
+          }
+        },
+        "security": [],
+        "summary": "读取监控指标",
+        "tags": [
+          "运行状态"
+        ],
+        "x-onex-audience": "internal",
+        "x-onex-owner": "core/metrics",
+        "x-onex-stability": "stable"
+      }
+    }
+  },
+  "servers": [
+    {
+      "description": "本地服务",
+      "url": "http://localhost:3000"
+    }
+  ],
+  "tags": [
+    {
+      "description": "健康检查及监控指标",
+      "name": "运行状态"
+    }
+  ],
+  "x-onex-documentation-locale": "zh-CN",
+  "x-tagGroups": [
+    {
+      "name": "服务运行",
+      "tags": [
+        "运行状态"
+      ]
+    }
+  ]
+}

package/dist/resources/templates/go-backend/api/openapi/services/worker/dist/runtime-contract.json

@@ -0,0 +1,56 @@
+{
+  "api_version": "1.0.0",
+  "delegated_contracts": [],
+  "display_name": "后台任务 API",
+  "media_type": "application/vnd.onex.runtime-contract+json;version=2",
+  "native_operation_count": 9,
+  "operation_count": 9,
+  "route_exclusions": [
+    "/docs",
+    "/docs/",
+    "/docs/assets/scalar-api-reference.js",
+    "/docs/index.html",
+    "/docs/openapi.json"
+  ],
+  "routes": [
+    {
+      "method": "GET",
+      "path": "/health"
+    },
+    {
+      "method": "HEAD",
+      "path": "/health"
+    },
+    {
+      "method": "GET",
+      "path": "/health/liveness"
+    },
+    {
+      "method": "HEAD",
+      "path": "/health/liveness"
+    },
+    {
+      "method": "GET",
+      "path": "/health/readiness"
+    },
+    {
+      "method": "HEAD",
+      "path": "/health/readiness"
+    },
+    {
+      "method": "GET",
+      "path": "/health/startup"
+    },
+    {
+      "method": "HEAD",
+      "path": "/health/startup"
+    },
+    {
+      "method": "GET",
+      "path": "/metrics"
+    }
+  ],
+  "schema_version": 2,
+  "service": "worker",
+  "sha256": "195d968f4c042764405d5510411fd6dd3e303efc47a998990da73a4f9a09c0c8"
+}