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

API docs wrong for BuildConfig instantiate #8345

Closed
jimmidyson opened this issue Apr 4, 2016 · 7 comments · Fixed by #16157
Closed

API docs wrong for BuildConfig instantiate #8345

jimmidyson opened this issue Apr 4, 2016 · 7 comments · Fixed by #16157
Assignees
@jim-minter
Labels
area/documentation component/build priority/P2

Comments

@jimmidyson
Copy link
Contributor

Docs at https://docs.openshift.org/latest/rest_api/openshift_v1.html#create-instantiate-of-a-buildrequest say the response is a v1.BuildRequest, whereas it really is a v1.Build.
@bparees
Copy link
Contributor

bparees commented Apr 4, 2016

@smarterclayton how do we fix the generated swagger doc? not clear to me how it's determining the return type.

this doc is also wrong:
https://docs.openshift.org/latest/rest_api/openshift_v1.html#create-a-template

guessing that swagger just assumes POST operations are creates that return the type you posted.

@smarterclayton
Copy link
Contributor

We'd have to fix api registration in Kube and have additional info defined
on the Storage classes (of which there are a few examples).

On Mon, Apr 4, 2016 at 12:48 PM, Ben Parees [email protected]
wrote:

@smarterclayton https://github.com/smarterclayton how do we fix the
generated swagger doc? not clear to me how it's determining the return type.

this doc is also wrong:

https://docs.openshift.org/latest/rest_api/openshift_v1.html#create-a-template

guessing that swagger just assumes POST operations are creates that return
the type you posted.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#8345 (comment)

@bparees
Copy link
Contributor

bparees commented Apr 4, 2016

@smarterclayton is there an upstream issue for this?

@smarterclayton
Copy link
Contributor

Not today

On Mon, Apr 4, 2016 at 4:09 PM, Ben Parees [email protected] wrote:

@smarterclayton https://github.com/smarterclayton is there an upstream
issue for this?

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#8345 (comment)

@php-coder
Copy link
Contributor

Any news on that?

I've just found it because https://docs.openshift.org/latest/rest_api/kubernetes_v1.html is talking about SCC (but it shouldn't) while https://docs.openshift.org/latest/rest_api/openshift_v1.html misses SCC stuff.

@bparees
Copy link
Contributor

bparees commented Sep 5, 2017

@jim-minter in your recent exploration of the api doc did you turn up anything that has changed on this?

@jim-minter jim-minter assigned jim-minter and unassigned bparees Sep 5, 2017
@jim-minter
Copy link
Contributor

@bparees https://github.com/openshift/origin/blob/master/vendor/k8s.io/kubernetes/staging/src/k8s.io/apiserver/pkg/registry/rest/rest.go#L310-L320 almost does the trick; will work on it.

This was referenced Sep 5, 2017
Closed
Merged
Merged
k8s-github-robot pushed a commit to kubernetes/kubernetes that referenced this issue Sep 25, 2017
Merge pull request #51972 from jim-minter/producedObject
50fa563 
Automatic merge from submit-queue (batch tested with PRs 51067, 52319, 52803, 52961, 51972). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>..

ProducesObject should only update the returned API object resource documentation

This should be a no-op for Kubernetes (the only rest.Storage that specifies ProducesObject() is pod logs, on GET), but will allow issues such as openshift/origin#8345 to be resolved (where generated API documentation is currently incorrect due to the asymmetry between the object kind sent and received by the API)

```release-note NONE```
openshift-merge-robot added a commit that referenced this issue Sep 26, 2017
@openshift-merge-robot
Merge pull request #16157 from jim-minter/instantiate_doc
bd2c9a2 
Automatic merge from submit-queue (batch tested with PRs 16546, 16398, 16157)

api docs should show right return value for build instantiate{binary,}

fixes #8345
dependent on kubernetes/kubernetes#51972 merging
sttts pushed a commit to sttts/apiserver that referenced this issue Sep 26, 2017
@k8s-publish-robot
Merge pull request #51972 from jim-minter/producedObject
567741e 
Automatic merge from submit-queue (batch tested with PRs 51067, 52319, 52803, 52961, 51972). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>..

ProducesObject should only update the returned API object resource documentation

This should be a no-op for Kubernetes (the only rest.Storage that specifies ProducesObject() is pod logs, on GET), but will allow issues such as openshift/origin#8345 to be resolved (where generated API documentation is currently incorrect due to the asymmetry between the object kind sent and received by the API)

```release-note NONE```

Kubernetes-commit: 50fa5637b6dc9538c908fbdd632ff1d3c59f65da
sttts pushed a commit to sttts/apiserver that referenced this issue Oct 13, 2017
@k8s-publish-robot
Merge pull request #51972 from jim-minter/producedObject
d3719c5 
Automatic merge from submit-queue (batch tested with PRs 51067, 52319, 52803, 52961, 51972). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>..

ProducesObject should only update the returned API object resource documentation

This should be a no-op for Kubernetes (the only rest.Storage that specifies ProducesObject() is pod logs, on GET), but will allow issues such as openshift/origin#8345 to be resolved (where generated API documentation is currently incorrect due to the asymmetry between the object kind sent and received by the API)

```release-note NONE```

Kubernetes-commit: 50fa5637b6dc9538c908fbdd632ff1d3c59f65da
sttts pushed a commit to sttts/apiserver that referenced this issue Oct 14, 2017
@k8s-publish-robot
Merge pull request #51972 from jim-minter/producedObject
579b27d 
Automatic merge from submit-queue (batch tested with PRs 51067, 52319, 52803, 52961, 51972). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>..

ProducesObject should only update the returned API object resource documentation

This should be a no-op for Kubernetes (the only rest.Storage that specifies ProducesObject() is pod logs, on GET), but will allow issues such as openshift/origin#8345 to be resolved (where generated API documentation is currently incorrect due to the asymmetry between the object kind sent and received by the API)

```release-note NONE```

Kubernetes-commit: 50fa5637b6dc9538c908fbdd632ff1d3c59f65da
sttts pushed a commit to sttts/apiserver that referenced this issue Oct 16, 2017
@k8s-publish-robot
Merge pull request #51972 from jim-minter/producedObject
0f3e92f 
Automatic merge from submit-queue (batch tested with PRs 51067, 52319, 52803, 52961, 51972). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>..

ProducesObject should only update the returned API object resource documentation

This should be a no-op for Kubernetes (the only rest.Storage that specifies ProducesObject() is pod logs, on GET), but will allow issues such as openshift/origin#8345 to be resolved (where generated API documentation is currently incorrect due to the asymmetry between the object kind sent and received by the API)

```release-note NONE```

Kubernetes-commit: 50fa5637b6dc9538c908fbdd632ff1d3c59f65da
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jim-minter jim-minter

Labels
area/documentation component/build priority/P2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

api docs should show right return value for build instantiate{binary,} jim-minter/origin
6 participants
@php-coder @jimmidyson @danmcp @jim-minter @smarterclayton @bparees