Skip to content
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.

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

chore: add validation for the OpenAPI specs to GitHub Actions #726

Merged
merged 3 commits into from
Nov 4, 2022

Conversation

JoblersTune
Copy link
Collaborator

@JoblersTune JoblersTune commented Nov 4, 2022

Changes proposed in this pull request

  • add validation for the OpenAPI specs to GitHub Actions

Context

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Documentation added
  • Make sure that all checks pass

@github-actions github-actions bot added the type: ci Changes to the CI label Nov 4, 2022
@JoblersTune JoblersTune force-pushed the sj-openapi-spec-validation branch from 65bf293 to 70cc388 Compare November 4, 2022 10:53
@JoblersTune JoblersTune force-pushed the sj-openapi-spec-validation branch from 70cc388 to ecae287 Compare November 4, 2022 10:57
@github-actions github-actions bot added the pkg: auth Changes in the GNAP auth package. label Nov 4, 2022
@JoblersTune
Copy link
Collaborator Author

@adrianhopebailie should the linting check apply to both the id-provider.yaml file as well as the resource-server.yaml?

@JoblersTune JoblersTune marked this pull request as ready for review November 4, 2022 12:38
@JoblersTune JoblersTune force-pushed the sj-openapi-spec-validation branch from e4b42b2 to c2f0bc8 Compare November 4, 2022 13:11
@JoblersTune JoblersTune self-assigned this Nov 4, 2022
echo "{\"extends\":[\"spectral:oas\",\"spectral:asyncapi\"]}" >> .spectral.json
- name: Validate Open API specs
run: |
npx @stoplight/spectral-cli lint ./packages/auth/openapi/*-server.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the linting check apply to both the id-provider.yaml file as well as the resource-server.yaml?

yes

@@ -99,7 +99,7 @@ paths:
type: object
properties:
access:
$ref: ./schemas.yaml#/access
$ref: ./schemas.yaml#/components/schemas/access
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heads up, this is overlapping with:

@JoblersTune JoblersTune force-pushed the sj-openapi-spec-validation branch from e30ec49 to c29ba18 Compare November 4, 2022 16:40
@JoblersTune JoblersTune merged commit 0259918 into main Nov 4, 2022
@JoblersTune JoblersTune deleted the sj-openapi-spec-validation branch November 4, 2022 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: auth Changes in the GNAP auth package. type: ci Changes to the CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OpenAPI spec validation
2 participants