github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #68864 from roycaihw/fix-rollback-doc 

Fix openapi spec and api reference: posting a rollback returns a metav1.Status
pull/58/head
k8s-ci-robot 2018-09-26 19:22:53 -07:00 committed by GitHub
parent 769dbc6693 9f78c45c01
commit dbba1a5384
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 22 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api/openapi-spec/swagger.json generated
View File

@ -29807,19 +29807,19 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/io.k8s.api.apps.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/io.k8s.api.apps.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/io.k8s.api.apps.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"401": {
@ -50615,19 +50615,19 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/io.k8s.api.extensions.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/io.k8s.api.extensions.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/io.k8s.api.extensions.v1beta1.DeploymentStatus"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
}
},
"401": {

8
api/swagger-spec/apps_v1beta1.json generated
View File

@ -1983,7 +1983,7 @@
"description": "API at /apis/apps/v1beta1",
"operations": [
{
"type": "v1beta1.DeploymentStatus",
"type": "v1.Status",
"method": "POST",
"summary": "create rollback of a Deployment",
"nickname": "createNamespacedDeploymentRollback",
@ -2025,17 +2025,17 @@
{
"code": 200,
"message": "OK",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
},
{
"code": 201,
"message": "Created",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
},
{
"code": 202,
"message": "Accepted",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
}
],
"produces": [

8
api/swagger-spec/extensions_v1beta1.json generated
View File

@ -2153,7 +2153,7 @@
"description": "API at /apis/extensions/v1beta1",
"operations": [
{
"type": "v1beta1.DeploymentStatus",
"type": "v1.Status",
"method": "POST",
"summary": "create rollback of a Deployment",
"nickname": "createNamespacedDeploymentRollback",
@ -2195,17 +2195,17 @@
{
"code": 200,
"message": "OK",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
},
{
"code": 201,
"message": "Created",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
},
{
"code": 202,
"message": "Accepted",
"responseModel": "v1beta1.DeploymentStatus"
"responseModel": "v1.Status"
}
],
"produces": [

6
docs/api-reference/apps/v1beta1/operations.html generated
View File

@ -2982,17 +2982,17 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">202</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
</tbody>
</table>

6
docs/api-reference/extensions/v1beta1/operations.html generated
View File

@ -3541,17 +3541,17 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">202</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_deploymentstatus">v1beta1.DeploymentStatus</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
</tr>
</tbody>
</table>

1
pkg/registry/apps/deployment/storage/BUILD
View File

@ -49,7 +49,6 @@ go_library(
"//pkg/printers/internalversion:go_default_library",
"//pkg/printers/storage:go_default_library",
"//pkg/registry/apps/deployment:go_default_library",
"//staging/src/k8s.io/api/apps/v1beta1:go_default_library",
"//staging/src/k8s.io/apimachinery/pkg/api/errors:go_default_library",
"//staging/src/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//staging/src/k8s.io/apimachinery/pkg/runtime:go_default_library",

3
pkg/registry/apps/deployment/storage/storage.go
View File

@ -21,7 +21,6 @@ import (
"fmt"
"net/http"
externalappsv1beta1 "k8s.io/api/apps/v1beta1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
@ -149,7 +148,7 @@ func (r *RollbackREST) ProducesMIMETypes(verb string) []string {
// ProducesObject returns an object the specified HTTP verb respond with. It will overwrite storage object if
// it is not nil. Only the type of the return object matters, the value will be ignored.
func (r *RollbackREST) ProducesObject(verb string) interface{} {
return externalappsv1beta1.DeploymentStatus{}
return metav1.Status{}
}
var _ = rest.StorageMetadata(&RollbackREST{})

13
pkg/registry/extensions/rest/storage_extensions.go
View File

@ -47,17 +47,6 @@ func (p RESTStorageProvider) NewRESTStorage(apiResourceConfigSource serverstorag
return apiGroupInfo, true
}
type RollbackREST struct {
*deploymentstore.RollbackREST
}
// override RollbackREST.ProducesObject
func (r *RollbackREST) ProducesObject(verb string) interface{} {
return extensionsapiv1beta1.DeploymentStatus{}
}
var _ = rest.StorageMetadata(&RollbackREST{})
func (p RESTStorageProvider) v1beta1Storage(apiResourceConfigSource serverstorage.APIResourceConfigSource, restOptionsGetter generic.RESTOptionsGetter) map[string]rest.Storage {
storage := map[string]rest.Storage{}
@ -76,7 +65,7 @@ func (p RESTStorageProvider) v1beta1Storage(apiResourceConfigSource serverstorag
deploymentStorage := deploymentstore.NewStorage(restOptionsGetter)
storage["deployments"] = deploymentStorage.Deployment.WithCategories(nil)
storage["deployments/status"] = deploymentStorage.Status
storage["deployments/rollback"] = &RollbackREST{deploymentStorage.Rollback}
storage["deployments/rollback"] = deploymentStorage.Rollback
storage["deployments/scale"] = deploymentStorage.Scale
// ingresses
ingressStorage, ingressStatusStorage := ingressstore.NewREST(restOptionsGetter)