This release adds an openapi:convert
command, documentation on our new 1Password shell plugin, and more. See below for the highlights:
- #715 adds the ability to pass in a GitHub blob link to an API definition into the
openapi
family of commands, and it will automatically be converted to a raw URL prior to fetching the file. See below for an example:
rdme openapi https://github.com/readmeio/oas-examples/blob/main/3.0/json/petstore.json
- #717 adds a new command called
openapi:convert
for converting Swagger 2.0 definitions and Postman Collections into OpenAPI. - #718 adds a new flag to the
openapi
andopenapi:reduce
commands calledtitle
, which overrides theinfo.title
field in your OpenAPI definition (which is used for setting the category title in ReadMe). - #720 adds documentation for our new 1Password shell plugin, which allows you to store your ReadMe API key in 1Password and securely pass it in your
rdme
commands using biometrics (supported in[email protected]
and above). See below for a demo of this behavior:
readme-1p.mp4
What's Changed
- fix: login issue when user doesn't pass in API key by @kanadgupta in #714
- chore: bump deps by @kanadgupta in #715
- feat(openapi): exposing our spec conversion tooling to a new
:convert
command by @erunion in #717 - feat(openapi): add ability to override title by @kanadgupta in #718
- docs: 1password shell plugin by @kanadgupta in #720
- feat(api): surface
Warning
response headers by @kanadgupta in #721
Full Changelog: v8.3.1...8.4.0