Annotate some swagger documented types as int64

[gesellix]

Using the swagger.yaml to generate api models will create incompatible field types. Some inconsistencies had already been mentioned at #39131. I've added more fixes from real life experience, some only occurring on Windows.

Closes #39131

Signed-off-by: Tobias Gesellchen tobias@gesellix.de

- What I did

The following types documented in api/swagger.yaml and docs/api/v1.41.yaml have been adjusted to match the types in the Golang model:

• container.HealthConfig.Interval
• container.HealthConfig.Timeout
• container.HealthConfig.StartPeriod
• container.WaitResponse.StatusCode
• types.ImageSummary.SharedSize
• volume.UsageData.Size
• volume.UsageData.RefCount

- How I did it

Changed the swagger.yaml and v1.41.yaml, compared with moby's Golang types (didn't check any older api versions).

- How to verify it

See the list above, with each entry linking to the Golang source for easier comparison.

- Description for the changelog

Annotate some Swagger documented types as int64, matching the Golang types.

- A picture of a cute animal (not mandatory but encouraged)

[gesellix]

Looks like I forgot to update the types/image_summary.go for the fixed typo (s/imagem/image,/), I'm going to fix that soon.

[thaJeztah]

Thanks!

Hmm.. validate is failing 🤔 ;

The result of hack/generate-swagger-api.sh differs
 
diff --git a/api/types/image_summary.go b/api/types/image_summary.go
index 53c2885758..90b983a25c 100644
--- a/api/types/image_summary.go
+++ b/api/types/image_summary.go
@@ -61,7 +61,7 @@ type ImageSummary struct {
 	// List of image names/tags in the local image cache that reference this
 	// image.
 	//
-	// Multiple image tags can refer to the same imagem and this list may be
+	// Multiple image tags can refer to the same image, and this list may be
 	// empty if no tags reference the image, in which case the image is
 	// "untagged", in which case it can still be referenced by its ID.
 	//

Please update api/swagger.yaml with any API changes, then 
run hack/generate-swagger-api.sh.

Ah! I think that's because that bit is related to the Go types;

moby/api/types/image_summary.go

Line 64 in 235f862

// Multiple image tags can refer to the same imagem and this list may be

and

moby/api/types/types.go

Line 51 in 235f862

// Multiple image tags can refer to the same imagem and this list may be

So those will have to be updated as well 😅

[thaJeztah]

Looks like I forgot to update the types/image_summary.go for the fixed typo (s/imagem/image,/), I'm going to fix that soon.

Whoops; I had the tab open with my comment in draft, and didn't see your post 😂

[gesellix]

@thaJeztah thanks for pointing me to the second occurrence at

moby/api/types/types.go

Line 51 in 235f862

// Multiple image tags can refer to the same imagem and this list may be

:)

[gesellix]

Wow... "Upstream fix" somewhere far away closed this pull request. TIL.

[gesellix]

The failing test case doesn't seem to be related to my changes 🤔

[2022-05-23T20:28:57.914Z] === Failed
[2022-05-23T20:28:57.914Z] === FAIL: amd64.integration-cli TestDockerSuite/TestExecWithPrivileged (0.83s)
[2022-05-23T20:28:57.914Z]     docker_cli_exec_test.go:463: assertion failed: 
[2022-05-23T20:28:57.914Z]         Command:  /usr/local/cli/docker logs parent
[2022-05-23T20:28:57.914Z]         ExitCode: 1
[2022-05-23T20:28:57.914Z]         Error:    exit status 1
[2022-05-23T20:28:57.914Z]         Stdout:   Privileged exec has not run yet
[2022-05-23T20:28:57.914Z]         Privileged exec has not run yet
[2022-05-23T20:28:57.914Z]         Privileged exec has not run yet
[2022-05-23T20:28:57.914Z]         
[2022-05-23T20:28:57.914Z]         Stderr:   error from daemon in stream: Error grabbing logs: invalid character 'l' after object key:value pair
[2022-05-23T20:28:57.914Z]         
[2022-05-23T20:28:57.914Z]         
[2022-05-23T20:28:57.914Z]         
[2022-05-23T20:28:57.914Z]         Failures:
[2022-05-23T20:28:57.914Z]         ExitCode was 1 expected 0
[2022-05-23T20:28:57.914Z]         Expected no error
[2022-05-23T20:28:57.914Z]     --- FAIL: TestDockerSuite/TestExecWithPrivileged (0.83s)
[2022-05-23T20:28:57.914Z] 
[2022-05-23T20:28:57.914Z] === FAIL: amd64.integration-cli TestDockerSuite (1370.50s)
[2022-05-23T20:28:57.914Z] 

[thaJeztah]

Wow... "Upstream fix" somewhere far away closed this pull request. TIL.

Ah, yes, those can be fun; even more so if the fix #xyz is in the commit message (can't edit those after the fact)

The failing test case doesn't seem to be related to my changes

Probably some flakiness; let me kick CI again

[thaJeztah]

LGTM

[gesellix]

This one also doesn't seem to be related:

[2022-05-24T12:59:49.289Z] === FAIL: github.com/docker/docker/integration-cli TestDockerSuite/TestRunContainerWithRmFlagCannotStartContainer (2.20s)
[2022-05-24T12:59:49.289Z]     docker_cli_run_test.go:2770: Expected not to have containers f11f42a8a90e
[2022-05-24T12:59:49.289Z]         
[2022-05-24T12:59:49.289Z]     --- FAIL: TestDockerSuite/TestRunContainerWithRmFlagCannotStartContainer (2.20s)
[2022-05-24T12:59:49.289Z] 
[2022-05-24T12:59:49.289Z] === FAIL: github.com/docker/docker/integration-cli TestDockerSuite (2660.72s)
[2022-05-24T12:59:49.289Z] 

If I can do anything to make it work, please leave a note here :)

[thaJeztah]

Looks like that test was flaky before; #11966 (and I saw a couple of other mentions). Should not be related, but let me kick it once more just to see if we can make it nice and green 😅

[codecov]

Codecov Report

Merging #43629 (345346d) into master (0a3767c) will decrease coverage by 5.13%.
The diff coverage is 61.44%.

@@            Coverage Diff             @@
##           master   #43629      +/-   ##
==========================================
- Coverage   36.18%   31.04%   -5.14%     
==========================================
  Files         610      643      +33     
  Lines       45363    65896   +20533     
==========================================
+ Hits        16413    20456    +4043     
- Misses      26707    43539   +16832     
+ Partials     2243     1901     -342