Skip to content

Commit

Permalink
Merge pull request #65 from RReverser/ci-validation
Browse files Browse the repository at this point in the history
Add CI validation & fix issue
  • Loading branch information
Peter-Simpson authored Sep 22, 2024
2 parents d5ca144 + 8e9bcf4 commit 35d4761
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 2 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/validate-openapi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
on: [push]

jobs:
validate_openapi:
runs-on: ubuntu-latest
name: Validate OpenAPI definitions
steps:
- uses: actions/checkout@v4
- name: Install OpenAPI validator
run: npm install -g @redocly/cli
- name: Validate definitions
run: redocly lint Swagger/*.yaml
env:
NODE_NO_WARNINGS: 1
6 changes: 6 additions & 0 deletions .redocly.lint-ignore.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
# See https://redoc.ly/docs/cli/ for more information.
Swagger/AlpacaManagementAPI_v1.yaml:
# /setup endpoint must always be present
operation-4xx-response:
- '#/paths/~1setup/get/responses'
4 changes: 2 additions & 2 deletions Swagger/AlpacaDeviceAPI_v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ paths:
- Action
- Parameters
'/{device_type}/{device_number}/commandblind':
deprecated: true
put:
deprecated: true
summary: Transmits an arbitrary string to the device
description: >-
Transmits an arbitrary string to the device and does not wait for a
Expand Down Expand Up @@ -192,8 +192,8 @@ paths:
requestBody:
$ref: '#/components/requestBodies/put_devicetype_Devicenumber_commandblind'
'/{device_type}/{device_number}/commandstring':
deprecated: true
put:
deprecated: true
summary: >-
Transmits an arbitrary string to the device and returns a string value
from the device.
Expand Down
6 changes: 6 additions & 0 deletions redocly.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends:
- recommended
rules:
security-defined: off
operation-operationId: off
info-license: off

0 comments on commit 35d4761

Please sign in to comment.