Icon

openapi_​generator_​draft

Pet store example

{

"openapi": "3.0.2",

"servers": [

{

"url": "/v3"

}

],

"info": {

"description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",

"version": "1.0.20-SNAPSHOT",

"title": "Swagger Petstore - OpenAPI 3.0",

"termsOfService": "http://swagger.io/terms/",

"contact": {

"email": "apiteam@swagger.io"

},

"license": {

"name": "Apache 2.0",

"url": "http://www.apache.org/licenses/LICENSE-2.0.html"

}

},

"tags": [

{

"name": "pet",

"description": "Everything about your Pets",

"externalDocs": {

"description": "Find out more",

"url": "http://swagger.io"

}

},

{

"name": "store",

"description": "Access to Petstore orders",

"externalDocs": {

"description": "Find out more about our store",

"url": "http://swagger.io"

}

},

{

"name": "user",

"description": "Operations about user"

}

],

"paths": {

"/pet": {

"post": {

"tags": [

"pet"

],

"summary": "Add a new pet to the store",

"description": "Add a new pet to the store",

"operationId": "addPet",

"responses": {

"200": {

"description": "Successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

}

},

"405": {

"description": "Invalid input"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

],

"requestBody": {

"description": "Create a new pet in the store",

"required": true,

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/x-www-form-urlencoded": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

}

}

},

"put": {

"tags": [

"pet"

],

"summary": "Update an existing pet",

"description": "Update an existing pet by Id",

"operationId": "updatePet",

"responses": {

"200": {

"description": "Successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

}

},

"400": {

"description": "Invalid ID supplied"

},

"404": {

"description": "Pet not found"

},

"405": {

"description": "Validation exception"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

],

"requestBody": {

"description": "Update an existent pet in the store",

"required": true,

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/x-www-form-urlencoded": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

}

}

}

},

"/pet/findByStatus": {

"get": {

"tags": [

"pet"

],

"summary": "Finds Pets by status",

"description": "Multiple status values can be provided with comma separated strings",

"operationId": "findPetsByStatus",

"parameters": [

{

"name": "status",

"in": "query",

"description": "Status values that need to be considered for filter",

"required": false,

"explode": true,

"schema": {

"type": "string",

"enum": [

"available",

"pending",

"sold"

],

"default": "available"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/xml": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Pet"

}

}

},

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Pet"

}

}

}

}

},

"400": {

"description": "Invalid status value"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

]

}

},

"/pet/findByTags": {

"get": {

"tags": [

"pet"

],

"summary": "Finds Pets by tags",

"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",

"operationId": "findPetsByTags",

"parameters": [

{

"name": "tags",

"in": "query",

"description": "Tags to filter by",

"required": false,

"explode": true,

"schema": {

"type": "array",

"items": {

"type": "string"

}

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/xml": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Pet"

}

}

},

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Pet"

}

}

}

}

},

"400": {

"description": "Invalid tag value"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

]

}

},

"/pet/{petId}": {

"get": {

"tags": [

"pet"

],

"summary": "Find pet by ID",

"description": "Returns a single pet",

"operationId": "getPetById",

"parameters": [

{

"name": "petId",

"in": "path",

"description": "ID of pet to return",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

}

},

"400": {

"description": "Invalid ID supplied"

},

"404": {

"description": "Pet not found"

}

},

"security": [

{

"api_key": [

]

},

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

]

},

"post": {

"tags": [

"pet"

],

"summary": "Updates a pet in the store with form data",

"description": "",

"operationId": "updatePetWithForm",

"parameters": [

{

"name": "petId",

"in": "path",

"description": "ID of pet that needs to be updated",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

},

{

"name": "name",

"in": "query",

"description": "Name of pet that needs to be updated",

"schema": {

"type": "string"

}

},

{

"name": "status",

"in": "query",

"description": "Status of pet that needs to be updated",

"schema": {

"type": "string"

}

}

],

"responses": {

"405": {

"description": "Invalid input"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

]

},

"delete": {

"tags": [

"pet"

],

"summary": "Deletes a pet",

"description": "",

"operationId": "deletePet",

"parameters": [

{

"name": "api_key",

"in": "header",

"description": "",

"required": false,

"schema": {

"type": "string"

}

},

{

"name": "petId",

"in": "path",

"description": "Pet id to delete",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

}

],

"responses": {

"400": {

"description": "Invalid pet value"

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

]

}

},

"/pet/{petId}/uploadImage": {

"post": {

"tags": [

"pet"

],

"summary": "uploads an image",

"description": "",

"operationId": "uploadFile",

"parameters": [

{

"name": "petId",

"in": "path",

"description": "ID of pet to update",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

},

{

"name": "additionalMetadata",

"in": "query",

"description": "Additional Metadata",

"required": false,

"schema": {

"type": "string"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApiResponse"

}

}

}

}

},

"security": [

{

"petstore_auth": [

"write:pets",

"read:pets"

]

}

],

"requestBody": {

"content": {

"application/octet-stream": {

"schema": {

"type": "string",

"format": "binary"

}

}

}

}

}

},

"/store/inventory": {

"get": {

"tags": [

"store"

],

"summary": "Returns pet inventories by status",

"description": "Returns a map of status codes to quantities",

"operationId": "getInventory",

"x-swagger-router-controller": "OrderController",

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/json": {

"schema": {

"type": "object",

"additionalProperties": {

"type": "integer",

"format": "int32"

}

}

}

}

}

},

"security": [

{

"api_key": [

]

}

]

}

},

"/store/order": {

"post": {

"tags": [

"store"

],

"summary": "Place an order for a pet",

"description": "Place a new order in the store",

"operationId": "placeOrder",

"x-swagger-router-controller": "OrderController",

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Order"

}

}

}

},

"405": {

"description": "Invalid input"

}

},

"requestBody": {

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Order"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Order"

}

},

