GitHub Raw JSON API

Kilo-Org / kilocode

26,837 TypeScript

Kilo is the all-in-one agentic engineering platform. Build, ship, and iterate faster with the most popular open source coding agent.

CodeMode Happy Path Specification

Located in packages/codemode/test/fixtures/openapi-happy-path.json on branch HEAD

3.1.0 JSON 3 Endpoints 4.9 KB

Operations & Route Endpoints (4)

GET /users/{userId}
Get a user
DELETE /users/{userId}
Remove a user
POST /users
Create a user
GET /search
Search users
Raw JSON Specification
{
  "openapi": "3.1.0",
  "info": {
    "title": "CodeMode Happy Path",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.example.test/v1"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/users/{userId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/UserId"
        }
      ],
      "get": {
        "operationId": "users.get",
        "summary": "Get a user",
        "parameters": [
          {
            "name": "include",
            "in": "query",
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "verbose",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "X-Trace-ID",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/UserResponse"
          }
        }
      },
      "delete": {
        "operationId": "users.remove",
        "summary": "Remove a user",
        "responses": {
          "204": {
            "description": "Removed"
          }
        }
      }
    },
    "/users": {
      "post": {
        "operationId": "users.create",
        "summary": "Create a user",
        "security": [
          {
            "ApiKey": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "role": {
                    "type": "string",
                    "enum": [
                      "admin",
                      "member"
                    ]
                  }
                },
                "required": [
                  "name",
                  "email"
                ],
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/vnd.example+json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        }
      }
    },
    "/search": {
      "get": {
        "operationId": "search.run",
        "summary": "Search users",
        "security": [],
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "properties": {
                "query": {
                  "type": "string"
                },
                "page": {
                  "type": "integer"
                }
              },
              "required": [
                "query"
              ],
              "additionalProperties": false
            }
          },
          {
            "name": "tags",
            "in": "query",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Summary",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "UserId": {
        "name": "userId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "UserResponse": {
        "description": "A user",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/User"
            }
          }
        }
      }
    },
    "schemas": {
      "User": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "role": {
            "type": "string",
            "enum": [
              "admin",
              "member"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "email"
        ],
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      },
      "ApiKey": {
        "type": "apiKey",
        "in": "query",
        "name": "api_key"
      }
    }
  }
}