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: update permalink schema #24970

Merged
merged 2 commits into from
Aug 16, 2023

Conversation

eschutho
Copy link
Member

SUMMARY

Small fix for #24586 to update the schema to point to the new one. The PostSchema no longer exists, so it was failing a test in the 2.1.1 release.

TESTING INSTRUCTIONS

The test in master isn't failing with the Post schema, likely because of some regression with openapi-spec-validator==0.5.6 that @villebro is looking into

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@michael-s-molina
Copy link
Member

@eschutho Should we also update docs/static/resources/openapi.json?

"ExplorePermalinkPostSchema": {
  "properties": {
    "formData": {
      "description": "Chart form data",
      "type": "object"
    },
    "urlParams": {
      "description": "URL Parameters",
      "items": {
        "description": "URL Parameter key-value pair",
        "nullable": true
      },
      "nullable": true,
      "type": "array"
    }
  },
  "required": ["formData"],
  "type": "object"
},

@michael-s-molina michael-s-molina added the v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch label Aug 14, 2023
@eschutho
Copy link
Member Author

eschutho commented Aug 15, 2023

@eschutho Should we also update docs/static/resources/openapi.json?

Yeah, good catch. Not sure if removing it is the right way to go, so lmk what you think. 🙏

@@ -5454,25 +5454,6 @@
},
"type": "object"
},
"ExplorePermalinkPostSchema": {
Copy link
Contributor

@zephyring zephyring Aug 16, 2023

Choose a reason for hiding this comment

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

should you just rename this to ExplorePermalinkStateSchema?
maybe just use https://github.com/preset-io/superset/blob/master/superset/cli/update.py#L71 to update?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice, it looks like the cli command hasn't been run in a while. I've committed the output, if we think it's worth cleaning the whole file up in the process.

@eschutho eschutho force-pushed the elizabeth/update-permalink-schema branch from 400e63f to 5b41c3e Compare August 16, 2023 00:18
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this @eschutho - I've indeed been looking into why our current OAS test isn't picking up this error, and it appears that regression is still there in the latest version of the validator library. I'll keep an eye out for a potential fix, and if one doesn't show up soon, I'll try to make a simple repro case and share it with the library devs.

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you @eschutho!

@eschutho
Copy link
Member Author

Thanks all!

@eschutho eschutho merged commit bc1c5c2 into apache:master Aug 16, 2023
31 checks passed
@eschutho eschutho deleted the elizabeth/update-permalink-schema branch August 16, 2023 16:56
michael-s-molina pushed a commit that referenced this pull request Aug 17, 2023
eschutho added a commit that referenced this pull request Aug 17, 2023
eschutho added a commit that referenced this pull request Aug 18, 2023
@mistercrunch mistercrunch added 🍒 3.0.3 🍒 3.0.4 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.1.0 labels Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.1 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XXL v2.1 v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch 🍒 2.1.1 🍒 2.1.2 🍒 2.1.3 🍒 3.0.0 🍒 3.0.1 🍒 3.0.2 🍒 3.0.3 🍒 3.0.4 🚢 3.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants