-
Notifications
You must be signed in to change notification settings - Fork 0
/
original-oapi-contract.json
1 lines (1 loc) · 10.7 KB
/
original-oapi-contract.json
1
{"swagger":"2.0","info":{"description":"This is an online openapi generator server. You can find out more at https://github.com/OpenAPITools/openapi-generator.","version":"4.2.3","title":"OpenAPI Generator Online","contact":{},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}},"host":"localhost:8080","basePath":"/","tags":[{"name":"gen-api-controller","description":"the gen API"}],"paths":{"/api/gen/clients":{"get":{"tags":["clients"],"summary":"Gets languages supported by the client generator","operationId":"clientOptions","produces":["*/*"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}},"responseSchema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/gen/clients/{language}":{"get":{"tags":["clients"],"summary":"Returns options for a client library","operationId":"getClientOptions","produces":["application/json"],"parameters":[{"name":"language","in":"path","description":"The target language for the client library","required":true,"type":"string","enum":["ada","android","apex","asciidoc","bash","c","clojure","cpp-qt5-client","cpp-restsdk","cpp-tizen","csharp","csharp-dotnet2","csharp-netcore","cwiki","dart","dart-dio","dart-jaguar","dynamic-html","eiffel","elixir","elm","erlang-client","erlang-proper","flash","go","go-experimental","groovy","haskell-http-client","html","html2","java","javascript","javascript-closure-angular","javascript-flowtyped","jaxrs-cxf-client","jmeter","kotlin","lua","markdown","nim","objc","ocaml","openapi","openapi-yaml","perl","php","powershell","python","python-experimental","r","ruby","rust","scala-akka","scala-gatling","scala-httpclient-deprecated","scalaz","swift2-deprecated","swift3-deprecated","swift4","swift5","typescript-angular","typescript-angularjs","typescript-aurelia","typescript-axios","typescript-fetch","typescript-inversify","typescript-jquery","typescript-node","typescript-redux-query","typescript-rxjs"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/CliOption","originalRef":"CliOption"}},"responseSchema":{"type":"object","additionalProperties":{"$ref":"#/definitions/CliOption","originalRef":"CliOption"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["clients"],"summary":"Generates a client library","description":"Accepts a `GeneratorInput` options map for spec location and generation options","operationId":"generateClient","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"language","in":"path","description":"The target language for the client library","required":true,"type":"string","enum":["ada","android","apex","asciidoc","bash","c","clojure","cpp-qt5-client","cpp-restsdk","cpp-tizen","csharp","csharp-dotnet2","csharp-netcore","cwiki","dart","dart-dio","dart-jaguar","dynamic-html","eiffel","elixir","elm","erlang-client","erlang-proper","flash","go","go-experimental","groovy","haskell-http-client","html","html2","java","javascript","javascript-closure-angular","javascript-flowtyped","jaxrs-cxf-client","jmeter","kotlin","lua","markdown","nim","objc","ocaml","openapi","openapi-yaml","perl","php","powershell","python","python-experimental","r","ruby","rust","scala-akka","scala-gatling","scala-httpclient-deprecated","scalaz","swift2-deprecated","swift3-deprecated","swift4","swift5","typescript-angular","typescript-angularjs","typescript-aurelia","typescript-axios","typescript-fetch","typescript-inversify","typescript-jquery","typescript-node","typescript-redux-query","typescript-rxjs"]},{"in":"body","name":"generatorInput","description":"Configuration for building the client library","required":true,"schema":{"$ref":"#/definitions/GeneratorInput","originalRef":"GeneratorInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseCode","originalRef":"ResponseCode"},"responseSchema":{"$ref":"#/definitions/ResponseCode","originalRef":"ResponseCode"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/gen/download/{fileId}":{"get":{"tags":["clients","servers"],"summary":"Downloads a pre-generated file","description":"A valid `fileId` is generated by the `/clients/{language}` or `/servers/{language}` POST operations. The fileId code can be used just once, after which a new `fileId` will need to be requested.","operationId":"downloadFile","produces":["application/octet-stream"],"parameters":[{"name":"fileId","in":"path","description":"fileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"file"},"responseSchema":{"type":"file"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/gen/servers":{"get":{"tags":["servers"],"summary":"Gets languages supported by the server generator","operationId":"serverOptions","produces":["*/*"],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}},"responseSchema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/gen/servers/{framework}":{"get":{"tags":["servers"],"summary":"Returns options for a server framework","operationId":"getServerOptions","produces":["application/json"],"parameters":[{"name":"framework","in":"path","description":"The target language for the server framework","required":true,"type":"string","enum":["ada-server","aspnetcore","cpp-pistache-server","cpp-qt5-qhttpengine-server","cpp-restbed-server","csharp-nancyfx","erlang-server","fsharp-functions","fsharp-giraffe-server","go-gin-server","go-server","graphql-nodejs-express-server","haskell","java-inflector","java-msf4j","java-pkmst","java-play-framework","java-undertow-server","java-vertx","java-vertx-web","jaxrs-cxf","jaxrs-cxf-cdi","jaxrs-cxf-extended","jaxrs-jersey","jaxrs-resteasy","jaxrs-resteasy-eap","jaxrs-spec","kotlin-server","kotlin-spring","kotlin-vertx","nodejs-express-server","nodejs-server-deprecated","php-laravel","php-lumen","php-silex","php-slim-deprecated","php-slim4","php-symfony","php-ze-ph","python-aiohttp","python-blueplanet","python-flask","ruby-on-rails","ruby-sinatra","rust-server","scala-finch","scala-lagom-server","scala-play-server","scalatra","spring"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/CliOption","originalRef":"CliOption"}},"responseSchema":{"type":"object","additionalProperties":{"$ref":"#/definitions/CliOption","originalRef":"CliOption"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["servers"],"summary":"Generates a server library","description":"Accepts a `GeneratorInput` options map for spec location and generation options.","operationId":"generateServerForLanguage","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"framework","in":"path","description":"framework","required":true,"type":"string","enum":["ada-server","aspnetcore","cpp-pistache-server","cpp-qt5-qhttpengine-server","cpp-restbed-server","csharp-nancyfx","erlang-server","fsharp-functions","fsharp-giraffe-server","go-gin-server","go-server","graphql-nodejs-express-server","haskell","java-inflector","java-msf4j","java-pkmst","java-play-framework","java-undertow-server","java-vertx","java-vertx-web","jaxrs-cxf","jaxrs-cxf-cdi","jaxrs-cxf-extended","jaxrs-jersey","jaxrs-resteasy","jaxrs-resteasy-eap","jaxrs-spec","kotlin-server","kotlin-spring","kotlin-vertx","nodejs-express-server","nodejs-server-deprecated","php-laravel","php-lumen","php-silex","php-slim-deprecated","php-slim4","php-symfony","php-ze-ph","python-aiohttp","python-blueplanet","python-flask","ruby-on-rails","ruby-sinatra","rust-server","scala-finch","scala-lagom-server","scala-play-server","scalatra","spring"]},{"in":"body","name":"generatorInput","description":"parameters","required":true,"schema":{"$ref":"#/definitions/GeneratorInput","originalRef":"GeneratorInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseCode","originalRef":"ResponseCode"},"responseSchema":{"$ref":"#/definitions/ResponseCode","originalRef":"ResponseCode"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}}},"definitions":{"AuthorizationValue":{"type":"object","properties":{"keyName":{"type":"string"},"type":{"type":"string"},"urlMatcher":{"$ref":"#/definitions/PredicateOfURL","originalRef":"PredicateOfURL"},"value":{"type":"string"}},"title":"AuthorizationValue"},"CliOption":{"type":"object","properties":{"default":{"type":"string"},"description":{"type":"string"},"enum":{"type":"object","additionalProperties":{"type":"string"}},"opt":{"type":"string"},"optValue":{"type":"string"},"type":{"type":"string"}},"title":"CliOption"},"GeneratorInput":{"type":"object","properties":{"authorizationValue":{"$ref":"#/definitions/AuthorizationValue","originalRef":"AuthorizationValue"},"openAPIUrl":{"type":"string","example":"https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml","allowEmptyValue":false},"options":{"type":"object","additionalProperties":{"type":"string"}},"spec":{"type":"object"}},"title":"GeneratorInput"},"PredicateOfURL":{"type":"object","title":"PredicateOfURL"},"ResponseCode":{"type":"object","properties":{"code":{"type":"string","example":"d40029be-eda6-4d62-b1ef-d05e2e91a72a","description":"File download code","allowEmptyValue":false},"link":{"type":"string","example":"http://localhost:8080/api/gen/download/d40029be-eda6-4d62-b1ef-d05e2e91a72a","description":"URL for fetching the generated client","allowEmptyValue":false}},"title":"ResponseCode"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"deserializedFields":{"$ref":"#/definitions/URLStreamHandler","originalRef":"URLStreamHandler"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"serializedHashCode":{"type":"integer","format":"int32"},"userInfo":{"type":"string"}},"title":"URL"},"URLStreamHandler":{"type":"object","title":"URLStreamHandler"}}}