Skip to content

Update Data Plane API spec server URL and variable #14

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

Merged
merged 2 commits into from
Aug 8, 2025

Conversation

kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Aug 8, 2025

Change server url values and variables to work with Bump API explorer proxy, per Bump's request:

We currently have a proxy in the API Explorer to resolve potential CORS issues (Details in our help center). As we don’t want it to become an open proxy, it only works with domains defined in the OpenAPI definition file. By keeping the whole server as a variable (url: '{dataplane_api_url}') in your Data Plane API definition file, our proxy can’t determine the allowed domain and will block the request.
Would it be possible to define the static part of the URL, and only have the specific part as a variable? For example url: "{dataplane_api_url}.redpanda.com" We will add an option to disable the proxy globally at some point (to support local servers, for instance) and let you handle your CORS settings on your end, but that would be the quickest way to have a fully functional API Explorer.

These changes will need to be backported to the source (console).

@kbatuigas kbatuigas requested a review from a team as a code owner August 8, 2025 16:46
Copy link

github-actions bot commented Aug 8, 2025

ℹ️ API content change detected:

No structural change, nothing to display.

Preview documentation

Powered by Bump.sh

Comment on lines +4984 to +4985
Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"<br>
Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com"

Choose a reason for hiding this comment

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

is this fixed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean will the URLs always follow this convention? I'm not sure, but this is in the source spec itself.

@kbatuigas kbatuigas merged commit a90de1b into main Aug 8, 2025
3 checks passed
@kbatuigas kbatuigas deleted the fix-dataplane-server-url branch August 8, 2025 18:43
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.

2 participants