option.json

{  
  "npmName": "@kibibit/sample-webapi",  
  "ngVersion":"6.0.0",
  "withInterfaces": true,
  "supportsES6": true
}

swagger-spec.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "@kibibit/achievibit",
    "description": "<DESCRIPTION>",
    "version": "2.0.0-beta.17",
    "contact": {
      "name": "thatkookooguy",
      "url": "github.com/thatkookooguy",
      "email": "thatkookooguy@kibibit.io"
    }
  },
  "tags": [
    {
      "name": "user",
      "description": "achievibit user endpoints. Users are created by GitHub, so you can only retrieve existing users"
    },
    {
      "name": "repo",
      "description": "achievibit repo endpoints. Repos are created by GitHub, so you can only retrieve existing repos"
    },
    {
      "name": "Pull Request",
      "description": "**WARNING**: This should not be exposed in production. The entire pull-request controller should appear only in dev environments"
    },
    {
      "name": "Webhook Event Manager",
      "description": "Handles webhook event data sent from cloud version control"
    },
    {
      "name": "default",
      "description": "utility api endpoints"
    }
  ],
  "servers": [],
  "components": {
    "schemas": {
      "ApiInfo": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "license": {
            "type": "string"
          },
          "repository": {
            "type": "string"
          },
          "author": {
            "type": "string"
          },
          "bugs": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "version",
          "license",
          "repository",
          "author",
          "bugs"
        ]
      },
      "User": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "avatar": {
            "type": "string"
          },
          "organization": {
            "type": "boolean"
          },
          "users": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "repos": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "organizations": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "username",
          "url",
          "avatar",
          "organization"
        ]
      },
      "Repo": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "fullname": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "organization": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "fullname",
          "url",
          "organization"
        ]
      }
    }
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "AppController_sendWebClient",
        "summary": "Get Web Client (HTML)",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Returns the Web Client's HTML File"
          }
        }
      }
    },
    "/api": {
      "get": {
        "operationId": "ApiController_getAPI",
        "summary": "Get API Information",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Returns API info as a JSON",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiInfo"
                }
              }
            }
          }
        }
      }
    },
    "/api/nana": {
      "get": {
        "operationId": "ApiController_",
        "summary": "",
        "deprecated": true,
        "parameters": [],
        "responses": {
          "200": {
            "description": ""
          }
        }
      }
    },
    "/api/user": {
      "get": {
        "operationId": "UserController_getAllUsers",
        "summary": "Get all Users",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Return a list of all Users"
          }
        },
        "tags": [
          "user"
        ]
      }
    },
    "/api/user/{username}": {
      "get": {
        "operationId": "UserController_getUser",
        "summary": "Get an existing User",
        "parameters": [
          {
            "name": "username",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Return a single User",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "400": {
            "description": "Invalid identifier supplied"
          },
          "404": {
            "description": "User not found"
          }
        },
        "tags": [
          "user"
        ]
      }
    },
    "/api/repo": {
      "get": {
        "operationId": "RepoController_getAllRepos",
        "summary": "Get all Repos",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Return a list of all Repos"
          }
        },
        "tags": [
          "repo"
        ]
      }
    },
    "/api/repo/{name}": {
      "get": {
        "operationId": "RepoController_getRepo",
        "summary": "Get an existing Repo",
        "parameters": [
          {
            "name": "name",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Return a single Repo",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Repo"
                }
              }
            }
          },
          "400": {
            "description": "Invalid identifier supplied"
          },
          "404": {
            "description": "Repo not found"
          }
        },
        "tags": [
          "repo"
        ]
      }
    },
    "/api/webhook-event-manager": {
      "post": {
        "operationId": "WebhookEventManagerController_recieveGitHubWebhooks",
        "summary": "Recieve GitHub Webhooks",
        "parameters": [
          {
            "name": "x-github-event",
            "required": true,
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "Webhook Event Manager"
        ]
      }
    },
    "/api/pull-request": {
      "get": {
        "operationId": "PullRequestController_getAll",
        "summary": "Get all PullRequests",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Return a list of all PullRequests"
          }
        },
        "tags": [
          "Pull Request"
        ]
      }
    }
  }
}