opsgenie / opsgenie-oas

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Opsgenie OpenAPI Specification

This project based on Swagger version 2.0.0 and RESTful API of Opsgenie. You can refer to swagger.json for combined specification.


How To Combine YAML Files Into A Single JSON

Prerequisites

You need to install the node dependencies:

cd $PROJECT_ROOT/multi-file-swagger
npm install

Now you can generate a single swagger json file:

cd $PROJECT_ROOT
node ./multi-file-swagger/index.js swagger.yaml > swagger.json

How To Selectively Combine YAML Files Into A Single JSON For Selective Domains

You can generate a single swagger json file for selective domains along with the common files:

cd $PROJECT_ROOT
node ./multi-file-swagger/index.js swagger.yaml [DomainName1] [DomainName2] [DomainName3] > swagger.json

Some of the Possible DomainName values are: alert, heartbeat, incident


How To Generate Swagger Classes (For Java)

At this stage, we are using our custom swagger-codegen implementation and use special params like x-collapse-params. However, you can also use default swagger-codegen for the Java SDK generation.

cd $PROJECT_ROOT
mvn clean install
cd ./target/generated-sources/java
mvn install

For configuration of pom.xml, you can refer here

About

License:Apache License 2.0


Languages

Language:JavaScript 100.0%