Try Delimit

See how breaking API changes get caught -- in 60 seconds.

Healthy API

Here is an API

This is the TaskForge API -- a simple task management service with 3 endpoints. Everything looks good.

openapi.yaml

openapi: "3.0.3"
info:
  title: TaskForge API
  version: "1.0.0"
paths:
  /tasks:
    get:
      summary: List all tasks
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    title:
                      type: string
                    status:
                      type: string
  /tasks/{id}:
    get:
      summary: Get task by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  title:
                    type: string
                  status:
                    type: string
  /tasks/{id}/comments:
    get:
      summary: List comments on a task
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    body:
                      type: string
                    author:
                      type: string

Endpoints

v1.0.0

Version

Issues