simple test gist

test-config.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Example API of new version",
    "description": "Example desc",
    "version": "v1",
    "contact": {
      "email": "[email protected]"
    }
  },
  "servers": [
    {
      "url": "http://localhost:3010/api",
      "description": "Sandbox"
    }
  ],
  "paths": {
    "/flows": {
      "get": {
        "description": "List flow instances. Filter based on querystring.",
        "parameters": [
          {
            "name": "Flow-Process-User",
            "in": "header",
            "description": "User header",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "{\"national_id\": \"01065100394\"}"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of flow instances"
          }
        },
        "tags": [
          "flow"
        ]
      }
    },
    "/flows/count": {
      "get": {
        "description": "Count the amount of processes. Filter based on querystring.",
        "parameters": [
          {
            "name": "Flow-Process-User",
            "in": "header",
            "description": "User header",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "{\"national_id\": \"01065100394\"}"
          }
        ],
        "responses": {
          "200": {
            "description": "A count of flows you are allowed to access.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "count": {
                      "type": "integer"
                    }
                  },
                  "example": {
                    "count": 15
                  }
                }
              }
            }
          }
        },
        "tags": [
          "flow"
        ]
      }
    },
    "/flows/{flowId}": {
      "get": {
        "description": "Get a flow instance. Filter based on querystring.",
        "parameters": [
          {
            "description": "Flow id",
            "in": "path",
            "name": "flowId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Flow-Process-User",
            "in": "header",
            "description": "User header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "{\"national_id\": \"01065100394\"}"
          }
        ],
        "responses": {
          "200": {
            "description": "A flow instance"
          }
        },
        "tags": [
          "flow"
        ]
      },
      "delete": {
        "description": "Delete a flow instance",
        "parameters": [
          {
            "description": "Flow id",
            "in": "path",
            "name": "flowId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Flow-Process-User",
            "in": "header",
            "description": "User header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "{\"national_id\": \"01065100394\"}"
          }
        ],
        "responses": {
          "200": {
            "description": "A flow instance"
          }
        },
        "tags": [
          "flow"
        ]
      }
    }
  }
}