next-openapi-gen/apps/react-router-app/next.openapi.json at main · tazo90/next-openapi-gen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "openapi": "3.0.0",
  "info": {
    "title": "React Router API",
    "version": "1.0.0",
    "description": "OpenAPI document generated from React Router route modules."
  },
  "framework": {
    "kind": "react-router"
  },
  "defaultResponseSet": "common",
  "responseSets": {
    "common": ["400", "500"],
    "auth": ["401", "403"]
  },
  "errorConfig": {
    "template": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "example": "{{ERROR_MESSAGE}}"
        }
      }
    },
    "codes": {
      "400": {
        "description": "Bad Request",
        "variables": {
          "ERROR_MESSAGE": "Invalid request"
        }
      },
      "401": {
        "description": "Unauthorized",
        "variables": {
          "ERROR_MESSAGE": "Authentication required"
        }
      },
      "403": {
        "description": "Forbidden",
        "variables": {
          "ERROR_MESSAGE": "Access denied"
        }
      },
      "500": {
        "description": "Internal Server Error",
        "variables": {
          "ERROR_MESSAGE": "Unexpected error"
        }
      }
    }
  },
  "apiDir": "./src/routes/api",
  "schemaDir": "./src",
  "schemaType": "typescript",
  "docsUrl": "api-docs",
  "ui": "scalar",
  "outputDir": "./public",
  "outputFile": "openapi.json",
  "includeOpenApiRoutes": true,
  "debug": false
}