Skip to content
This repository was archived by the owner on Feb 7, 2025. It is now read-only.

Conversation

darrenyong
Copy link

🚥 Resolves ISSUE_ID

🧰 Changes

Bumps the dependency version of @readme/openapi-schemas.

🧬 QA & Testing

Provide as much information as you can on how to test what you've done.

@darrenyong darrenyong merged commit a7261fb into main May 28, 2024
@darrenyong darrenyong deleted the darren/bump-openapi-schemas-dependency branch May 28, 2024 18:33
darrenyong added a commit to readmeio/rdme that referenced this pull request May 28, 2024
| [![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\] -->
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants