Openapi for OE

The generation of the openapi specs is excecuted at runtime.
It will first search for the doh_mapping.json file and then create the openapi spec.

Example

api_framework.doh.doh_mapping:create_openapi_spec("c:/temp/myopenapi.json"). 

Generated openapi doc

{
  "openapi": "3.0.0",
  "info": {
    "title": "DataDiggger API",
    "description": "The first step to openapi documentation for DD",
    "version": "0.0.1"
  },
  "servers": [
    {
      "url": "https:\/\/<hostname>:<port>\/web\/datadigger",
      "description": "Development server"
    }
  ],
  "paths": {
    "\/tables": {
      "post": {
        "responses": {
          "200": {
            "description": "A list of tables"
          }
        },
        "description": "post tables",
        "parameters": [
        ],
        "requestBody": {
          "$ref": "#\/components\/requestBodies\/ttTableFilterBody"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ttTableFilter": {
        "type": "object",
        "properties": {
          "lModified": {
            "type": "boolean"
          },
          "cTableNameShow": {
            "type": "string"
          },
          "cTableNameHide": {
            "type": "string"
          },
          "cTableFieldShow": {
            "type": "string"
          },
          "cTableFieldHide": {
            "type": "string"
          },
          "lShowNormal": {
            "type": "boolean"
          },
          "lShowSchema": {
            "type": "boolean"
          },
          "lShowVst": {
            "type": "boolean"
          },
          "lShowSql": {
            "type": "boolean"
          },
          "lShowOther": {
            "type": "boolean"
          },
          "lShowHidden": {
            "type": "boolean"
          },
          "lShowFrozen": {
            "type": "boolean"
          }
        }
      },
      "ttTableFilterArray": {
        "type": "array",
        "items": {
          "$ref": "#\/components\/schemas\/ttTableFilter"
        }
      },
      "ttTableFilterEnvelope": {
        "type": "object",
        "properties": {
          "ttTableFilter": {
            "$ref": "#\/components\/schemas\/ttTableFilterArray"
          }
        }
      }
    },
    "requestBodies": {
      "ttTableFilterBody": {
        "content": {
          "application\/json": {
            "schema": {
              "$ref": "#\/components\/schemas\/ttTableFilterEnvelope"
            }
          }
        }
      }
    }
  }
}