Properties doh mapping file

The properties that are used in the file doh_mapping.json for automatically map your APIs to an OpenEdge back-end. And secondly make the generation of openapi possible.
You can download the api_framework.pl ABL procedure libraries

The search funtion will be executed to find the file doh_mapping.json

Root object

The root object of the config file

Fixed fields

Field Name	Type	Description
doh_mapping	Mapping Object	REQUIRED. The available paths and operations for the API.
info	Info Object	REQUIRED. Provides metadata about the API.
servers	Server Object	An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

Mapping Object

Field Name	Type	Description
path	string	A relative path to an individual endpoint.
operations	Operation Object	Describes a single API operation on a path.

Info Object

Field Name	Type	Description
title	string	REQUIRED. The title of the API.
description	string	A description of the API.
version	string	REQUIRED. The version of the OpenAPI document

Server Object

Field Name	Type	Description
url	string	REQUIRED. A URL to the target host.
description	string	An optional string describing the host designated by the URL.

Operation Object

Field Name	Type	Description
path	string	A relative path to an individual endpoint.
operation	string	A definition of an operation on this path.
tags	[string]	A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
abl_procedure	string	ABL procedure file
procedure	string	ABl internal procedure
class	string	ABL class path
class_method	string	Method of class
parameters	Parameter Object	A list of parameters that are applicable for all the operations described under this path.

Parameter Object

Field Name	Type	Description
name	string	Depending on the location this can be the 'table name' or 'query parameter'
location	string	REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie"
data_type	string	allowedValues: array, boolean, integer, number, object, string
io_mode	string	allowedValues: input, input-output, output
required	boolean	Determines whether this parameter is mandatory.
envelope	boolean	Is the response an array or is the array defined with a property in an object.