Skip to content

chore: add OpenAPI spec validator based on redocly cli #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beeme1mr merged 1 commit into from
May 13, 2024
Merged

chore: add OpenAPI spec validator based on redocly cli #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/spec-validate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: OpenAPI spec validation action

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Run OpenAPI spec validation
run: |
docker run --rm -v $PWD:/spec redocly/cli lint ./service/openapi.yaml
echo "{exit_code}={$?}" >> $GITHUB_STATE
4 changes: 4 additions & 0 deletions service/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
openapi: 3.1.0
servers:
- url: /
info:
version: 0.1.0
title: OpenFeature Remote Evaluation Protocol (OFREP)
Expand Down Expand Up @@ -49,6 +51,7 @@ paths:
$ref: '#/components/schemas/generalErrorResponse'
/ofrep/v1/evaluate/flags/{key}:
post:
summary: OFREP single flag evaluation contract
description: OFREP single flag evaluation request
parameters:
- name: key
Expand Down Expand Up @@ -102,6 +105,7 @@ paths:
$ref: '#/components/schemas/generalErrorResponse'
/ofrep/v1/evaluate/flags:
post:
summary: OFREP bulk flag evaluation contract
description: OFREP bulk evaluation request
parameters:
- in: header
Expand Down