Skip to content

Commit 32fb33f

Browse files
authored
Merge pull request #18 from linuxfoundation/jme/LFXV2-307
do not generate spec for /livez or /readyz
2 parents 7836ac0 + 1a9d240 commit 32fb33f

File tree

5 files changed

+4
-86
lines changed

5 files changed

+4
-86
lines changed

api/project/v1/design/project.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,7 @@ var _ = Service("project-service", func() {
319319

320320
Method("readyz", func() {
321321
Description("Check if the service is able to take inbound requests.")
322+
Meta("swagger:generate", "false")
322323
Result(Bytes, func() {
323324
Example("OK")
324325
})
@@ -334,6 +335,7 @@ var _ = Service("project-service", func() {
334335

335336
Method("livez", func() {
336337
Description("Check if the service is alive.")
338+
Meta("swagger:generate", "false")
337339
Result(Bytes, func() {
338340
Example("OK")
339341
})

api/project/v1/gen/http/openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

api/project/v1/gen/http/openapi.yaml

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,6 @@ paths:
6565
type: file
6666
schemes:
6767
- http
68-
/livez:
69-
get:
70-
tags:
71-
- project-service
72-
summary: livez project-service
73-
description: Check if the service is alive.
74-
operationId: project-service#livez
75-
produces:
76-
- text/plain
77-
responses:
78-
"200":
79-
description: OK response.
80-
schema:
81-
type: string
82-
format: byte
83-
schemes:
84-
- http
8568
/projects:
8669
get:
8770
tags:
@@ -545,30 +528,6 @@ paths:
545528
- http
546529
security:
547530
- jwt_header_Authorization: []
548-
/readyz:
549-
get:
550-
tags:
551-
- project-service
552-
summary: readyz project-service
553-
description: Check if the service is able to take inbound requests.
554-
operationId: project-service#readyz
555-
produces:
556-
- text/plain
557-
responses:
558-
"200":
559-
description: OK response.
560-
schema:
561-
type: string
562-
format: byte
563-
"503":
564-
description: Service Unavailable response.
565-
schema:
566-
$ref: '#/definitions/ServiceUnavailableError'
567-
required:
568-
- code
569-
- message
570-
schemes:
571-
- http
572531
definitions:
573532
BadRequestError:
574533
title: BadRequestError

api/project/v1/gen/http/openapi3.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

api/project/v1/gen/http/openapi3.yaml

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,6 @@ paths:
4343
responses:
4444
"200":
4545
description: File downloaded
46-
/livez:
47-
get:
48-
tags:
49-
- project-service
50-
summary: livez project-service
51-
description: Check if the service is alive.
52-
operationId: project-service#livez
53-
responses:
54-
"200":
55-
description: OK response.
56-
content:
57-
text/plain:
58-
schema:
59-
type: string
60-
example: OK
61-
format: binary
62-
example: OK
6346
/projects:
6447
get:
6548
tags:
@@ -883,32 +866,6 @@ paths:
883866
message: The service is unavailable.
884867
security:
885868
- jwt_header_Authorization: []
886-
/readyz:
887-
get:
888-
tags:
889-
- project-service
890-
summary: readyz project-service
891-
description: Check if the service is able to take inbound requests.
892-
operationId: project-service#readyz
893-
responses:
894-
"200":
895-
description: OK response.
896-
content:
897-
text/plain:
898-
schema:
899-
type: string
900-
example: OK
901-
format: binary
902-
example: OK
903-
"503":
904-
description: 'ServiceUnavailable: Service is unavailable'
905-
content:
906-
application/json:
907-
schema:
908-
$ref: '#/components/schemas/ServiceUnavailableError'
909-
example:
910-
code: "503"
911-
message: The service is unavailable.
912869
components:
913870
schemas:
914871
BadRequestError:

0 commit comments

Comments
 (0)