spy.templates.swagger.json Maven / Gradle / Ivy
The newest version!
{
"openapi": "3.0.0",
"servers": [
{
"url": "{{apiURL}}"
}
],
"info": {
"title": "{{title}} API",
"description": "spy service",
"termsOfService": "{{baseURL}}/txt/TERMS-OF-SERVICE.txt",
"version": "1.1.0",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "{{baseURL}}/txt/LICENSE-2.0.txt"
}
},
"paths": {
"/info": {
"get": {
"summary": "General information about the service",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Info"
}
}
}
}
}
}
},
"/myip": {
"get": {
"summary": "Get my ip address",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/myclient": {
"get": {
"summary": "Get various information about my http client",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientInfo"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Info": {
"type": "object",
"properties": {
"instanceUUID": {
"type": "string",
"format": "UUID",
"description": "This instance unique identifier, always updated on (re)start"
},
"startedOn": {
"type": "string",
"format": "date-time",
"description": "Last date time when this {{appcode}} instance has been (re)started"
},
"version": {
"type": "string",
"description": "{{appcode}} software version"
},
"buildDate": {
"type": "string",
"format": "date-time",
"description": "{{appcode}} software build date"
}
}
},
"ClientInfo": {
"type": "object",
"properties": {
"clientIP": {
"type": "string",
"description": "your IP address"
},
"userAgent": {
"type": "string",
"description": "your user agent information given to the server"
}
}
}
}
}
}