Last active
November 3, 2015 17:25
-
-
Save ijin/a41059039937ffc8dada to your computer and use it in GitHub Desktop.
Elastic Beanstalk API Gateway swagger file
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swagger: '2.0' | |
info: | |
title: EB API | |
description: Elastic Beanstalk API | |
version: 1.0.0 | |
host: api.ijin.io | |
schemes: | |
- https | |
basePath: /eb | |
produces: | |
- text/plain | |
- application/json | |
paths: | |
'/{env_name}/ip': | |
get: | |
summary: get instance IP address(es) | |
description: > | |
This endpoint returns the IP address(es) of the instances managed by the Elastic Beanstalk enviornment. | |
parameters: | |
- name: env_name | |
in: path | |
description: EB environment name | |
required: true | |
type: string | |
tags: | |
- IP | |
responses: | |
'200': | |
description: IP address(es) | |
schema: | |
type: string | |
items: | |
$ref: '#/definitions/IP' | |
default: | |
description: Unexpected error | |
schema: | |
$ref: '#/definitions/Error' | |
'/{env_name}/ip/{server_num}': | |
get: | |
summary: get instance IP address for specific server | |
description: > | |
This endpoint returns the IP address for a specific instance server managed by the Elastic Beanstalk enviornment. | |
parameters: | |
- name: env_name | |
in: path | |
description: EB environment name | |
required: true | |
type: string | |
- name: server_num | |
in: path | |
description: server number | |
required: true | |
type: integer | |
format: int32 | |
tags: | |
- IP | |
responses: | |
'200': | |
description: IP address(es) | |
schema: | |
type: string | |
items: | |
$ref: '#/definitions/IP' | |
default: | |
description: Unexpected error | |
schema: | |
$ref: '#/definitions/Error' | |
definitions: | |
IP: | |
type: object | |
properties: | |
ip: | |
type: string | |
description: IP address. | |
Error: | |
type: object | |
properties: | |
code: | |
type: integer | |
format: int32 | |
message: | |
type: string | |
fields: | |
type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment