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

chore(deps): update @readme/openapi-parser #1004

Merged
merged 2 commits into from
May 28, 2024

Conversation

darrenyong
Copy link
Contributor

PR App 🚥 Resolves RM-9343

🧰 Changes

This bumps @readme/openapi-parser to include these changes:

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:

OAS 3.1 file
{
  "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"
          }
        }
      }
    }
  }
}

Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

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

i forget how to publish releases for rdme but kanad can prob do that tomorrow

@darrenyong darrenyong merged commit abb8c41 into next May 28, 2024
9 checks passed
@darrenyong darrenyong deleted the darren/rm-9343-server-variable-description-property branch May 28, 2024 21:06
@kanadgupta
Copy link
Member

@darrenyong this was released in v9.0.0-next.17!

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

Successfully merging this pull request may close these issues.

3 participants