kong icon indicating copy to clipboard operation
kong copied to clipboard

Cannot parse kong-admin-api.yml with standard Swagger UI tool

Open vm-001 opened this issue 3 years ago • 5 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Kong version ($ kong version)

3.0

Current Behavior

Cannot use Swagger UI tool to parse kong-admin-api.yml

Expected Behavior

kong-admin-api.yml should be able to be parsed by the Swagger UI tool.

Steps To Reproduce

1. Open https://editor.swagger.io and paste the content of https://github.com/Kong/kong/blob/master/kong-admin-api.yml

You can see a lot of errors come up.

Anything else?

No response

vm-001 avatar Sep 26 '22 06:09 vm-001

@vm-001 based on what I read in the swagger editor, and in the new swagger editor: SwaggerUI does not currently support rendering of OpenAPI 3.1 definitions, see also this issue which is linked on the editor. I don't see other errors other than that, am I missing something?

samugi avatar Sep 29 '22 10:09 samugi

Sorry for the delayed feedback.

I noticed that kong-admin-api.yml does not provide the detail for most of the APIs. May I know why? and when does Kong will plan to optimize that?

vm-001 avatar Nov 08 '22 08:11 vm-001

@vm-001 Could you create a PR for this?

raoxiaoyan avatar Aug 31 '23 02:08 raoxiaoyan

@vm-001 Any update on this one?

StarlightIbuki avatar Oct 11 '23 08:10 StarlightIbuki

@vm-001, could you give us any progress of it?

chronolaw avatar Jan 18 '24 01:01 chronolaw

This issue is marked as stale because it has been open for 14 days with no activity.

github-actions[bot] avatar Feb 05 '24 01:02 github-actions[bot]

Dear contributor,

We are automatically closing this issue because it has not seen any activity for three weeks. We're sorry that your issue could not be resolved. If any new information comes up that could help resolving it, please feel free to reopen it.

Your contribution is greatly appreciated!

Please have a look our pledge to the community for more information.

Sincerely, Your Kong Gateway team

github-actions[bot] avatar Feb 13 '24 01:02 github-actions[bot]