openapi: 3.2.0
info:
title: Reddy Ice Middleware Health API
description: 'Middleware service that integrates Reddy Ice systems with the Maven Machines platform.
## Authentication
All protected endpoints require an API key in the `apiKey` request header.
`GET /` is public and does not require an API key.
## Environment
The middleware URL is the same for all tiers. Your `apiKey` determines which Maven
environment (dev, qa, staging, prod) receives the request.'
version: 1.0.0
contact: {}
license:
name: UNLICENSED
servers:
- url: https://reddy-ice.middleware.mavenmachines.com
description: Middleware (target env selected by apiKey)
tags:
- name: health
paths:
/:
get:
operationId: AppController_getHello
summary: Health Check
description: Returns a simple message to verify the middleware is running
security: []
parameters: []
responses:
'200':
description: Service is running
content:
application/json:
schema:
type: string
example: Hello World!
'500':
description: Unexpected server error
5XX:
description: Server error
4XX:
description: Client error
tags:
- health
components:
securitySchemes:
api_key:
type: apiKey
in: header
name: apiKey