"application/x-www-form-urlencoded": {

"schema": {

"$ref": "#/components/schemas/Order"

}

}

}

}

}

},

"/store/order/{orderId}": {

"get": {

"tags": [

"store"

],

"summary": "Find purchase order by ID",

"x-swagger-router-controller": "OrderController",

"description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.",

"operationId": "getOrderById",

"parameters": [

{

"name": "orderId",

"in": "path",

"description": "ID of order that needs to be fetched",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Order"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/Order"

}

}

}

},

"400": {

"description": "Invalid ID supplied"

},

"404": {

"description": "Order not found"

}

}

},

"delete": {

"tags": [

"store"

],

"summary": "Delete purchase order by ID",

"x-swagger-router-controller": "OrderController",

"description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",

"operationId": "deleteOrder",

"parameters": [

{

"name": "orderId",

"in": "path",

"description": "ID of the order that needs to be deleted",

"required": true,

"schema": {

"type": "integer",

"format": "int64"

}

}

],

"responses": {

"400": {

"description": "Invalid ID supplied"

},

"404": {

"description": "Order not found"

}

}

}

},

"/user": {

"post": {

"tags": [

"user"

],

"summary": "Create user",

"description": "This can only be done by the logged in user.",

"operationId": "createUser",

"responses": {

"default": {

"description": "successful operation",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/User"

}

}

}

}

},

"requestBody": {

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/x-www-form-urlencoded": {

"schema": {

"$ref": "#/components/schemas/User"

}

}

},

"description": "Created user object"

}

}

},

"/user/createWithList": {

"post": {

"tags": [

"user"

],

"summary": "Creates list of users with given input array",

"description": "Creates list of users with given input array",

"x-swagger-router-controller": "UserController",

"operationId": "createUsersWithListInput",

"responses": {

"200": {

"description": "Successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/User"

}

}

}

},

"default": {

"description": "successful operation"

}

},

"requestBody": {

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/User"

}

}

}

}

}

}

},

"/user/login": {

"get": {

"tags": [

"user"

],

"summary": "Logs user into the system",

"description": "",

"operationId": "loginUser",

"parameters": [

{

"name": "username",

"in": "query",

"description": "The user name for login",

"required": false,

"schema": {

"type": "string"

}

},

{

"name": "password",

"in": "query",

"description": "The password for login in clear text",

"required": false,

"schema": {

"type": "string"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"headers": {

"X-Rate-Limit": {

"description": "calls per hour allowed by the user",

"schema": {

"type": "integer",

"format": "int32"

}

},

"X-Expires-After": {

"description": "date in UTC when token expires",

"schema": {

"type": "string",

"format": "date-time"

}

}

},

"content": {

"application/xml": {

"schema": {

"type": "string"

}

},

"application/json": {

"schema": {

"type": "string"

}

}

}

},

"400": {

"description": "Invalid username/password supplied"

}

}

}

},

"/user/logout": {

"get": {

"tags": [

"user"

],

"summary": "Logs out current logged in user session",

"description": "",

"operationId": "logoutUser",

"parameters": [

],

"responses": {

"default": {

"description": "successful operation"

}

}

}

},

"/user/{username}": {

"get": {

"tags": [

"user"

],

"summary": "Get user by user name",

"description": "",

"operationId": "getUserByName",

"parameters": [

{

"name": "username",

"in": "path",

"description": "The name that needs to be fetched. Use user1 for testing. ",

"required": true,

"schema": {

"type": "string"

}

}

],

"responses": {

"200": {

"description": "successful operation",

"content": {

"application/xml": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/json": {

"schema": {

"$ref": "#/components/schemas/User"

}

}

}

},

"400": {

"description": "Invalid username supplied"

},

"404": {

"description": "User not found"

}

}

},

"put": {

"tags": [

"user"

],

"summary": "Update user",

"x-swagger-router-controller": "UserController",

"description": "This can only be done by the logged in user.",

"operationId": "updateUser",

"parameters": [

{

"name": "username",

"in": "path",

"description": "name that needs to be updated",

"required": true,

"schema": {

"type": "string"

}

}

],

"responses": {

"default": {

"description": "successful operation"

}

},

"requestBody": {

"description": "Update an existent user in the store",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/User"

}

},

"application/x-www-form-urlencoded": {

"schema": {

"$ref": "#/components/schemas/User"

}

}

}

}

},

"delete": {

"tags": [

"user"

],

"summary": "Delete user",

"description": "This can only be done by the logged in user.",

"operationId": "deleteUser",

"parameters": [

{

"name": "username",

"in": "path",

"description": "The name that needs to be deleted",

"required": true,

"schema": {

"type": "string"

}

}

],

"responses": {

"400": {

"description": "Invalid username supplied"

},

"404": {

"description": "User not found"

}

}

}

}

},

"externalDocs": {

"description": "Find out more about Swagger",

"url": "http://swagger.io"

},

"components": {

"schemas": {

"Order": {

"x-swagger-router-model": "io.swagger.petstore.model.Order",

"properties": {

"id": {

"type": "integer",

"format": "int64",

"example": 10

},

"petId": {

"type": "integer",

"format": "int64",

"example": 198772

},

"quantity": {

"type": "integer",

"format": "int32",

"example": 7

},

"shipDate": {

"type": "string",

"format": "date-time"

},

"status": {

"type": "string",

"description": "Order Status",

"enum": [

"placed",

"approved",

"delivered"

],

"example": "approved"

},

"complete": {

"type": "boolean"

}

},

"xml": {

"name": "order"

},

"type": "object"

},

"Customer": {

"properties": {

"id": {

"type": "integer",

"format": "int64",

"example": 100000

},

"username": {

"type": "string",

"example": "fehguy"

},

"address": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Address"

},

"xml": {

"wrapped": true,

"name": "addresses"

}

}

},

"xml": {

"name": "customer"

},

"type": "object"

},

