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.

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

Add Restful API document #2055

Closed
anxinyf opened this issue Feb 15, 2020 · 9 comments
Closed

Add Restful API document #2055

anxinyf opened this issue Feb 15, 2020 · 9 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@anxinyf
Copy link

anxinyf commented Feb 15, 2020

Expected Behavior

Document to describe restful api.

Actual Behavior

In docs, there's no rest api document.

Additional Info

I have written the rest api document for Triggers, Dashboard and Pipeline. If need, I will commit these in docs folder.

@vdemeester
Copy link
Member

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 17, 2020
This was referenced Feb 17, 2020
@vdemeester
Copy link
Member

Duplicates #1250

@vdemeester vdemeester added the kind/beta-blocking Categorizes issue or PR as related to the beta api label Feb 18, 2020
@anxinyf
Copy link
Author

anxinyf commented Feb 18, 2020

That will be great to generate doc, like swagger or other tools.

@bobcatfish
Copy link
Collaborator

Note I think this is a duplicate of #1250

@anxinyf
Copy link
Author

anxinyf commented Feb 18, 2020

Yes! I didn't know this issue #1250 before. But These api docs(Pipeline/Dashboard/Triggers) are wrriten manually, maybe some tools are better, like swagger.

@anneqm
Copy link

anneqm commented Mar 4, 2020

Per @anxinyf this item can be closed.

@ghost ghost closed this as completed Mar 4, 2020
@aeweidne
Copy link

Where is the non-go API documentation available? I'd like to validate my Tekton resources with kubeval. It isn't clear how this issue was resolved

@afrittoli
Copy link
Member

It looks like #1250 and #2055 were both closed as duplicate of each other. I think one of the two should stay open? @sbwsg @bobcatfish

@ghost ghost reopened this Jul 15, 2020
@ghost ghost removed the kind/beta-blocking Categorizes issue or PR as related to the beta api label Jul 15, 2020
@ghost
Copy link

ghost commented Jul 15, 2020

Sorry for the churn but I'm actually going to make #1250 the source of truth here. The description of that issue aligns more closely with what we want for the project I think - generated documentation from the existing API definition.

@ghost ghost closed this as completed Jul 15, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

7 participants