Skip to content

docs: re-enable generated swagger documentation #87653

Description

@rickystewart

#86049 disabled generating swagger docs. At the time the PR was put together, go-swagger still had issues dealing with Go 1.19. go-swagger/go-swagger#2808 was merged upstream which means we should no longer have these problems.

Someone friendly did a little analysis of why swagger generation continues to fail:

I looked at the errors in the swagger generation. A lot of them have to do with liberal whitespace usage.

Upgrade go-swagger to the latest version and fix our swagger comments so we can generate code. Then, fix the following files:

build/bazelutil/check.sh
docs/generated/bazel_targets.txt
docs/generated/swagger/BUILD.bazel
Makefile
[go:generate comment in pkg/server/api_v2.go]

Epic CRDB-17171
Jira issue: CRDB-19460

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-build-systemA-docsC-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.T-dev-inf

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions