refactor: move off @apidevtools/openapi-schema
#259
Conversation
|
Not that I want us to have to fork and maintain more open source repos but it might be cleaner for us to fork |
|
opting to fork the repo. closing this out! |
|
this spec (link to OAS) is failing off this specific jsonschema validation block. everything seems valid though? |
|
tagged you guys @Dashron and @julshotal since Jon and Kanad are OOO for the week! |
| "@apidevtools/swagger-methods": "^3.0.2", | ||
| "@jsdevtools/ono": "^7.1.3", | ||
| "@readme/better-ajv-errors": "^1.6.0", | ||
| "@readme/json-schema-ref-parser": "^1.2.0", | ||
| "@readme/openapi-schemas": "^3.0.1", |
There was a problem hiding this comment.
if the newest version of @readme/openapi-schemas is 3.1.0, does the dependency version also need to be updated?
|
@erunion, some of these tests take a while to run since there are some pretty large OAS files so they're timing out. is this something we need to change via edit: one of the tests takes intentionally long (~8.5s) so I put the test timeout to 9s. tested it and none of the tests timeout anymore. let me know if that's the best way to do it! |
| [![PR App][icn]][pr] | 🚥 Resolves RM-9343 | | :------------------: | :------------------: | ## 🧰 Changes This bumps `@readme/openapi-parser` to include these changes: - readmeio/openapi-parser#259 - readmeio/openapi-parser#264 These fix an issue where the existence of the `description` property under `server.variables` would fail validation. ## 💁 Customer Impact Customers should be able to upload valid OAS 3.1 files again without error'ing. ## 🧬 QA & Testing The following OAS file should not hit any validation errors: <details> <summary>OAS 3.1 file</summary> ```json { "openapi": "3.1.0", "info": { "version": "1.0", "title": "Invalid API" }, "servers": [ { "url": "https://{subdomain}.io", "variables": { "subdomain": { "default": "petstore", "description": "Subdomain description" } } } ], "paths": { "/anything": { "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User-Information" } } } } } } } } }, "components": { "schemas": { "User-Information": { "type": "object", "properties": { "first": { "type": "boolean" }, "last": { "type": "boolean" } } } } } } ``` </details> - [Broken on next][next]. - [Working in this PR][pr]! [next]: https://next.readme.ninja [pr]: https://readme-pr-PR_NUMBER.readme.ninja [ui]: https://readme-pr-PR_NUMBER.readme.ninja/ui [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg <!-- Uncomment and unescape this if you don't want a PR app! --> <!-- \[skip preview\] -->
🧰 Changes
The schemas we were validating against hasn't been updated in ages and there's a bug with a specific version where it's validating against
descriptionsinstead ofdescription. This makes it so that adding a validdescriptionis considered invalid.This is being changed to use our fork of
@apidevtools/openapi-schema.🧬 QA & Testing
Provide as much information as you can on how to test what you've done.