github.com/gedevops/x@v1.0.3/healthx/openapi/patch.yaml (about)

     1  - op: replace
     2    path: /paths/~1health~1alive
     3    value:
     4      get:
     5        description: |-
     6          This endpoint returns a HTTP 200 status code when {{.ProjectHumanName}} is accepting incoming
     7          HTTP requests. This status does currently not include checks whether the database connection is working.
     8  
     9          If the service supports TLS Edge Termination, this endpoint does not require the
    10          `X-Forwarded-Proto` header to be set.
    11  
    12          Be aware that if you are running multiple nodes of this service, the health status will never
    13          refer to the cluster state, only to a single instance.
    14        operationId: isAlive
    15        responses:
    16          '200':
    17            content:
    18              application/json:
    19                schema:
    20                  required:
    21                    - status
    22                  type: object
    23                  properties:
    24                    status:
    25                      description: Always "ok".
    26                      type: string
    27            description: {{.ProjectHumanName}} is ready to accept connections.
    28          '500':
    29            content:
    30              application/json:
    31                schema:
    32                  "$ref": "#/components/schemas/genericError"
    33            description: genericError
    34        summary: Check HTTP Server Status
    35        tags: {{ .HealthPathTags | toJson }}
    36  - op: replace
    37    path: /paths/~1health~1ready
    38    value:
    39      get:
    40        operationId: isReady
    41        description: |-
    42          This endpoint returns a HTTP 200 status code when {{.ProjectHumanName}} is up running and the environment dependencies (e.g.
    43          the database) are responsive as well.
    44  
    45          If the service supports TLS Edge Termination, this endpoint does not require the
    46          `X-Forwarded-Proto` header to be set.
    47  
    48          Be aware that if you are running multiple nodes of {{.ProjectHumanName}}, the health status will never
    49          refer to the cluster state, only to a single instance.
    50        responses:
    51          '200':
    52            content:
    53              application/json:
    54                schema:
    55                  required:
    56                    - status
    57                  type: object
    58                  properties:
    59                    status:
    60                      description: Always "ok".
    61                      type: string
    62            description: {{.ProjectHumanName}} is ready to accept requests.
    63          '503':
    64            content:
    65              application/json:
    66                schema:
    67                  required:
    68                    - errors
    69                  properties:
    70                    errors:
    71                      additionalProperties:
    72                        type: string
    73                      description: Errors contains a list of errors that caused the not ready status.
    74                      type: object
    75                  type: object
    76            description: Ory Kratos is not yet ready to accept requests.
    77        summary: Check HTTP Server and Database Status
    78        tags: {{ .HealthPathTags | toJson }}
    79  - op: replace
    80    path: /paths/~1version
    81    value:
    82      get:
    83        description: |-
    84          This endpoint returns the version of {{.ProjectHumanName}}.
    85  
    86          If the service supports TLS Edge Termination, this endpoint does not require the
    87          `X-Forwarded-Proto` header to be set.
    88  
    89          Be aware that if you are running multiple nodes of this service, the version will never
    90          refer to the cluster state, only to a single instance.
    91        operationId: getVersion
    92        responses:
    93          '200':
    94            content:
    95              application/json:
    96                schema:
    97                  type: object
    98                  required:
    99                    - version
   100                  properties:
   101                    version:
   102                      description: The version of {{.ProjectHumanName}}.
   103                      type: string
   104            description: Returns the {{.ProjectHumanName}} version.
   105        summary: Return Running Software Version.
   106        tags: {{ .HealthPathTags | toJson }}