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

Documentation not Rendering with multi-OpenApi files #1067

Closed
Apoorva64 opened this issue Feb 6, 2024 · 3 comments
Closed

Documentation not Rendering with multi-OpenApi files #1067

Apoorva64 opened this issue Feb 6, 2024 · 3 comments
Assignees
Milestone

Comments

@Apoorva64
Copy link
Contributor

Apoorva64 commented Feb 6, 2024

Describe the bug

When loading a multi-file OpenApi file the documentation does not render properly

Expected behavior

Renders the documentation correctly

Actual behavior

Does not render the documentation correctly

How to Reproduce?

  1. import https://gitlab.com/api/v4/projects/53591717/repository/files/complex-example-2%2Fopenapi.yaml/raw?head=main
  2. go to the documentation the exemples will be missing

Microcks version or git rev

1.8.1

Install method (docker-compose, helm chart, operator, docker-desktop extension,...)

docker-compose

Additional information

No response

@Apoorva64
Copy link
Contributor Author

Apoorva64 commented Feb 6, 2024

@lbroudoux the problem comes from using illegal characters(urls) in the names of the ressources.

I have created a simpler exemple of (https://gitlab.com/api/v4/projects/53591717/repository/files/complex-example-2%2Fopenapi.yaml/raw?head=main) without any illegal characters such as "{}@" here(https://gitlab.com/api/v4/projects/53591717/repository/files/complex-example-3%2Fopenapi.yaml/raw?head=main) and it works.

@Apoorva64
Copy link
Contributor Author

Apoorva64 commented Feb 6, 2024

Fix Implementation Idea:
Review the generation of ressources names.

  • The safest way would be to base64 the whole name but this would be not very user readable.
  • Another solution would be to replace the illegal character by a legal character but this technique would bring in collision problems.

@lbroudoux
Copy link
Member

Now merged. We can close this one.

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

No branches or pull requests

2 participants