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

feat: validate x-sdk-operations extension #268

Merged
merged 2 commits into from
Apr 6, 2021
Merged

Conversation

barrett-schonefeld
Copy link
Contributor

@barrett-schonefeld barrett-schonefeld commented Mar 30, 2021

Purpose:

  • ensure the request examples provided using x-sdk-operations extension are good, so they may be utilized properly by tooling that uses x-sdk-operations

Changes:

  • add custom Spectral rule to validate x-sdk-operations
  • add custom Spectral function to invoke ajv JSON Schema validator on x-sdk-operations JSON Schema
  • add JSON Schema representation of x-sdk-operations

Tests:

  • ensure warnings issued for invalid x-sdk-operations schema

Docs:

  • document ibm-sdk-operations rule

Copy link
Member

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Left one comment on the README and we probably want to let Mike have a look at the schema before merging

docs/spectral-rules.md Show resolved Hide resolved
Changes:
- add custom Spectral rule to validate x-sdk-operations
- add custom Spectral function to invoke ajv JSON Schema validator on x-sdk-operations JSON Schema

Tests:
- ensure warnings issued for invalid x-sdk-operations schema

Docs:
- document `ibm-sdk-operations` rule
Copy link
Member

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Still looks good to me 👍

Copy link
Contributor

@mkistler mkistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@barrett-schonefeld barrett-schonefeld merged commit b025eac into main Apr 6, 2021
@barrett-schonefeld barrett-schonefeld deleted the x-sdk-operations branch April 6, 2021 13:00
dpopp07 pushed a commit that referenced this pull request Apr 6, 2021
# [0.40.0](v0.39.0...v0.40.0) (2021-04-06)

### Features

* validate x-sdk-operations extension ([#268](#268)) ([b025eac](b025eac))
@dpopp07
Copy link
Member

dpopp07 commented Apr 6, 2021

🎉 This PR is included in version 0.40.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants