Browse Source

Merge pull request #42882 from thaJeztah/update_swagger_docs_image

Makefile: update bfirsh/redoc to 1.14.0, and fix swagger warnings
Brian Goff 3 years ago
parent
commit
b9c26a56a3
2 changed files with 4 additions and 4 deletions
  1. 1 1
      Makefile
  2. 3 3
      api/swagger.yaml

+ 1 - 1
Makefile

@@ -264,7 +264,7 @@ swagger-docs: ## preview the API documentation
 	@docker run --rm -v $(PWD)/api/swagger.yaml:/usr/share/nginx/html/swagger.yaml \
 	@docker run --rm -v $(PWD)/api/swagger.yaml:/usr/share/nginx/html/swagger.yaml \
 		-e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \
 		-e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \
 		-p $(SWAGGER_DOCS_PORT):80 \
 		-p $(SWAGGER_DOCS_PORT):80 \
-		bfirsh/redoc:1.6.2
+		bfirsh/redoc:1.14.0
 
 
 .PHONY: buildx
 .PHONY: buildx
 ifdef USE_BUILDX
 ifdef USE_BUILDX

+ 3 - 3
api/swagger.yaml

@@ -746,6 +746,7 @@ definitions:
     description: |
     description: |
       Health stores information about the container's healthcheck results.
       Health stores information about the container's healthcheck results.
     type: "object"
     type: "object"
+    x-nullable: true
     properties:
     properties:
       Status:
       Status:
         description: |
         description: |
@@ -771,13 +772,13 @@ definitions:
         description: |
         description: |
           Log contains the last few results (oldest first)
           Log contains the last few results (oldest first)
         items:
         items:
-          x-nullable: true
           $ref: "#/definitions/HealthcheckResult"
           $ref: "#/definitions/HealthcheckResult"
 
 
   HealthcheckResult:
   HealthcheckResult:
     description: |
     description: |
       HealthcheckResult stores information about a single run of a healthcheck probe
       HealthcheckResult stores information about a single run of a healthcheck probe
     type: "object"
     type: "object"
+    x-nullable: true
     properties:
     properties:
       Start:
       Start:
         description: |
         description: |
@@ -4217,6 +4218,7 @@ definitions:
       ContainerState stores container's running state. It's part of ContainerJSONBase
       ContainerState stores container's running state. It's part of ContainerJSONBase
       and will be returned by the "inspect" command.
       and will be returned by the "inspect" command.
     type: "object"
     type: "object"
+    x-nullable: true
     properties:
     properties:
       Status:
       Status:
         description: |
         description: |
@@ -4274,7 +4276,6 @@ definitions:
         type: "string"
         type: "string"
         example: "2020-01-06T09:07:59.461876391Z"
         example: "2020-01-06T09:07:59.461876391Z"
       Health:
       Health:
-        x-nullable: true
         $ref: "#/definitions/Health"
         $ref: "#/definitions/Health"
 
 
   SystemVersion:
   SystemVersion:
@@ -5787,7 +5788,6 @@ paths:
                 items:
                 items:
                   type: "string"
                   type: "string"
               State:
               State:
-                x-nullable: true
                 $ref: "#/definitions/ContainerState"
                 $ref: "#/definitions/ContainerState"
               Image:
               Image:
                 description: "The container's image ID"
                 description: "The container's image ID"