"Address": {

"properties": {

"street": {

"type": "string",

"example": "437 Lytton"

},

"city": {

"type": "string",

"example": "Palo Alto"

},

"state": {

"type": "string",

"example": "CA"

},

"zip": {

"type": "string",

"example": 94301

}

},

"xml": {

"name": "address"

},

"type": "object"

},

"Category": {

"x-swagger-router-model": "io.swagger.petstore.model.Category",

"properties": {

"id": {

"type": "integer",

"format": "int64",

"example": 1

},

"name": {

"type": "string",

"example": "Dogs"

}

},

"xml": {

"name": "category"

},

"type": "object"

},

"User": {

"x-swagger-router-model": "io.swagger.petstore.model.User",

"properties": {

"id": {

"type": "integer",

"format": "int64",

"example": 10

},

"username": {

"type": "string",

"example": "theUser"

},

"firstName": {

"type": "string",

"example": "John"

},

"lastName": {

"type": "string",

"example": "James"

},

"email": {

"type": "string",

"example": "john@email.com"

},

"password": {

"type": "string",

"example": 12345

},

"phone": {

"type": "string",

"example": 12345

},

"userStatus": {

"type": "integer",

"format": "int32",

"example": 1,

"description": "User Status"

}

},

"xml": {

"name": "user"

},

"type": "object"

},

"Tag": {

"x-swagger-router-model": "io.swagger.petstore.model.Tag",

"properties": {

"id": {

"type": "integer",

"format": "int64"

},

"name": {

"type": "string"

}

},

"xml": {

"name": "tag"

},

"type": "object"

},

"Pet": {

"x-swagger-router-model": "io.swagger.petstore.model.Pet",

"required": [

"name",

"photoUrls"

],

"properties": {

"id": {

"type": "integer",

"format": "int64",

"example": 10

},

"name": {

"type": "string",

"example": "doggie"

},

"category": {

"$ref": "#/components/schemas/Category"

},

"photoUrls": {

"type": "array",

"xml": {

"wrapped": true

},

"items": {

"type": "string",

"xml": {

"name": "photoUrl"

}

}

},

"tags": {

"type": "array",

"xml": {

"wrapped": true

},

"items": {

"$ref": "#/components/schemas/Tag",

"xml": {

"name": "tag"

}

}

},

"status": {

"type": "string",

"description": "pet status in the store",

"enum": [

"available",

"pending",

"sold"

]

}

},

"xml": {

"name": "pet"

},

"type": "object"

},

"ApiResponse": {

"properties": {

"code": {

"type": "integer",

"format": "int32"

},

"type": {

"type": "string"

},

"message": {

"type": "string"

}

},

"xml": {

"name": "##default"

},

"type": "object"

}

},

"requestBodies": {

"Pet": {

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

},

"application/xml": {

"schema": {

"$ref": "#/components/schemas/Pet"

}

}

},

"description": "Pet object that needs to be added to the store"

},

"UserArray": {

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/User"

}

}

}

},

"description": "List of user object"

}

},

"securitySchemes": {

"petstore_auth": {

"type": "oauth2",

"flows": {

"implicit": {

"authorizationUrl": "https://petstore.swagger.io/oauth/authorize",

"scopes": {

"write:pets": "modify pets in your account",

"read:pets": "read your pets"

}

}

}

},

"api_key": {

"type": "apiKey",

"name": "api_key",

"in": "header"

}

}

}

}

disease.sh example

