[pkgsite] internal/api: extract comments as descriptions for OpenAPI schemas

0 views

Skip to first unread message

Hyang-Ah Hana Kim (Gerrit)

unread,

1:51 PM (4 hours ago) 1:51 PM

to Hyang-Ah Hana Kim, goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, Ethan Lee, Jonathan Amsterdam, kokoro, golang...@luci-project-accounts.iam.gserviceaccount.com, golang-co...@googlegroups.com

Hyang-Ah Hana Kim submitted the change

Change information

Commit message:

internal/api: extract comments as descriptions for OpenAPI schemas

Update generateSchemas in openapi_test.go to extract field doc
or comment and use it as the description in the generated OpenAPI schema.
Also update openapi.yaml with the regenerated spec.

Change-Id: Ic3c64701315fcc18bfdcf86bdd978253a905e653

Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/776420

LUCI-TryBot-Result: golang...@luci-project-accounts.iam.gserviceaccount.com <golang...@luci-project-accounts.iam.gserviceaccount.com>

kokoro-CI: kokoro <noreply...@google.com>

Reviewed-by: Jonathan Amsterdam <j...@google.com>

Reviewed-by: Ethan Lee <etha...@google.com>

Files:

M cmd/internal/pkgsite-cli/client/types_gen.go
M internal/api/openapi.yaml
M internal/api/openapi_test.go
M internal/api/types.go

Change size: S

Delta: 4 files changed, 22 insertions(+), 8 deletions(-)

Branch: refs/heads/master

Submit Requirements:

Code-Review: +2 by Ethan Lee, +2 by Jonathan Amsterdam
TryBots-Pass: LUCI-TryBot-Result+1 by golang...@luci-project-accounts.iam.gserviceaccount.com
kokoro-CI-Passes: kokoro-CI+1 by kokoro

Open in Gerrit

Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings.

Gerrit

open

diffy

satisfied_requirement

Reply all

Reply to author

Forward

0 new messages