From d3b3ce345c2d9f9bbc9aca4a39a3c3e67ba7aaad Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 10 Aug 2017 20:34:44 +0200 Subject: [PATCH] Update incorrect types in Swagger - `ObjectVersion.Index` is an `uint64` https://github.com/moby/moby/blob/0fd90c4d5d8ab739d6f999a36d9c4096e89c8059/api/types/swarm/common.go#L5-L15 - `ClusterInfo` is nullable in the `/info` output (see https://github.com/moby/moby/blob/ff4f700f74450018f36d014f3cde0ff1b9c17fb3/api/types/swarm/swarm.go#L203) - `CAConfig.ForceRotate` was missing a type, therefore treated as an `object` in Swagger: https://github.com/moby/moby/blob/ff4f700f74450018f36d014f3cde0ff1b9c17fb3/api/types/swarm/swarm.go#L121 - `Raft.SnapshotInterval`, `Raft.KeepOldSnapshots`, and `Raft.LogEntriesForSlowFollowers` are an `uint64` not an `int64` - Various fields in `swarm.Info` are nullable; added `x-nullable` Signed-off-by: Sebastiaan van Stijn Upstream-commit: 93e324e2a7b8131414382b6fb38b69f0d09bc30c Component: engine --- components/engine/api/swagger.yaml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/components/engine/api/swagger.yaml b/components/engine/api/swagger.yaml index 0ce735f0fb..2037248807 100644 --- a/components/engine/api/swagger.yaml +++ b/components/engine/api/swagger.yaml @@ -1975,7 +1975,7 @@ definitions: properties: Index: type: "integer" - format: "int64" + format: "uint64" example: 373531 NodeSpec: @@ -2227,6 +2227,7 @@ definitions: Orchestration: description: "Orchestration configuration." type: "object" + x-nullable: true properties: TaskHistoryRetentionLimit: description: "The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks." @@ -2240,16 +2241,16 @@ definitions: SnapshotInterval: description: "The number of log entries between snapshots." type: "integer" - format: "int64" + format: "uint64" example: 10000 KeepOldSnapshots: description: "The number of snapshots to keep beyond the current snapshot." type: "integer" - format: "int64" + format: "uint64" LogEntriesForSlowFollowers: description: "The number of log entries to keep around to sync up slow followers after a snapshot is created." type: "integer" - format: "int64" + format: "uint64" example: 500 ElectionTick: description: | @@ -2268,6 +2269,7 @@ definitions: Dispatcher: description: "Dispatcher configuration." type: "object" + x-nullable: true properties: HeartbeatPeriod: description: "The delay for an agent to send a heartbeat to the dispatcher." @@ -2277,6 +2279,7 @@ definitions: CAConfig: description: "CA configuration." type: "object" + x-nullable: true properties: NodeCertExpiry: description: "The duration node certificates are issued for." @@ -2314,6 +2317,8 @@ definitions: type: "string" ForceRotate: description: "An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey`" + format: "uint64" + type: "integer" EncryptionConfig: description: "Parameters related to encryption-at-rest." type: "object" @@ -2375,6 +2380,7 @@ definitions: description: | ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included. + x-nullable: true type: "object" properties: ID: