Type aliases are flattened to the underlying type.

[jpeach]

Over in service-apis , I used https://github.com/ahmetb/gen-crd-api-reference-docs to generate the CRD API documentation. This project uses gengo to parse the Go types for the CRD, and generates HTML documentation.

In the service-apis CRD, we use type aliases like this:

type ConfigMapsDefaultLocalObjectReference struct {
...
}

type GatewayClassParametersObjectReference = ConfigMapsDefaultLocalObjectReference
type RouteHostExtensionObjectReference = ConfigMapsDefaultLocalObjectReference
type RouteActionExtensionObjectReference = ConfigMapsDefaultLocalObjectReference

The end result of this is that all the aliases get flattened to the underlying type ConfigMapsDefaultLocalObjectReference.

I'm not at all familiar with any of the machinery underlying this, but the only way I could see to detect the alias was using IsAlias on the type name before walking the type. Once you do this, it might be reasonable to emit the type alias as a type of Kind "Alias", but I'm not sure whether that's a good idea or not.

Here's a bit of a patch that I was messing with that is probably very naive about different type alias possibilities:

@@ -534,7 +535,22 @@ func (b *Builder) findTypesIn(pkgPath importPathString, u *types.Universe) error
                obj := s.Lookup(n)
                tn, ok := obj.(*tc.TypeName)
                if ok {
-                       t := b.walkType(*u, nil, tn.Type())
+                       var typeName *types.Name
+
+                       if tn.IsAlias() {
+                               log.Printf("found TypeName alias name=%q type.Name=%q pkg.Name=%q id=%q",
+                                       tn.Name(), tn.Type().String(), tn.Pkg().Path(), tn.Id())
+                               // typeName = tcNameToName(tn.Name())
+                               typeName = &types.Name{
+                                       Name: tn.Name(),
+                               }
+
+                               if tn.Pkg() != nil {
+                                       typeName.Package = tn.Pkg().Name()
+                               }
+                       }
+
+                       t := b.walkType(*u, typeName, tn.Type())
                        c1 := b.priorCommentLines(obj.Pos(), 1)
                        // c1.Text() is safe if c1 is nil
                        t.CommentLines = splitLines(c1.Text())

[lavalamp]

This will be tricky to fix since I'm pretty sure the main repo types rely on this, especially for primitives.

[jpeach]

This will be tricky to fix since I'm pretty sure the main repo types rely on this, especially for primitives.

Yup, I can imagine a lot of potential for nasty surprises if the semantics of the alias kind are changed.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[jpeach]

/remove-lifecycle stale

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.