Skip to content

Commit

Permalink
update swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
Chao Xu committed Oct 12, 2015
1 parent 4c9b88a commit 7554331
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 16 deletions.
33 changes: 17 additions & 16 deletions api/swagger-spec/v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -1184,7 +1184,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -1808,7 +1808,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -2392,7 +2392,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -2920,7 +2920,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -3761,7 +3761,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -4404,7 +4404,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -4921,7 +4921,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -7088,7 +7088,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -7712,7 +7712,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -8395,7 +8395,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -9078,7 +9078,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -9702,7 +9702,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -10326,7 +10326,7 @@
"allowMultiple": false
},
{
"type": "api.Patch",
"type": "unversioned.Patch",
"paramType": "body",
"name": "body",
"description": "",
Expand Down Expand Up @@ -11414,8 +11414,9 @@
}
}
},
"api.Patch": {
"id": "api.Patch",
"unversioned.Patch": {
"id": "unversioned.Patch",
"description": "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.",
"properties": {}
},
"unversioned.Status": {
Expand Down
76 changes: 76 additions & 0 deletions pkg/api/unversioned/types_swagger_doc_generated.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,65 @@ package unversioned
// Those methods can be generated by using hack/update-generated-swagger-docs.sh

// AUTO-GENERATED FUNCTIONS START HERE
var map_APIGroup = map[string]string{
"": "APIGroup contains the name, the supported versions, and the preferred version of a group.",
"name": "name is the name of the group.",
"versions": "versions are the versions supported in this group.",
"preferredVersion": "preferredVersion is the version preferred by the API server, which probably is the storage version.",
}

func (APIGroup) SwaggerDoc() map[string]string {
return map_APIGroup
}

var map_APIGroupList = map[string]string{
"": "APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.",
"groups": "groups is a list of APIGroup.",
}

func (APIGroupList) SwaggerDoc() map[string]string {
return map_APIGroupList
}

var map_APIResource = map[string]string{
"": "APIResource specifies the name of a resource and whether it is namespaced.",
"name": "name is the name of the resource.",
"namespaced": "namespaced indicates if a resource is namespaced or not.",
}

func (APIResource) SwaggerDoc() map[string]string {
return map_APIResource
}

var map_APIResourceList = map[string]string{
"": "APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.",
"groupVersion": "groupVersion is the group and version this APIResourceList is for.",
"resources": "resources contains the name of the resources and if they are namespaced.",
}

func (APIResourceList) SwaggerDoc() map[string]string {
return map_APIResourceList
}

var map_APIVersions = map[string]string{
"": "APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.",
"versions": "versions are the api versions that are available.",
}

func (APIVersions) SwaggerDoc() map[string]string {
return map_APIVersions
}

var map_GroupVersion = map[string]string{
"": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensiblity.",
"groupVersion": "groupVersion specifies the API group and version in the form \"group/version\"",
"version": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
}

func (GroupVersion) SwaggerDoc() map[string]string {
return map_GroupVersion
}

var map_ListMeta = map[string]string{
"": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"selfLink": "SelfLink is a URL representing this object. Populated by the system. Read-only.",
Expand All @@ -37,6 +96,23 @@ func (ListMeta) SwaggerDoc() map[string]string {
return map_ListMeta
}

var map_Patch = map[string]string{
"": "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.",
}

func (Patch) SwaggerDoc() map[string]string {
return map_Patch
}

var map_RootPaths = map[string]string{
"": "RootPaths lists the paths available at root. For example: \"/healthz\", \"/apis\".",
"paths": "paths are the paths available at root.",
}

func (RootPaths) SwaggerDoc() map[string]string {
return map_RootPaths
}

var map_Status = map[string]string{
"": "Status is a return value for calls that don't return other objects.",
"metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds",
Expand Down

0 comments on commit 7554331

Please sign in to comment.