Skip to content

Update links in README to use editor-next.swagger.io & update reference to CAMARA API Guideline #327

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
May 20, 2025

Conversation

maxl2287
Copy link
Contributor

@maxl2287 maxl2287 commented May 15, 2025

What type of PR is this?

Add one of the following kinds:

  • subproject management

What this PR does / why we need it:

Changes the usage of viewing Swagger-UI via editor-next.swagger.io

Fixes #325

@maxl2287 maxl2287 self-assigned this May 15, 2025
@maxl2287 maxl2287 requested review from bigludo7 and jlurien as code owners May 15, 2025 20:19
@maxl2287 maxl2287 added the subproject management Indicating issues with subproject repository or release management process label May 15, 2025
@maxl2287 maxl2287 changed the title Update links in README to use editor-next.swagger.io Update links in README to use editor-next.swagger.io & update reference to CAMARA API Guideline May 15, 2025
@jlurien jlurien merged commit 3f81ea5 into camaraproject:main May 20, 2025
2 checks passed
@hdamker
Copy link
Contributor

hdamker commented May 20, 2025

The PR is fine for me, but I have not the impression that using the next-editor from Swagger is a general solution.
a) the link isn't working as expected for me (not showing the YAML in the left panel when loading)
b) the next editor is an alpha version
c) a own hosted version of Swagger UI, maybe utilizing GitHub pages or on camaraproject.org might be the better solution

@maxl2287
Copy link
Contributor Author

The PR is fine for me, but I have not the impression that using the next-editor from Swagger is a general solution. a) the link isn't working as expected for me (not showing the YAML in the left panel when loading) b) the next editor is an alpha version c) a own hosted version of Swagger UI, maybe utilizing GitHub pages or on camaraproject.org might be the better solution

@hdamker on our side at DT, some of us faced the issue, that the "normal" editor.swagger.io was not working as expected anymore.
I tried with editor-next and there were no issues on my side

image

But I can also investigate or we can try to find a general solution in Commonalities.

@maxl2287 maxl2287 deleted the feature/update-links-to-swagger branch May 20, 2025 08:15
@hdamker
Copy link
Contributor

hdamker commented May 20, 2025

But I can also investigate or we can try to find a general solution in Commonalities.

I might fit better into Tooling, have created camaraproject/tooling#8 as a start. And yes, the problem was observed by others as well.

With the now merged links it looks for me like this - left panel is not loading the code:
image

@maxl2287
Copy link
Contributor Author

But I can also investigate or we can try to find a general solution in Commonalities.

I might fit better into Tooling, have created camaraproject/tooling#8 as a start. And yes, the problem was observed by others as well.

With the now merged links it looks for me like this - left panel is not loading the code: image

Oh ... okay.
That's weird. I'll investigate.

@maxl2287
Copy link
Contributor Author

@hdamker maybe this is an issue on swagger editor, why I changed it to editor-next.
I faced exactly this issue here:

swagger-api/swagger-editor#5484

That's why I changed it to editor-next.
But at the time when I faced this issue, I did not saw someone complaining on their github-issues site.

@hdamker
Copy link
Contributor

hdamker commented May 20, 2025

@hdamker maybe this is an issue on swagger editor, why I changed it to editor-next. I faced exactly this issue here:

swagger-api/swagger-editor#5484

That's why I changed it to editor-next. But at the time when I faced this issue, I did not saw someone complaining on their github-issues site.

It was mentioned in some meetings and e.g. here: https://camara-project.slack.com/archives/C05SH6QDWP7/p1745834520529549. I hoped that is a temporary problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
subproject management Indicating issues with subproject repository or release management process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Links in .github/ISSUE_TEMPLATE/config.yml need to be updated
4 participants