The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.
Add Spectral lint CI gate for openapi.yaml (#13410)
Matt Miller1ac60da2c9c8
diff --git a/.github/workflows/openapi-lint.yml b/.github/workflows/openapi-lint.ymlnew file mode 100644index 000000000..be949de2a--- /dev/null+++ b/.github/workflows/openapi-lint.yml@@ -0,0 +1,31 @@+name: OpenAPI Lint++on:+ pull_request:+ paths:+ - 'openapi.yaml'+ - '.spectral.yaml'+ - '.github/workflows/openapi-lint.yml'++permissions:+ contents: read++jobs:+ spectral:+ name: Run Spectral+ runs-on: ubuntu-latest++ steps:+ - name: Checkout repository+ uses: actions/checkout@v4++ - name: Set up Node.js+ uses: actions/setup-node@v4+ with:+ node-version: '20'++ - name: Install Spectral+ run: npm install -g @stoplight/spectral-cli@6++ - name: Lint openapi.yaml+ run: spectral lint openapi.yaml --ruleset .spectral.yaml --fail-severity=errordiff --git a/.spectral.yaml b/.spectral.yamlnew file mode 100644index 000000000..4bb4a4a94--- /dev/null+++ b/.spectral.yaml@@ -0,0 +1,91 @@+extends:+ - spectral:oas++# Severity levels: error, warn, info, hint, off+# Rules from the built-in "spectral:oas" ruleset are active by default.+# Below we tune severity and add custom rules for our conventions.+#+# This ruleset mirrors Comfy-Org/cloud/.spectral.yaml so specs across the+# organization are linted against a single consistent standard.++rules:+ # -----------------------------------------------------------------------+ # Built-in rule severity overrides+ # -----------------------------------------------------------------------+ operation-operationId: error+ operation-description: warn+ operation-tag-defined: error+ info-contact: off+ info-description: warn+ no-eval-in-markdown: error+ no-$ref-siblings: error++ # -----------------------------------------------------------------------+ # Custom rules: naming conventions+ # -----------------------------------------------------------------------++ # Property names should be snake_case+ property-name-snake-case:+ description: Property names must be snake_case+ severity: warn+ given: "$.components.schemas.*.properties[*]~"+ then:+ function: pattern+ functionOptions:+ match: "^[a-z][a-z0-9]*(_[a-z0-9]+)*$"++ # Operation IDs should be camelCase+ operation-id-camel-case:+ description: Operation IDs must be camelCase+ severity: warn+ given: "$.paths.*.*.operationId"+ then:+ function: pattern+ functionOptions:+ match: "^[a-z][a-zA-Z0-9]*$"++ # -----------------------------------------------------------------------+ # Custom rules: response conventions+ # -----------------------------------------------------------------------++ # Error responses (4xx, 5xx) should use a consistent shape+ error-response-schema:+ description: Error responses should reference a standard error schema+ severity: hint+ given: "$.paths.*.*.responses[?(@property >= '400' && @property < '600')].content['application/json'].schema"+ then:+ field: "$ref"+ function: truthy++ # All 2xx responses with JSON body should have a schema+ response-schema-defined:+ description: Success responses with JSON content should define a schema+ severity: warn+ given: "$.paths.*.*.responses[?(@property >= '200' && @property < '300')].content['application/json']"+ then:+ field: schema+ function: truthy++ # -----------------------------------------------------------------------+ # Custom rules: best practices+ # -----------------------------------------------------------------------++ # Path parameters must have a description+ path-param-description:+ description: Path parameters should have a description+ severity: warn+ given:+ - "$.paths.*.parameters[?(@.in == 'path')]"+ - "$.paths.*.*.parameters[?(@.in == 'path')]"+ then:+ field: description+ function: truthy++ # Schemas should have a description+ schema-description:+ description: Component schemas should have a description+ severity: hint+ given: "$.components.schemas.*"+ then:+ field: description+ function: truthy