openapi.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "rororo",
    "version": "2.4.0",
    "contact": {
      "name": "Igor Davydenko (developer)",
      "url": "https://igordavydenko.com",
      "email": "iam@igordavydenko.com"
    },
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://opensource.org/licenses/BSD-3-Clause"
    }
  },
  "servers": [
    {
      "url": "/api",
      "x-rororo-level": "test"
    },
    {
      "url": "/dev-api",
      "x-rororo-level": ["dev"]
    }
  ],
  "paths": {
    "/hello": {
      "get": {
        "operationId": "hello_world",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1
            }
          },
          {
            "name": "email",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "email"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Dummy response.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "minLength": 1
                    },
                    "email": {
                      "type": "string",
                      "format": "email"
                    }
                  },
                  "required": ["message", "email"]
                }
              }
            }
          }
        }
      }
    },
    "/array": {
      "post": {
        "operationId": "retrieve_array_from_request_body",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UniqueStrArray"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Array from request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UniqueStrArray"
                }
              }
            }
          }
        }
      }
    },
    "/create-post": {
      "post": {
        "operationId": "create-post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPost"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created post content.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Post"
                }
              }
            }
          }
        }
      }
    },
    "/download.zip": {
      "get": {
        "operationId": "retrieve_zip",
        "responses": {
          "200": {
            "description": "ZIP file content.",
            "content": {
              "application/zip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    },
    "/empty": {
      "get": {
        "operationId": "retrieve_empty",
        "responses": {
          "204": {
            "description": "Empty response."
          }
        },
        "security": [
          {},
          {"apiKey": []}
        ]
      }
    },
    "/invalid-response": {
      "get": {
        "operationId": "retrieve_invalid_response",
        "responses": {
          "200": {
            "description": "Expected response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NestedObject"
                }
              }
            }
          }
        }
      }
    },
    "/nested-object": {
      "post": {
        "operationId": "retrieve_nested_object_from_request_body",

        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NestedObject"
              }
            }
          }
        },

        "responses": {
          "200": {
            "description": "Nested object from request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NestedObject"
                }
              }
            },
            "headers": {
              "X-Content-Data-Type": {
                "schema": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "X-UID-Data-Type": {
                "schema": {
                  "type": "string",
                  "minLength": 1
                }
              }
            }
          }
        }
      }
    },
    "/any-object": {
      "post": {
        "operationId": "retrieve_any_object_from_request_body",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AnyObject"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Free form object from request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AnyObject"
                }
              }
            }
          }
        }
      }
    },
    "/posts/{post_id}": {
      "get": {
        "operationId": "retrieve_post",
        "parameters": [
          {
            "$ref": "#/components/parameters/PostID"
          }
        ],
        "responses": {
          "200": {
            "description": "Post details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AnyObject"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AnyObject"
                }
              }
            }
          }
        }
      }
    },
    "/upload-image": {
      "post": {
        "operationId": "upload_image",
        "requestBody": {
          "content": {
            "image/*": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Uploaded image",
            "content": {
              "image/*": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    },
    "/upload-text": {
      "post": {
        "operationId": "upload_text",
        "requestBody": {
          "content": {
            "text/plain": {
              "schema": {
                "type": "string"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Uploaded text",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "PostID": {
        "name": "post_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1
        }
      }
    },

    "schemas": {
      "AnyObject": {
        "type": "object",
        "additionalProperties": true
      },

      "UniqueStrArray": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1
        },
        "minItems": 1,
        "uniqueItems": true
      },

      "NestedObjectDataItem": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "enum": ["value1", "value2", "value3"]
          }
        },
        "required": ["key"]
      },

      "NestedObjectData": {
        "type": "object",
        "properties": {
          "data_item": {
            "$ref": "#/components/schemas/NestedObjectDataItem"
          },
          "data_items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NestedObjectDataItem"
            }
          },
          "str_items": {
            "$ref": "#/components/schemas/UniqueStrArray"
          }
        },
        "required": ["data_item", "data_items", "str_items"]
      },

      "NestedObject": {
        "type": "object",
        "properties": {
          "uid": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "data": {
            "$ref": "#/components/schemas/NestedObjectData"
          },
          "any_data": {
            "$ref": "#/components/schemas/AnyObject"
          }
        },
        "required": ["uid", "type", "data", "any_data"]
      },

      "NewPost": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "minLength": 1
          },
          "slug": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "minLength": 1
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "nullable": true
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": ["title", "slug", "content", "published_at"]
      },

      "Post": {
        "allOf": [
          {"$ref": "#/components/schemas/NewPost"},
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int64",
                "minimum": 0
              }
            },
            "required": ["id"]
          }
        ]
      }
    },

    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}