{ "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "disease.sh Docs - An open API for disease-related statistics", "description": "Third Party API for reliable global disease information", "license": { "name": "GNU V3", "url": "https://github.com/disease-sh/API/blob/master/LICENSE" } }, "schemes": [ "https", "http" ], "host": "disease.sh", "basePath": "/", "tags": [ { "name": "COVID-19: Worldometers", "description": "(COVID-19 data sourced from Worldometers, updated every 10 minutes)" }, { "name": "COVID-19: JHUCSSE", "description": "(COVID-19 data sourced from Johns Hopkins University, updated every 10 minutes)" }, { "name": "COVID-19: NYT", "description": "(COVID-19 data sourced from the New York Times, updated every 24 hours)" }, { "name": "COVID-19: Apple", "description": "(COVID-19 related mobility trend data from Apple, updated every 24 hours)" }, { "name": "COVID-19: Government", "description": "(COVID-19 individual government reported data, updated every 24 hours)" }, { "name": "COVID-19: Vaccine", "description": "(COVID-19 vaccine trial data from raps.org, updated every 24 hours)" }, { "name": "COVID-19: Therapeutics", "description": "(COVID-19 therapeutic trial data from raps.org, updated every 24 hours)" }, { "name": "COVID-19: Variants", "description": "(COVID-19 data from The European Surveillance System -TESSy, provided by [Austria, Belgium, Bulgaria, Croatia, Cyprus, Czechia, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain and Sweden] https://www.ecdc.europa.eu and released by ECDC updated every week)" }, { "name": "Influenza: CDC", "description": "(Influenza data reported by the United States CDC, updated every 24 hours)" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v3/covid-19/all": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get global COVID-19 totals for today, yesterday and two days ago", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidAll" } } } } } } }, "/v3/covid-19/states": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "sort", "in": "query", "enum": [ "cases", "todayCases", "deaths", "todayDeaths", "active" ], "description": "Provided a key (e.g. cases, todayCases, deaths, active), result will be sorted from greatest to least", "type": "string" }, { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for all US States", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidStates" } } } } } } }, "/v3/covid-19/states/{states}": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "states", "in": "path", "required": true, "description": "State name or comma separated names spelled correctly", "type": "string" }, { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for specific US State(s)", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidState" } } } } } } }, "/v3/covid-19/continents": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "sort", "in": "query", "enum": [ "cases", "todayCases", "deaths", "todayDeaths", "recovered", "active", "critical", "casesPerOneMillion", "deathsPerOneMillion" ], "description": "Provided a key (e.g. cases, todayCases, deaths, recovered, active), results will be sorted from greatest to least", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for all continents", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidContinents" } } } } } } }, "/v3/covid-19/continents/{continent}": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "continent", "in": "path", "required": true, "description": "Continent name", "type": "string" }, { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "strict", "in": "query", "enum": [ "true", "false" ], "default": "true", "description": "Setting to false gives you the ability to fuzzy search continents (i.e. Oman vs. rOMANia)", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for a specific continent", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidContinent" } } } } } } }, "/v3/covid-19/countries": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "sort", "in": "query", "enum": [ "cases", "todayCases", "deaths", "todayDeaths", "recovered", "active", "critical", "casesPerOneMillion", "deathsPerOneMillion" ], "description": "Provided a key (e.g. cases, todayCases, deaths, recovered, active), the result will be sorted from greatest to least", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for all countries", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidCountries" } } } } } } }, "/v3/covid-19/countries/{country}": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A country name, iso2, iso3, or country ID code", "type": "string" }, { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "strict", "in": "query", "enum": [ "true", "false" ], "default": "true", "description": "Setting to false gives you the ability to fuzzy search countries (i.e. Oman vs. rOMANia)", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for a specific country", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidCountry" } } } } } } }, "/v3/covid-19/countries/{countries}": { "get": { "tags": [ "COVID-19: Worldometers" ], "parameters": [ { "name": "countries", "in": "path", "required": true, "description": "Multiple country names, iso2, iso3, or country IDs separated by commas", "type": "string" }, { "name": "yesterday", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported a day ago", "type": "string" }, { "name": "twoDaysAgo", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "Queries data reported two days ago", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 totals for a specific set of countries", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidCountries" } } } } } } }, "/v3/covid-19/jhucsse": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "summary": "Get COVID-19 totals for all countries and their provinces", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidJHUCountries" } } } } } } }, "/v3/covid-19/jhucsse/counties": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "summary": "Get COVID-19 totals for all US counties", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidJHUCounties" } } } } } } }, "/v3/covid-19/jhucsse/counties/{county}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "county", "in": "path", "required": true, "description": "Name of any county in the USA. All counties are listed in the /v3/covid-19/jhucsse/counties/ endpoint", "type": "string" } ], "summary": "Get COVID-19 totals for a specific county", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidJHUCounties" } } } } } } }, "/v3/covid-19/historical": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for all countries and their provinces", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistorical" } } } } } } }, "/v3/covid-19/historical/all": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get global accumulated COVID-19 time series data", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalAll" } } } } } } }, "/v3/covid-19/historical/{country}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A country name, iso2, iso3, or country ID code", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a specific country", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalCountry" } } } } } } }, "/v3/covid-19/historical/{countries}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "countries", "in": "path", "required": true, "description": "Multiple country names, iso2, iso3, or country IDs separated by commas", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a specific set of countries", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalCountries" } } } } } } }, "/v3/covid-19/historical/{country}/{province}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A country name, iso2, iso3, or country ID code", "type": "string" }, { "name": "province", "in": "path", "required": true, "description": "Province name. All available names can be found in the /v3/covid-19/historical/{query} endpoint", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a specific province in a country", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalProvince" } } } } } } }, "/v3/covid-19/historical/{country}/{provinces}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A country name, iso2, iso3, or country ID code", "type": "string" }, { "name": "provinces", "in": "path", "required": true, "description": "Provinces spelled correctly separated by ',' or '|' delimiters, never both in the same query", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a set of provinces in a country", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalProvinces" } } } } } } }, "/v3/covid-19/historical/usacounties": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "summary": "Get all possible US States to query the /historical/usacounties/{state} endpoint with", "description": "Returns a list of US States and provinces", "responses": { "200": { "description": "Status OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalUSCounties" } } } } } } }, "/v3/covid-19/historical/usacounties/{state}": { "get": { "tags": [ "COVID-19: JHUCSSE" ], "parameters": [ { "name": "state", "in": "path", "required": true, "description": "US state name, validated in the array returned from the /v3/covid-19/historical/usacounties endpoint", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for all counties in a specified US state", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidHistoricalUSCounty" } } } } } } }, "/v3/covid-19/nyt/states": { "get": { "tags": [ "COVID-19: NYT" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for all states, with an entry for each day since the pandemic began", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidNYTState" } } } } } } }, "/v3/covid-19/nyt/states/{state}": { "get": { "tags": [ "COVID-19: NYT" ], "parameters": [ { "name": "state", "in": "path", "required": true, "description": "State name(s), separated by commas (e.g. 'Illinois, California')", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a state or set of states, with an entry for each day since the pandemic began", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidNYTState" } } } } } } }, "/v3/covid-19/nyt/counties": { "get": { "tags": [ "COVID-19: NYT" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for all available US counties, with an entry for each day since the pandemic began", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidNYTCounty" } } } } } } }, "/v3/covid-19/nyt/counties/{county}": { "get": { "tags": [ "COVID-19: NYT" ], "parameters": [ { "name": "county", "in": "path", "required": true, "description": "County name(s), separated by commas (e.g. 'Alameda, Humboldt')", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" } ], "summary": "Get COVID-19 time series data for a county or set of counties, with an entry for each day since the pandemic began", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidNYTCounty" } } } } } } }, "/v3/covid-19/nyt/usa": { "get": { "tags": [ "COVID-19: NYT" ], "summary": "Get COVID-19 time series data for the entire USA, with an entry for each day since the pandemic began", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidNYTUSA" } } } } } } }, "/v3/covid-19/apple/countries": { "get": { "tags": [ "COVID-19: Apple" ], "summary": "Get a list of supported countries for Apple mobility data", "description": "Returns a list of supported country names", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidAppleCountries" } } } } } } }, "/v3/covid-19/apple/countries/{country}": { "get": { "tags": [ "COVID-19: Apple" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A valid country name from the /v3/covid-19/apple/countries endpoint", "type": "string" } ], "summary": "Get a list of supported subregions for specific country in the Apple mobility data set", "description": "Returns a list of supported subregions in a country where data is available", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidAppleSubregions" } } } } } } }, "/v3/covid-19/apple/countries/{country}/{subregions}": { "get": { "tags": [ "COVID-19: Apple" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A valid country name from the /v3/covid-19/apple/countries endpoint", "type": "string" }, { "name": "subregions", "in": "path", "required": true, "description": "Valid subregion(s) from the /v3/covid-19/apple/countries/{country} endpoint, separated by with commas", "type": "string" } ], "summary": "Get COVID-19 Apple mobility data for subregions of a country", "description": "Returns a list of mobility data entries for subregion(s) every day since January 13th. Each entry has driving, transit, and walking data with an associated number of percentage change since January 13th", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidAppleData" } } } } } } }, "/v3/covid-19/gov/": { "get": { "tags": [ "COVID-19: Government" ], "summary": "Get a list of supported countries for government specific data", "description": "Returns a list of supported country names", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/covidGov" } } } } } } }, "/v3/covid-19/gov/{country}": { "get": { "tags": [ "COVID-19: Government" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A valid country name from the /v3/covid-19/gov endpoint", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 government reported data for a specific country", "responses": { "200": { "description": "Status Ok" } } } }, "/v3/covid-19/vaccine": { "get": { "tags": [ "COVID-19: Vaccine" ], "summary": "Get vaccine trial data from RAPS (Regulatory Affairs Professional Society). Specifically published by Jeff Craven at https://www.raps.org/news-and-articles/news-articles/2020/3/covid-19-vaccine-tracker", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccines" } } } } } } }, "/v3/covid-19/vaccine/coverage": { "get": { "tags": [ "COVID-19: Vaccine" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" }, { "name": "fullData", "in": "query", "default": "false", "description": "Flag indicating whether to return data type as simpleVaccineTimeline (false) or fullVaccineTimeline (true).", "type": "string" } ], "summary": "Get total global COVID-19 vaccine doses administered. Sourced from https://covid.ourworldindata.org/", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccineCoverage" }, "examples": { "simpleTimeline": { "$ref": "#/components/examples/simpleVaccineTimeline" }, "fullTimeline": { "$ref": "#/components/examples/fullVaccineTimeline" } } } } } } } }, "/v3/covid-19/vaccine/coverage/countries": { "get": { "tags": [ "COVID-19: Vaccine" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" }, { "name": "fullData", "in": "query", "default": "false", "description": "Flag indicating whether to return timeline data type as simpleVaccineTimeline (false) or fullVaccineTimeline (true).", "type": "string" } ], "summary": "Get COVID-19 vaccine doses administered for all countries that have reported rolling out vaccination. Sourced from https://covid.ourworldindata.org/", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccineCountriesCoverage" }, "examples": { "simpleTimeline": { "$ref": "#/components/examples/countriesSimpleVaccineTimeline" }, "fullTimeline": { "$ref": "#/components/examples/countriesFullVaccineTimeline" } } } } } } } }, "/v3/covid-19/vaccine/coverage/countries/{country}": { "get": { "tags": [ "COVID-19: Vaccine" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A valid country name, iso2, iso3", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" }, { "name": "fullData", "in": "query", "default": "false", "description": "Flag indicating whether to return timeline data type as simpleVaccineTimeline (false) or fullVaccineTimeline (true).", "type": "string" } ], "summary": "Get COVID-19 vaccine doses administered for a country that has reported vaccination rollout. Sourced from https://covid.ourworldindata.org/", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccineCountryCoverage" }, "examples": { "simpleTimeline": { "$ref": "#/components/examples/countrySimpleVaccineTimeline" }, "fullTimeline": { "$ref": "#/components/examples/countryFullVaccineTimeline" } } } } } } } }, "/v3/covid-19/vaccine/coverage/states": { "get": { "tags": [ "COVID-19: Vaccine" ], "parameters": [ { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" }, { "name": "fullData", "in": "query", "default": "false", "description": "Flag indicating whether to return timeline data type as simpleVaccineTimeline (false) or fullVaccineTimeline (true).", "type": "string" } ], "summary": "Get COVID-19 vaccine doses administered for all states that have reported rolling out vaccination. Sourced from https://covid.ourworldindata.org/", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccineStatesCoverage" }, "examples": { "simpleTimeline": { "$ref": "#/components/examples/statesSimpleVaccineTimeline" }, "fullTimeline": { "$ref": "#/components/examples/statesFullVaccineTimeline" } } } } } } } }, "/v3/covid-19/vaccine/coverage/states/{state}": { "get": { "tags": [ "COVID-19: Vaccine" ], "parameters": [ { "name": "state", "in": "path", "required": true, "description": "A valid state name", "type": "string" }, { "name": "lastdays", "in": "query", "default": 30, "description": "Number of days to return. Use 'all' for the full data set (e.g. 15, all, 24)", "type": "string" }, { "name": "fullData", "in": "query", "default": "false", "description": "Flag indicating whether to return timeline data type as simpleVaccineTimeline (false) or fullVaccineTimeline (true).", "type": "string" } ], "summary": "Get COVID-19 vaccine doses administered for a state that has reported vaccination rollout. Sourced from https://covid.ourworldindata.org/", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaccineStateCoverage" }, "examples": { "simpleTimeline": { "$ref": "#/components/examples/stateSimpleVaccineTimeline" }, "fullTimeline": { "$ref": "#/components/examples/stateFullVaccineTimeline" } } } } } } } }, "/v3/covid-19/therapeutics": { "get": { "tags": [ "COVID-19: Therapeutics" ], "summary": "Get therapeutics trial data from RAPS (Regulatory Affairs Professional Society). Specifically published by Jeff Craven at https://www.raps.org/news-and-articles/news-articles/2020/3/covid-19-therapeutics-tracker", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/therapeutics" } } } } } } }, "/v3/covid-19/variants/countries/": { "get": { "tags": [ "COVID-19: Variants" ], "summary": "Get a list of supported countries for ECDC specific data", "description": "Returns a list of supported country names", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variantsECDC" } } } } } } }, "/v3/covid-19/variants/countries/{country}": { "get": { "tags": [ "COVID-19: Variants" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "A valid country name from the /v3/covid-19/variants/countries/ endpoint", "type": "string" }, { "name": "allowNull", "in": "query", "enum": [ "true", "false", "1", "0" ], "description": "By default, if a value is missing, it is returned as 0. This allows nulls to be returned", "type": "string" } ], "summary": "Get COVID-19 ECDC reported data for a specific country", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variantsCountriesECDC" } } } } } } }, "/v3/influenza/cdc/ILINet": { "get": { "tags": [ "Influenza: CDC" ], "summary": "Get Influenza-like-illness data for the 2019 and 2020 outbreaks from the US Center for Disease Control", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/influenzaILINet" } } } } } } }, "/v3/influenza/cdc/USCL": { "get": { "tags": [ "Influenza: CDC" ], "summary": "Get Influenza report data for the 2019 and 2020 outbreaks from the US Center for Disease Control, reported by US clinical labs", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/influenzaUSCL" } } } } } } }, "/v3/influenza/cdc/USPHL": { "get": { "tags": [ "Influenza: CDC" ], "summary": "Get Influenza report data for the 2019 and 2020 outbreaks from the US Center for Disease Control, reported by US public health labs", "responses": { "200": { "description": "Status Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/influenzaUSPHL" } } } } } } } }, "components": { "schemas": { "covidAll": { "properties": { "updated": { "type": "number" }, "cases": { "type": "number" }, "todayCases": { "type": "number" }, "deaths": { "type": "number" }, "recovered": { "type": "number" }, "todayRecovered": { "type": "number" }, "active": { "type": "number" }, "critical": { "type": "number" }, "casesPerOneMillion": { "type": "number" }, "deathsPerOneMillion": { "type": "number" }, "tests": { "type": "number" }, "testsPerOneMillion": { "type": "number" }, "population": { "type": "number" }, "oneCasePerPeople": { "type": "number" }, "oneDeathPerPeople": { "type": "number" }, "oneTestPerPeople": { "type": "number" }, "activePerOneMillion": { "type": "number" }, "recoveredPerOneMillion": { "type": "number" }, "criticalPerOneMillion": { "type": "number" }, "affectedCountries": { "type": "number" } } }, "covidState": { "properties": { "state": { "type": "string" }, "updated": { "type": "number" }, "cases": { "type": "number" }, "todayCases": { "type": "number" }, "deaths": { "type": "number" }, "todayDeaths": { "type": "number" }, "active": { "type": "number" }, "casesPerOneMillion": { "type": "number" }, "deathsPerOneMillion": { "type": "number" }, "tests": { "type": "number" }, "testsPerOneMillion": { "type": "number" }, "population": { "type": "number" } } }, "covidStates": { "type": "array", "items": { "$ref": "#/components/schemas/covidState" } }, "covidContinent": { "properties": { "updated": { "type": "number" }, "cases": { "type": "number" }, "todayCases": { "type": "number" }, "deaths": { "type": "number" }, "todayDeaths": { "type": "number" }, "recovered": { "type": "number" }, "todayRecovered": { "type": "number" }, "active": { "type": "number" }, "critical": { "type": "number" }, "casesPerOneMillion": { "type": "number" }, "deathsPerOneMillion": { "type": "number" }, "tests": { "type": "number" }, "testsPerOneMillion": { "type": "number" }, "population": { "type": "number" }, "continent": { "type": "string" }, "activePerOneMillion": { "type": "number" }, "recoveredPerOneMillion": { "type": "number" }, "criticalPerOneMillion": { "type": "number" }, "continentInfo": { "type": "object", "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "countries": { "type": "array", "items": { "type": "string" } } } }, "covidContinents": { "type": "array", "items": { "$ref": "#/components/schemas/covidContinent" } }, "covidCountry": { "properties": { "updated": { "type": "number" }, "country": { "type": "string" }, "countryInfo": { "type": "object", "properties": { "_id": { "type": "number", "uniqueItems": true }, "iso2": { "type": "string", "uniqueItems": true }, "iso3": { "type": "string", "uniqueItems": true }, "lat": { "type": "number" }, "long": { "type": "number" }, "flag": { "type": "string" } } }, "cases": { "type": "number" }, "todayCases": { "type": "number" }, "deaths": { "type": "number" }, "todayDeaths": { "type": "number" }, "recovered": { "type": "number" }, "todayRecovered": { "type": "number" }, "active": { "type": "number" }, "critical": { "type": "number" }, "casesPerOneMillion": { "type": "number" }, "deathsPerOneMillion": { "type": "number" }, "tests": { "type": "number" }, "testsPerOneMillion": { "type": "number" }, "population": { "type": "number" }, "continent": { "type": "number" }, "oneCasePerPeople": { "type": "number" }, "oneDeathPerPeople": { "type": "number" }, "oneTestPerPeople": { "type": "number" }, "activePerOneMillion": { "type": "number" }, "recoveredPerOneMillion": { "type": "number" }, "criticalPerOneMillion": { "type": "number" } } }, "covidCountries": { "type": "array", "items": { "$ref": "#/components/schemas/covidCountry" } }, "covidJHUCountries": { "properties": { "country": { "type": "string" }, "county": { "type": "string" }, "updatedAt": { "type": "string" }, "stats": { "type": "object", "properties": { "confirmed": { "type": "number" }, "deaths": { "type": "number" }, "recovered": { "type": "number" } } }, "coordinates": { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } } }, "province": { "type": "string" } } }, "covidJHUCounty": { "properties": { "country": { "type": "string" }, "province": { "type": "string" }, "county": { "type": "string" }, "updatedAt": { "type": "string" }, "stats": { "type": "object", "properties": { "confirmed": { "type": "number" }, "deaths": { "type": "number" }, "recovered": { "type": "number" } } }, "coordinates": { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } } } } }, "covidJHUCounties": { "type": "array", "items": { "$ref": "#/components/schemas/covidJHUCounty" } }, "covidHistorical": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "province": { "type": "string" }, "timeline": { "type": "object", "description": "The amount of key-value pairs in 'cases', 'deaths' and 'recovered' is dependent on the 'lastdays' query", "properties": { "cases": { "type": "object", "properties": { "date": { "type": "number" } } }, "deaths": { "type": "object", "properties": { "date": { "type": "number" } } }, "recovered": { "type": "object", "properties": { "date": { "type": "number" } } } } } } } }, "covidHistoricalAll": { "description": "The amount of key-value pairs in 'cases', 'deaths' and 'recovered' is dependent on the 'lastdays' query", "properties": { "cases": { "type": "object", "properties": { "date": { "type": "number" } } }, "deaths": { "type": "object", "properties": { "date": { "type": "number" } } }, "recovered": { "type": "object", "properties": { "date": { "type": "number" } } } } }, "covidHistoricalCountry": { "properties": { "country": { "type": "string" }, "province": { "type": "array", "items": { "type": "string" } }, "timeline": { "type": "object", "description": "The amount of key-value pairs in 'cases', 'deaths' and 'recovered' is dependent on the 'lastdays' query", "properties": { "cases": { "type": "object", "properties": { "date": { "type": "number" } } }, "deaths": { "type": "object", "properties": { "date": { "type": "number" } } }, "recovered": { "type": "object", "properties": { "date": { "type": "number" } } } } } } }, "covidHistoricalCountries": { "type": "array", "items": { "$ref": "#/components/schemas/covidHistoricalCountry" } }, "covidHistoricalUSCounties": { "type": "array", "items": { "type": "string" } }, "covidHistoricalUSCounty": { "type": "array", "items": { "type": "object", "properties": { "province": { "type": "string" }, "county": { "type": "string" }, "timeline": { "type": "object", "description": "The amount of key-value pairs in 'cases', 'deaths' and 'recovered' is dependent on the 'lastdays' query", "properties": { "cases": { "type": "object", "properties": { "date": { "type": "number" } } }, "deaths": { "type": "object", "properties": { "date": { "type": "number" } } }, "recovered": { "type": "object", "properties": { "date": { "type": "number" } } } } } } } }, "covidHistoricalProvince": { "properties": { "country": { "type": "string" }, "province": { "type": "string" }, "timeline": { "type": "object", "description": "The amount of key-value pairs in 'cases', 'deaths' and 'recovered' is dependent on the 'lastdays' query", "properties": { "cases": { "type": "object", "properties": { "date": { "type": "number" } } }, "deaths": { "type": "object", "properties": { "date": { "type": "number" } } }, "recovered": { "type": "object", "properties": { "date": { "type": "number" } } } } } } }, "covidHistoricalProvinces": { "type": "array", "items": { "$ref": "#/components/schemas/covidHistoricalProvince" } }, "covidNYTState": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "state": { "type": "string" }, "fips": { "type": "string" }, "cases": { "type": "number" }, "deaths": { "type": "number" } } } }, "covidNYTCounty": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "county": { "type": "string" }, "state": { "type": "string" }, "fips": { "type": "string" }, "cases": { "type": "number" }, "deaths": { "type": "number" } } } }, "covidNYTUSA": { "type": "array", "items": { "properties": { "date": { "type": "string", "format": "date" }, "cases": { "type": "number" }, "deaths": { "type": "number" } } } }, "covidAppleCountries": { "type": "array", "items": { "type": "string" } }, "covidAppleSubregions": { "properties": { "country": { "type": "string" }, "subregions": { "type": "array", "items": { "type": "string" } } } }, "covidAppleData": { "properties": { "country": { "type": "string" }, "subregion": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "sub-region": { "type": "string" }, "subregion_and_city": { "type": "string" }, "geo_type": { "type": "string" }, "date": { "type": "string", "format": "date" }, "driving": { "type": "number" }, "transit": { "type": "number" }, "walking": { "type": "number" } } } } } }, "covidGov": { "type": "array", "items": { "type": "string" } }, "influenzaILINet": { "properties": { "updated": { "type": "number" }, "source": { "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/ILINet" } } } }, "ILINet": { "properties": { "week": { "type": "string" }, "age 5-24": { "type": "number" }, "age 25-49": { "type": "number" }, "age 50-64": { "type": "number" }, "age 64+": { "type": "number" }, "totalILI": { "type": "number" }, "totalPatients": { "type": "number" }, "percentUnweightedILI": { "type": "number" }, "percentWeightedILI": { "type": "number" } } }, "influenzaUSCL": { "properties": { "updated": { "type": "number" }, "source": { "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/USCL" } } } }, "USCL": { "properties": { "week": { "type": "string" }, "totalA": { "type": "number" }, "totalB": { "type": "number" }, "percentPositiveA": { "type": "number" }, "percentPositiveB": { "type": "number" }, "totalTests": { "type": "number" }, "percentPositive": { "type": "number" } } }, "vaccines": { "properties": { "source": { "type": "string" }, "totalCandidates": { "type": "string" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/phases" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/vaccine" } } } }, "vaccine": { "properties": { "candidate": { "type": "string" }, "mechanism": { "type": "string" }, "sponsors": { "type": "array", "items": { "type": "string" } }, "details": { "type": "string" }, "trialPhase": { "type": "string" }, "institutions": { "type": "array", "items": { "type": "string" } } } }, "phases": { "properties": { "phase": { "type": "string" }, "candidates": { "type": "string" } } }, "vaccineCoverage":{ "oneOf": [ { "$ref": "#/components/schemas/simpleVaccineTimeline" }, { "$ref": "#/components/schemas/fullVaccineTimeline" } ] }, "vaccineCountriesCoverage":{ "type":"array", "items":{ "$ref": "#/components/schemas/vaccineCountryCoverage" } }, "vaccineCountryCoverage":{ "type":"object", "properties":{ "country":{ "type":"string" }, "timeline":{ "oneOf": [ { "$ref": "#/components/schemas/simpleVaccineTimeline" }, { "$ref": "#/components/schemas/fullVaccineTimeline" } ] } } }, "vaccineStatesCoverage": { "type": "array", "items": { "$ref": "#/components/schemas/vaccineStateCoverage" } }, "vaccineStateCoverage":{ "type":"object", "properties":{ "state":{ "type":"string" }, "timeline":{ "oneOf": [ { "$ref": "#/components/schemas/simpleVaccineTimeline" }, { "$ref": "#/components/schemas/fullVaccineTimeline" } ] } } }, "simpleVaccineTimeline": { "type":"object", "properties":{ "date":{ "type":"number" } } }, "fullVaccineTimeline": { "type": "array", "items": { "type": "object", "properties": { "total": { "type": "number" }, "daily": { "type": "number" }, "totalPerHundred": { "type": "number" }, "dailyPerMillion": { "type": "number" }, "date": { "type": "string" } } } }, "therapeutics": { "properties": { "source": { "type": "string" }, "totalCandidates": { "type": "string" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/phases" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/therapeutic" } } } }, "therapeutic": { "properties": { "medicationClass": { "type": "string" }, "tradeName": { "type": "array", "items": { "type": "string" } }, "details": { "type": "string" }, "developerResearcher": { "type": "array", "items": { "type": "string" } }, "sponsors": { "type": "array", "items": { "type": "string" } }, "trialPhase": { "type": "string" }, "lastUpdate": { "type": "string" } } }, "variantsECDC": { "type": "array", "items": { "type": "string" } }, "variantsCountriesECDC": { "type": "array", "items": { "type": "object", "properties": { "updated": { "type": "number", "format": "date" }, "country": { "type": "string" }, "yearWeek": { "type": "string" }, "source": { "type": "string" }, "newCases": { "type": "number" }, "numberSequenced": { "type": "number" }, "percentSequenced": { "type": "number" }, "validDenominator": { "type": "string" }, "variant": { "type": "string" }, "numberDetectionsVariant": { "type": "number" }, "numberSequencedKnownVariant": { "type": "number" }, "percentVariant": { "type": "number" } } } }, "influenzaUSPHL": { "properties": { "updated": { "type": "number" }, "source": { "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/USPHL" } } } }, "USPHL": { "properties": { "week": { "type": "string" }, "A(H3N2v)": { "type": "number" }, "A(H1N1)": { "type": "number" }, "A(H3)": { "type": "number" }, "A(unable to sub-type)+": { "type": "number" }, "A(Subtyping not performed)": { "type": "number" }, "B": { "type": "number" }, "BVIC": { "type": "number" }, "totalTests": { "type": "number" } } } }, "examples": { "countriesSimpleVaccineTimeline": { "value": [ { "country": "USA", "timeline": { "4/25/2021": 1000 } } ], "summary": "Simple Vaccine Timeline" }, "countriesFullVaccineTimeline": { "value": [ { "country": "USA", "timeline": [ { "total": 1000, "daily": 1000, "totalPerHundred": 1000, "dailyPerMillion": 1000, "date": "4/25/2021" } ] } ], "summary": "Full Vaccine Timeline" }, "countrySimpleVaccineTimeline": { "value": { "country": "USA", "timeline": { "4/25/2021": 1000 } }, "summary": "Simple Vaccine Timeline" }, "countryFullVaccineTimeline": { "value": { "country": "USA", "timeline": [ { "total": 1000, "daily": 1000, "totalPerHundred": 1000, "dailyPerMillion": 1000, "date": "4/25/2021" } ] }, "summary": "Full Vaccine Timeline" }, "statesSimpleVaccineTimeline": { "value": [ { "state": "California", "timeline": { "4/25/2021": 1000 } } ], "summary": "Simple Vaccine Timeline" }, "statesFullVaccineTimeline": { "value": [ { "state": "California", "timeline": [ { "total": 1000, "daily": 1000, "totalPerHundred": 1000, "dailyPerMillion": 1000, "date": "4/25/2021" } ] } ], "summary": "Full Vaccine Timeline" }, "stateSimpleVaccineTimeline": { "value": { "state": "California", "timeline": { "4/25/2021": 1000 } }, "summary": "Simple Vaccine Timeline" }, "stateFullVaccineTimeline": { "value": { "state": "California", "timeline": [ { "total": 1000, "daily": 1000, "totalPerHundred": 1000, "dailyPerMillion": 1000, "date": "4/25/2021" } ] }, "summary": "Full Vaccine Timeline" }, "simpleVaccineTimeline": { "value": { "4/25/2021": 1000 }, "summary": "Simple Vaccine Timeline" }, "fullVaccineTimeline": { "value": [ { "total": 1000, "daily": 1000, "totalPerHundred": 1000, "dailyPerMillion": 1000, "date": "4/25/2021" } ], "summary": "Full Vaccine Timeline" } } }, "externalDocs": { "description": "Find out more about this API", "url": "https://github.com/disease-sh/API" } }

OpenAPI componentgenerator
OpenAPI

Nodes

Extensions

Links