sample.json

{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "API"
  },
  "basePath": "\/",
  "paths": {
    "\/categories": {
      "get": {
        "tags": [
          "Categories"
        ],
        "summary": "Gets a list of categories",
        "operationId": "CategoriesGet",
        "consumes": [
          
        ],
        "produces": [
          
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      },
      "post": {
        "tags": [
          "Categories"
        ],
        "summary": "Creates a new category",
        "operationId": "CategoriesPost",
        "consumes": [
          "application\/json-patch+json",
          "application\/json",
          "text\/json",
          "application\/*+json"
        ],
        "produces": [
          
        ],
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "required": false,
            "schema": {
              "$ref": "#\/definitions\/CreateCategoryRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "One or more errors occurred (BadRequest)",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#\/definitions\/ErrorResult"
              }
            },
            "examples": "{\"$type\":\"RedRiver.Saffron.AspNetCore.ErrorResult[], RedRiver.Saffron.AspNetCore\",\"$values\":[{\"$type\":\"RedRiver.Saffron.AspNetCore.ErrorResult, RedRiver.Saffron.AspNetCore\",\"code\":1004,\"message\":\"Name must be unique\"}]}"
          }
        }
      }
    },
    "\/categories\/{id}": {
      "delete": {
        "tags": [
          "Categories"
        ],
        "summary": "Deletes a category by ID",
        "operationId": "CategoriesByIdDelete",
        "consumes": [
          
        ],
        "produces": [
          
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "One or more errors occurred (NotFound)",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#\/definitions\/ErrorResult"
              }
            },
            "examples": "{\"$type\":\"RedRiver.Saffron.AspNetCore.ErrorResult[], RedRiver.Saffron.AspNetCore\",\"$values\":[{\"$type\":\"RedRiver.Saffron.AspNetCore.ErrorResult, RedRiver.Saffron.AspNetCore\",\"code\":1003,\"message\":\"Category not found\"}]}"
          }
        }
      }
    },
    "\/functions": {
      "get": {
        "tags": [
          "Functions"
        ],
        "summary": "Gets a list of functions",
        "operationId": "FunctionsGet",
        "consumes": [
          
        ],
        "produces": [
          
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    },
    "\/setup\/initialise": {
      "post": {
        "tags": [
          "System Setup"
        ],
        "summary": "Initalises the environment \/ system",
        "operationId": "SetupInitialisePost",
        "consumes": [
          
        ],
        "produces": [
          
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "definitions": {
    "CreateCategoryRequest": {
      "required": [
        "name",
        "description"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    },
    "ErrorResult": {
      "type": "object",
      "properties": {
        "code": {
          "format": "int32",
          "type": "integer"
        },
        "message": {
          "type": "string"
        },
        "data": {
          "type": "object"
        }
      }
    }
  },
  "securityDefinitions": {
    
  }
}