containers
/
automation-tests
mirror of https://github.com/containers/automation-tests.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

swagger fix infinitive recursion on some types 

Commit 668d517af9 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 #22351

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
This commit is contained in:
Paul Holzinger 2024-04-12 14:10:27 +02:00
parent 5e9725983d
commit e8055904e1
No known key found for this signature in database
GPG Key ID: EB145DD938A3CAF2
6 changed files with 1 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pkg/domain/entities/images.go
View File

@ -51,7 +51,6 @@ func (i *Image) Id() string { //nolint:revive,stylecheck
return i.ID return i.ID
} }
// swagger:model LibpodImageSummary
type ImageSummary = entitiesTypes.ImageSummary type ImageSummary = entitiesTypes.ImageSummary
// ImageRemoveOptions can be used to alter image removal. // ImageRemoveOptions can be used to alter image removal.

6
pkg/domain/entities/manifest.go
View File

@ -117,8 +117,6 @@ type ManifestModifyOptions struct {
} }
// ManifestPushReport provides the model for the pushed manifest // ManifestPushReport provides the model for the pushed manifest
//
// swagger:model
type ManifestPushReport = entitiesTypes.ManifestPushReport type ManifestPushReport = entitiesTypes.ManifestPushReport
// ManifestRemoveOptions provides the model for removing digests from a manifest // ManifestRemoveOptions provides the model for removing digests from a manifest
@ -128,11 +126,7 @@ type ManifestRemoveOptions struct {
} }
// ManifestRemoveReport provides the model for the removed manifest // ManifestRemoveReport provides the model for the removed manifest
//
// swagger:model
type ManifestRemoveReport = entitiesTypes.ManifestRemoveReport type ManifestRemoveReport = entitiesTypes.ManifestRemoveReport
// ManifestModifyReport provides the model for removed digests and changed manifest // ManifestModifyReport provides the model for removed digests and changed manifest
//
// swagger:model
type ManifestModifyReport = entitiesTypes.ManifestModifyReport type ManifestModifyReport = entitiesTypes.ManifestModifyReport

1
pkg/domain/entities/network.go
View File

@ -75,7 +75,6 @@ type NetworkConnectOptions = entitiesTypes.NetworkConnectOptions
// NetworkPruneReport containers the name of network and an error // NetworkPruneReport containers the name of network and an error
// associated in its pruning (removal) // associated in its pruning (removal)
// swagger:model NetworkPruneReport
type NetworkPruneReport = entitiesTypes.NetworkPruneReport type NetworkPruneReport = entitiesTypes.NetworkPruneReport
// NetworkPruneOptions describes options for pruning unused networks // NetworkPruneOptions describes options for pruning unused networks

1
pkg/domain/entities/system.go
View File

@ -19,7 +19,6 @@ type SystemUnshareOptions = types.SystemUnshareOptions
type ComponentVersion = types.SystemComponentVersion type ComponentVersion = types.SystemComponentVersion
type ListRegistriesReport = types.ListRegistriesReport type ListRegistriesReport = types.ListRegistriesReport
// swagger:model AuthConfig
type AuthConfig = types.AuthConfig type AuthConfig = types.AuthConfig
type AuthReport = types.AuthReport type AuthReport = types.AuthReport
type LocksReport = types.LocksReport type LocksReport = types.LocksReport

1
pkg/domain/entities/types/auth.go
View File

@ -2,6 +2,7 @@
package types package types
// AuthConfig contains authorization information for connecting to a Registry // AuthConfig contains authorization information for connecting to a Registry
// swagger:model
type AuthConfig struct { type AuthConfig struct {
Username string `json:"username,omitempty"` Username string `json:"username,omitempty"`
Password string `json:"password,omitempty"` Password string `json:"password,omitempty"`

1
pkg/domain/entities/volumes.go
View File

@ -7,7 +7,6 @@ import (
) )
// VolumeCreateOptions provides details for creating volumes // VolumeCreateOptions provides details for creating volumes
// swagger:model
type VolumeCreateOptions = types.VolumeCreateOptions type VolumeCreateOptions = types.VolumeCreateOptions
type VolumeConfigResponse = types.VolumeConfigResponse type VolumeConfigResponse = types.VolumeConfigResponse