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.

Sign up for GitHub

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

Jump to bottom

Add OpenAPI generation and swagger to update-codegen.sh #1297

Merged

tekton-robot merged 1 commit into tektoncd:main from abayer:add-openapi-gen

Jan 25, 2022

Contributor

abayer commented Jan 20, 2022

Changes

And fix #1271 along the way by using the same scripting as in tektoncd/pipeline#4402 to ignore API rule violations for name_match which already exist. Any new mismatch will cause an error.

/kind misc

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

Includes tests (if functionality changed/added)
Includes docs (if user facing)
Commit messages follow commit message best practices
Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

NONE

tekton-robot added release-note-none kind/misc size/XXL labels

tekton-robot requested review from dlorenc and khrm

January 20, 2022 20:27

Contributor Author

abayer commented Jan 20, 2022

/assign @dibyom

tekton-robot assigned dibyom

tekton-robot commented Jan 20, 2022

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/triggers/v1beta1/openapi_generated.go	Do not exist	0.0%

abayer force-pushed the add-openapi-gen branch from 7c75766 to 1b1921d Compare

January 20, 2022 20:36

Contributor Author

abayer commented Jan 20, 2022

Oh, and I'll follow this up with a PR like tektoncd/pipeline#4494 to add generated API reference docs.

tekton-robot commented Jan 20, 2022

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/triggers/v1beta1/openapi_generated.go	Do not exist	0.0%

abayer force-pushed the add-openapi-gen branch from 1b1921d to 90fbe16 Compare

January 20, 2022 20:50

tekton-robot commented Jan 20, 2022

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/triggers/v1beta1/openapi_generated.go	Do not exist	0.0%

abayer force-pushed the add-openapi-gen branch from 90fbe16 to e3e4dc9 Compare

January 21, 2022 15:23

tekton-robot commented Jan 21, 2022

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/triggers/v1beta1/openapi_generated.go	Do not exist	0.0%


          Add OpenAPI generation and swagger to update-codegen.sh

667c2e8

And fix tektoncd#1271 along the way by using the same scripting as in tektoncd/pipeline#4402 to ignore API rule violations for `name_match` which already exist. Any new mismatch will cause an error.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>

abayer force-pushed the add-openapi-gen branch from e3e4dc9 to 667c2e8 Compare

January 21, 2022 15:34

tekton-robot commented Jan 21, 2022

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/triggers/v1beta1/openapi_generated.go	Do not exist	0.0%

dibyom approved these changes

View reviewed changes

hack/spec-gen/main.go

+              	fmt.Println(string(jsonBytes))
+              }
+              func swaggify(name string) string {

Member

dibyom Jan 25, 2022

question: Why do we need to this?

Contributor Author

abayer Jan 25, 2022

I literally just copied this over from Pipelines - I assume it does something relating to swagger.json.

Member

dibyom Jan 25, 2022

ah ok. was curious as to why we need to have this custom function.

tekton-robot commented Jan 25, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dibyom]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tekton-robot added the approved label

Contributor Author

abayer commented Jan 25, 2022

fyi, once this merges, I'll have another PR that'll generate API reference docs like in tektoncd/pipeline#4494 (though for Pipelines we currently have to use a fork of https://github.com/ahmetb/gen-crd-api-reference-docs because of the pkg/apis/pipeline/pod package's unversioned weirdness - here we don't need that).

Member

dibyom commented Jan 25, 2022

/lgtm

tekton-robot added the lgtm label

tekton-robot merged commit c8ca0ed into tektoncd:main

abayer mentioned this pull request

Generate OpenAPI spec for Trigger CRDs #1265

Closed

4 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved kind/misc lgtm release-note-none size/XXL