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

Fix key capability post, patch, response #18

Merged
merged 2 commits into from
Aug 27, 2021
Merged

Conversation

tbedford
Copy link
Contributor

Description

When testing key creation it was noticed there was an error. This was due to an incorrect OAS3 spec being imported to Postman - the capablity arrangement for keys had been changed at some point and this was not reflected in this spec. This PR fixes the capability in the key_response, and also the request body sections for both key_post and key_patch.

Checklist for OpenAPI document updates

Please ensure the following:

  • Version has been incremented
  • Tested for errors with Spectral
  • Optional: Load into SwaggerHub and check for errors
  • Ensure the document renders under ReDoc (see README for instructions on how to test locally)

Review

  • For this PR the best way is to check the diff.
  • Also check that the key section of the docs renders correctly locally.

@tbedford tbedford self-assigned this Aug 27, 2021
@tbedford tbedford added the bug Something isn't working label Aug 27, 2021
@tbedford tbedford requested a review from m-hulbert August 27, 2021 14:07
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

Tested locally and renders correctly. Just 2 minor comments/suggestions.

definitions/control-v1.yaml Outdated Show resolved Hide resolved
definitions/control-v1.yaml Show resolved Hide resolved
definitions/control-v1.yaml Show resolved Hide resolved
definitions/control-v1.yaml Show resolved Hide resolved
@tbedford tbedford requested a review from m-hulbert August 27, 2021 15:42
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

Re-tested and LGTM

@tbedford
Copy link
Contributor Author

We'll circle back and take another look at the default property name issue.

Redocly/redoc#622

There's a vendor-specific override that may help.

@tbedford tbedford merged commit 945c1f5 into main Aug 27, 2021
@tbedford tbedford deleted the doc-481-fix-key-post-patch branch August 27, 2021 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Development

Successfully merging this pull request may close these issues.

2 participants