serverless-openapi-documenter/test/models/BasicDocumentation.json

Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config

{
  "custom": {
    "documentation": {
      "title": "test-service",
      "models": [
        {
          "name": "SuccessResponse",
          "description": "Success response",
          "content": {
            "application/json": {
              "schema": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "object",
                "properties": {
                  "SomeObject": {
                    "type": "object",
                    "properties": {
                      "SomeAttribute": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        {
          "name": "ErrorResponse",
          "description": "Error response",
          "content": {
            "application/json": {
              "schema": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "object",
                "properties": {
                  "error": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      ]
    }
  }
}