From 775959a490d5b7e9c197b82fe5c5aba1d959e68d Mon Sep 17 00:00:00 2001 From: Matthew Larson Date: Thu, 31 Jul 2025 10:22:20 -0500 Subject: [PATCH] Remove broken OpenAPI validation This workflow attempts to validate the openAPI.yaml file, but it never passed, not even at the time it was first added. The configuration it uses for the linter is now outdated - the linter no longer uses .validaterc. Modifying the spec to adhere to what the linter expects would, at this point, involve modifying the interface exposed by other projects, which would be a significant undertaking. Additonally, the API spec hasn't been modified in years, so linting it regularly doesn't seem particularly useful. --- .github/workflows/validate.yml | 20 ------ .validaterc | 109 --------------------------------- 2 files changed, 129 deletions(-) delete mode 100644 .github/workflows/validate.yml delete mode 100644 .validaterc diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml deleted file mode 100644 index b7d2f6a..0000000 --- a/.github/workflows/validate.yml +++ /dev/null @@ -1,20 +0,0 @@ -# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions - -name: Node.js CI - -on: [push, workflow_dispatch] - -jobs: - validateOpenApiSpec: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Use Node.js - uses: actions/setup-node@v2 - with: - node-version: 12 - - run: npm install -g ibm-openapi-validator - - run: lint-openapi openapi.yaml diff --git a/.validaterc b/.validaterc deleted file mode 100644 index 250f69b..0000000 --- a/.validaterc +++ /dev/null @@ -1,109 +0,0 @@ -{ - "shared": { - "operations": { - "no_operation_id": "warning", - "operation_id_case_convention": [ - "warning", - "lower_snake_case" - ], - "no_summary": "warning", - "no_array_responses": "error", - "parameter_order": "warning", - "undefined_tag": "warning", - "unused_tag": "warning", - "operation_id_naming_convention": "warning" - }, - "pagination": { - "pagination_style": "warning" - }, - "parameters": { - "no_parameter_description": "error", - "param_name_case_convention": [ - "error", - "lower_camel_case" - ], - "invalid_type_format_pair": "error", - "content_type_parameter": "error", - "accept_type_parameter": "error", - "authorization_parameter": "warning", - "required_param_has_default": "warning" - }, - "paths": { - "missing_path_parameter": "error", - "duplicate_path_parameter": "warning", - "snake_case_only": "off", - "paths_case_convention": [ - "error", - "lower_snake_case" - ] - }, - "responses": { - "inline_response_schema": "warning" - }, - "security_definitions": { - "unused_security_schemes": "warning", - "unused_security_scopes": "warning" - }, - "security": { - "invalid_non_empty_security_array": "error" - }, - "schemas": { - "invalid_type_format_pair": "error", - "snake_case_only": "off", - "no_schema_description": "warning", - "no_property_description": "warning", - "description_mentions_json": "warning", - "array_of_arrays": "warning", - "inconsistent_property_type": [ - "warning", - [ - "code", - "default", - "type", - "value" - ] - ], - "property_case_convention": [ - "error", - "lower_camel_case" - ], - "property_case_collision": "error", - "enum_case_convention": [ - "warning", - "lower_snake_case" - ], - "undefined_required_properties": "warning" - }, - "walker": { - "no_empty_descriptions": "error", - "has_circular_references": "warning", - "$ref_siblings": "off", - "duplicate_sibling_description": "warning", - "incorrect_ref_pattern": "warning" - } - }, - "swagger2": { - "operations": { - "no_consumes_for_put_or_post": "error", - "get_op_has_consumes": "warning", - "no_produces": "warning" - } - }, - "oas3": { - "operations": { - "no_request_body_name": "warning" - }, - "responses": { - "no_success_response_codes": "warning", - "protocol_switching_and_success_code": "error", - "no_response_body": "warning", - "ibm_status_code_guidelines": "warning" - }, - "schemas": { - "json_or_param_binary_string": "warning" - } - }, - "spectral": { - "rules": {} - } -} \ No newline at end of file