openapi-suite/openapi.json at master · lscalese/openapi-suite · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
{
  "openapi": "3.0.3",
  "info": {
    "title": "Swagger Generator for Objectscript",
    "description": "This an api to generate ObjectScript code from a OpenAPI specification.  It allows to generate interoperability client, simple HTTP client or the server-side REST application.",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "email": "lorenzo.scalese@gmail.com"
    },
    "license": {
      "name": "MIT License",
      "url": "https://github.com/lscalese/openapi-server-gen/blob/master/LICENSE"
    },
    "version": "1"
  },
  "externalDocs": {
    "description": "Find out OpenAPI suite on Intersystems developer community",
    "url": "https://community.intersystems.com/"
  },
  "servers": [
    {
      "url": "http://localhost:52796/openapisuite/api/v1"
    }
  ],
  "paths": {
    "/generate": {
      "post": {
        "summary": "Generate code for download purpose.",
        "description": "",
        "operationId": "generateCode",
        "parameters": [
          {
            "name": "packageName",
            "in": "query",
            "description": "package name of the generated classes.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "Type of generation possible value are : client, production or rest.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "text/plain": {
              "schema": {
                "type": "string",
                "example": "https://petstore3.swagger.io/api/v3/openapi.json"
              }
            },
            "application/json": {
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation.  The generated code is returned in XML format.",
            "content": {
              "application/xml": {}
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "405": {
            "description": "Validation exception"
          }
        }
      }
    },
    "/install": {
      "post": {
        "summary": "Generate code and compile on the server.",
        "description": "",
        "operationId": "generateAndInstall",
        "parameters": [
          {
            "name": "packageName",
            "in": "query",
            "description": "package name of the generated classes.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "Type of generation possible value are : client, production or rest.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "namespace",
            "in": "query",
            "description": "Namespace to install the generated code.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webApplicationName",
            "in": "query",
            "description": "WebApplication name to create, if empty web application won't be created.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "text/plain": {
              "schema": {
                "type": "string",
                "example": "https://petstore3.swagger.io/api/v3/openapi.json"
              }
            },
            "application/json": {
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Check the import status object for more information about the generation and compile process.",
            "content": {
              "application/json": {
                "schema" : {
                  "$ref" : "#/components/schemas/ImportStatus"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "405": {
            "description": "Validation exception"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ImportStatus": {
        "type": "object",
        "properties": {
          "generatetStatus": {
            "type": "boolean"
          },
          "compileStatus": {
            "type": "boolean"
          },
          "logs": {
            "type": "string"
          }
        }
      }
    }
  }
}