Skip to content
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

Tekton API Reference #1250

Closed
skaegi opened this issue Aug 28, 2019 · 19 comments
Closed

Tekton API Reference #1250

skaegi opened this issue Aug 28, 2019 · 19 comments
Assignees
@abayer
Labels
area/api Indicates an issue or PR that deals with the API. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@skaegi
Copy link
Contributor

skaegi commented Aug 28, 2019 •
edited
Loading

Currently a lot of our doc is examples that do not necessarily reflect all the dark corners of our API. It might be time to craft or generate open API for everything and add a reference API section to our doc.

Something like -- https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/
@duanshiqiang
Copy link

Yes, it would be very useful.

@vdemeester vdemeester added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 4, 2019
@vdemeester vdemeester added this to the Pipelines 1.0/beta 🐱 milestone Oct 4, 2019
@ghost ghost assigned vdemeester Jan 21, 2020
@vdemeester vdemeester added the kind/beta-blocking Categorizes issue or PR as related to the beta api label Feb 18, 2020
@vdemeester vdemeester mentioned this issue Feb 18, 2020
Closed
@bobcatfish
Copy link
Collaborator

Going to close this as a duplicate of #2055 which has an open PR against it currently and covers the same thing

@ghost
Copy link

ghost commented Jul 15, 2020

I'm going to reopen this one since #2055 ended up in a closed state. If I remember right, though I can't find the specific PR, we decided that a static description of the API wasn't enough and that we wanted to be able to regenerate the API documentation. This issue describes that requirement a bit more clearly than #2055 so I'm calling this one the source of truth. Happy to switch it around again if others prefer.

@ghost ghost reopened this Jul 15, 2020
@ghost ghost added area/api Indicates an issue or PR that deals with the API. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed kind/beta-blocking Categorizes issue or PR as related to the beta api labels Jul 15, 2020
@ghost
Copy link

ghost commented Jul 15, 2020

I've created a new milestone for 0.16 and tentatively put this in there to be discussed for inclusion.

@vdemeester vdemeester removed their assignment Jul 24, 2020
@afrittoli afrittoli added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels Aug 10, 2020
@dibyom
Copy link
Member

dibyom commented Aug 24, 2020

Ref: #3081 -- starts documenting our API using Open API

@tekton-robot tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 6, 2021
@vdemeester
Copy link
Member

/lifecycle frozen

@tekton-robot tekton-robot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label Jul 6, 2021
@KevinMGranger KevinMGranger mentioned this issue Jan 4, 2022
Closed
4 tasks
@abayer abayer self-assigned this Jan 18, 2022
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
a4bb323 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
@abayer abayer mentioned this issue Jan 18, 2022
Merged
5 tasks
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
8896ebd 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
dda844a 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
7272f70 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
20f994f 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 18, 2022
@abayer
Generate API reference docs for Pipeline
c7e43f4 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 19, 2022
@abayer
Generate API reference docs for Pipeline
467d60e 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 19, 2022
@abayer
Generate API reference docs for Pipeline
d6da049 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Jan 24, 2022
@abayer
Generate API reference docs for Pipeline
161fc7f 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Mar 21, 2022
@abayer
Generate API reference docs for Pipeline
36eb64f 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Mar 25, 2022
@abayer
Generate API reference docs for Pipeline
7c9742b 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Mar 29, 2022
@abayer
Generate API reference docs for Pipeline
b09e564 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Mar 31, 2022
@abayer
Generate API reference docs for Pipeline
c7de3c0 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43 for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
@abayer abayer mentioned this issue Apr 4, 2022
Closed
@prashant-juluri
Copy link

Currently a lot of our doc is examples that do not necessarily reflect all the dark corners of our API. It might be time to craft or generate open API for everything and add a reference API section to our doc.

Something like -- https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/

seems inaccessible. any equivalent link?

@mostafa-eltaher
Copy link

Currently a lot of our doc is examples that do not necessarily reflect all the dark corners of our API. It might be time to craft or generate open API for everything and add a reference API section to our doc.
Something like -- https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/

seems inaccessible. any equivalent link?

Perhaps https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/ which also points to the OpenAPI Specs at https://github.com/kubernetes/kubernetes/blob/release-1.23/api/openapi-spec/swagger.json

@AlanGreene AlanGreene mentioned this issue Apr 26, 2022
Closed
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Aug 1, 2022
@abayer
Generate API reference docs for Pipeline
69acedf 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43, forked to https://github.com/tektoncd/ahmetb-gen-crd-api-reference-docs, for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
abayer added a commit to abayer/tektoncd-pipeline that referenced this issue Aug 1, 2022
@abayer
Generate API reference docs for Pipeline
6d31e0f 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43, forked to https://github.com/tektoncd/ahmetb-gen-crd-api-reference-docs, for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
tekton-robot pushed a commit that referenced this issue Aug 1, 2022
@abayer @tekton-robot
Generate API reference docs for Pipeline
88fbc86 
This is the first part of addressing #1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43, forked to https://github.com/tektoncd/ahmetb-gen-crd-api-reference-docs, for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
JeromeJu pushed a commit to JeromeJu/pipeline that referenced this issue Aug 2, 2022
@abayer @JeromeJu
Generate API reference docs for Pipeline
e3848b2 
This is the first part of addressing tektoncd#1250 (and tektoncd/website#117).

Using https://github.com/ahmetb/gen-crd-api-reference-docs/, the tool Knative uses for this, plus my PR at ahmetb/gen-crd-api-reference-docs#43, forked to https://github.com/tektoncd/ahmetb-gen-crd-api-reference-docs, for an issue with `pkg/apis/pipeline/pod`, this adds generation of `docs/pipeline-api.md` to `hack/update-codegen.sh`.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
@abayer
Copy link
Contributor

abayer commented Aug 11, 2022

So #4494 is done - I'm not sure what needs to be done on the website side to have it pick up https://github.com/tektoncd/pipeline/blob/main/docs/pipeline-api.md and link to it?

@lbernick
Copy link
Member

I think this issue can be closed and the website changes can be tracked in tektoncd/website#363

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

@abayer abayer

Labels
area/api Indicates an issue or PR that deals with the API. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
Pipelines V1
Status: Done
Milestone
No milestone
Development

No branches or pull requests