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

Latest docs.podman.io Reference page has a circular dependency. #22351

Closed
TomSweeneyRedHat opened this issue Apr 11, 2024 · 1 comment · Fixed by #22357
Closed

Latest docs.podman.io Reference page has a circular dependency. #22351

TomSweeneyRedHat opened this issue Apr 11, 2024 · 1 comment · Fixed by #22357
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.

Comments

@TomSweeneyRedHat
Copy link
Member

Issue Description

When going to this URL https://docs.podman.io/en/latest/_static/api.html, you receive:

Something went wrong...
Self-referencing circular pointer

Stack trace
ReDoc Version: 2.0.0-rc.75
Commit: d7440fb

This can also happen if you go to docs.podman.io->reference->latest

This appears to be an issue only with latest, the other links on that page pointing to particular versions are working fine.

@baude any thoughts?

Steps to reproduce the issue

Steps to reproduce the issue

  1. See description

Describe the results you received

Error page

Describe the results you expected

API documentation page

podman info output

N/A

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

Yes

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

@TomSweeneyRedHat TomSweeneyRedHat added the kind/bug Categorizes issue or PR as related to a bug. label Apr 11, 2024
@Luap99 Luap99 self-assigned this Apr 12, 2024
@Luap99
Copy link
Member

Luap99 commented Apr 12, 2024

#22357

Luap99 added a commit to Luap99/libpod that referenced this issue Apr 12, 2024
Commit 668d517 moved a lot of type definitions and by that also
copied a bucnh of swagger:model comments, this caused swagger to create
a incorrect yaml that can no longer be parsed by redoc due
"Self-referencing circular pointer".

The yaml basically defined the type with a name and the pointed to the
same name definition again so it caused a infinitive recursion where
redoc just throws an error but the swagger style ignored the case so it
seemed like it worked but obviously the type information was not
working.

Fixes containers#22351

Signed-off-by: Paul Holzinger <[email protected]>
Luap99 added a commit to Luap99/libpod that referenced this issue Apr 16, 2024
Commit 668d517 moved a lot of type definitions and by that also
copied a bucnh of swagger:model comments, this caused swagger to create
a incorrect yaml that can no longer be parsed by redoc due
"Self-referencing circular pointer".

The yaml basically defined the type with a name and the pointed to the
same name definition again so it caused a infinitive recursion where
redoc just throws an error but the swagger style ignored the case so it
seemed like it worked but obviously the type information was not
working.

Fixes containers#22351

Signed-off-by: Paul Holzinger <[email protected]>
@stale-locking-app stale-locking-app bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Jul 15, 2024
@stale-locking-app stale-locking-app bot locked as resolved and limited conversation to collaborators Jul 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants