kotovalexarian-likes-github
/
moby--moby
mirror of https://github.com/moby/moby.git
1
0
Fork 0
Code Releases Activity

Merge pull request #35593 from ndeloof/master 

Improve swagger schema for code generation
This commit is contained in:
Sebastiaan van Stijn 2018-01-08 12:17:56 +01:00 committed by GitHub
parent 847df43d1d 8e7f9afa47
commit 16a1736b9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 43 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
api/swagger.yaml
View File

@ -4502,6 +4502,8 @@ paths:
description: "Container created successfully"
schema:
type: "object"
title: "ContainerCreateResponse"
description: "OK response to ContainerCreate operation"
required: [Id, Warnings]
properties:
Id:
@ -4550,6 +4552,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "ContainerInspectResponse"
properties:
Id:
description: "The ID of the container"
@ -4834,6 +4837,8 @@ paths:
description: "no error"
schema:
type: "object"
title: "ContainerTopResponse"
description: "OK response to ContainerTop operation"
properties:
Titles:
description: "The ps column titles"
@ -4994,6 +4999,8 @@ paths:
items:
type: "object"
x-go-name: "ContainerChangeResponseItem"
title: "ContainerChangeResponseItem"
description: "change item in response to ContainerChanges operation"
required: [Path, Kind]
properties:
Path:
@ -5372,6 +5379,8 @@ paths:
description: "The container has been updated."
schema:
type: "object"
title: "ContainerUpdateResponse"
description: "OK response to ContainerUpdate operation"
properties:
Warnings:
type: "array"
@ -5725,6 +5734,8 @@ paths:
description: "The container has exit."
schema:
type: "object"
title: "ContainerWaitResponse"
description: "OK response to ContainerWait operation"
required: [StatusCode]
properties:
StatusCode:
@ -5970,6 +5981,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "ContainerPruneResponse"
properties:
ContainersDeleted:
description: "Container IDs that were deleted"
@ -6226,6 +6238,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "BuildPruneResponse"
properties:
SpaceReclaimed:
description: "Disk space reclaimed in bytes"
@ -6411,6 +6424,8 @@ paths:
items:
type: "object"
x-go-name: HistoryResponseItem
title: "HistoryResponseItem"
description: "individual image layer information in response to ImageHistory operation"
required: [Id, Created, CreatedBy, Tags, Size, Comment]
properties:
Id:
@ -6617,6 +6632,7 @@ paths:
type: "array"
items:
type: "object"
title: "ImageSearchResponseItem"
properties:
description:
type: "string"
@ -6692,6 +6708,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "ImagePruneResponse"
properties:
ImagesDeleted:
description: "Images that were deleted"
@ -6719,6 +6736,7 @@ paths:
description: "An identity token was generated successfully."
schema:
type: "object"
title: "SystemAuthResponse"
required: [Status]
properties:
Status:
@ -6773,6 +6791,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "SystemVersionResponse"
properties:
Platform:
type: "object"
@ -6951,6 +6970,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "SystemEventsResponse"
properties:
Type:
description: "The type of object emitting the event"
@ -7034,6 +7054,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "SystemDataUsageResponse"
properties:
LayersSize:
type: "integer"
@ -7392,7 +7413,12 @@ paths:
description: "No error"
schema:
type: "object"
title: "ExecInspectResponse"
properties:
CanRemove:
type: "boolean"
DetachKeys:
type: "string"
ID:
type: "string"
Running:
@ -7458,6 +7484,7 @@ paths:
description: "Summary volume data that matches the query"
schema:
type: "object"
title: "VolumeListResponse"
required: [Volumes, Warnings]
properties:
Volumes:
@ -7639,6 +7666,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "VolumePruneResponse"
properties:
VolumesDeleted:
description: "Volumes that were deleted"
@ -7817,6 +7845,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "NetworkCreateResponse"
properties:
Id:
description: "The ID of the created network."
@ -8019,6 +8048,7 @@ paths:
description: "No error"
schema:
type: "object"
title: "NetworkPruneResponse"
properties:
NetworksDeleted:
description: "Networks that were deleted"
@ -8070,6 +8100,7 @@ paths:
items:
description: "Describes a permission the user has to accept upon installing the plugin."
type: "object"
title: "PluginPrivilegeItem"
properties:
Name:
type: "string"
@ -8772,6 +8803,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "UnlockKeyResponse"
properties:
UnlockKey:
description: "The swarm's unlock key."
@ -8863,6 +8895,7 @@ paths:
description: "no error"
schema:
type: "object"
title: "ServiceCreateResponse"
properties:
ID:
description: "The ID of the created service."
@ -9534,13 +9567,7 @@ paths:
201:
description: "no error"
schema:
type: "object"
properties:
ID:
description: "The ID of the created secret."
type: "string"
example:
ID: "ktnbjxoalbkvbvedmg1urrz8h"
$ref: "#/definitions/IdResponse"
409:
description: "name conflicts with an existing object"
schema:
@ -9739,13 +9766,7 @@ paths:
201:
description: "no error"
schema:
type: "object"
properties:
ID:
description: "The ID of the created config."
type: "string"
example:
ID: "ktnbjxoalbkvbvedmg1urrz8h"
$ref: "#/definitions/IdResponse"
409:
description: "name conflicts with an existing object"
schema:
@ -9891,6 +9912,7 @@ paths:
schema:
type: "object"
x-go-name: DistributionInspect
title: "DistributionInspectResponse"
required: [Descriptor, Platforms]
properties:
Descriptor:

2
api/templates/server/operation.gotmpl
View File

@ -20,7 +20,7 @@ import (
{{ range .ExtraSchemas }}
// {{ .Name }} {{ template "docstring" . }}
// {{ .Name }} {{ comment .Description }}
// swagger:model {{ .Name }}
{{ template "schema" . }}
{{ end }}

2
api/types/container/container_changes.go
View File

@ -7,7 +7,7 @@ package container
// See hack/generate-swagger-api.sh
// ----------------------------------------------------------------------------
// ContainerChangeResponseItem container change response item
// ContainerChangeResponseItem change item in response to ContainerChanges operation
// swagger:model ContainerChangeResponseItem
type ContainerChangeResponseItem struct {

2
api/types/container/container_create.go
View File

@ -7,7 +7,7 @@ package container
// See hack/generate-swagger-api.sh
// ----------------------------------------------------------------------------
// ContainerCreateCreatedBody container create created body
// ContainerCreateCreatedBody OK response to ContainerCreate operation
// swagger:model ContainerCreateCreatedBody
type ContainerCreateCreatedBody struct {

2
api/types/container/container_top.go
View File

@ -7,7 +7,7 @@ package container
// See hack/generate-swagger-api.sh
// ----------------------------------------------------------------------------
// ContainerTopOKBody container top o k body
// ContainerTopOKBody OK response to ContainerTop operation
// swagger:model ContainerTopOKBody
type ContainerTopOKBody struct {

2
api/types/container/container_update.go
View File

@ -7,7 +7,7 @@ package container
// See hack/generate-swagger-api.sh
// ----------------------------------------------------------------------------
// ContainerUpdateOKBody container update o k body
// ContainerUpdateOKBody OK response to ContainerUpdate operation
// swagger:model ContainerUpdateOKBody
type ContainerUpdateOKBody struct {

2
api/types/container/container_wait.go
View File

@ -15,7 +15,7 @@ type ContainerWaitOKBodyError struct {
Message string `json:"Message,omitempty"`
}
// ContainerWaitOKBody container wait o k body
// ContainerWaitOKBody OK response to ContainerWait operation
// swagger:model ContainerWaitOKBody
type ContainerWaitOKBody struct {

2
api/types/image/image_history.go
View File

@ -7,7 +7,7 @@ package image
// See hack/generate-swagger-api.sh
// ----------------------------------------------------------------------------
// HistoryResponseItem history response item
// HistoryResponseItem individual image layer information in response to ImageHistory operation
// swagger:model HistoryResponseItem
type HistoryResponseItem struct {