You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
OpenAPI Specification 3.1.0 | Corresponds with … in Blueriq | Location (editor) in Encore |
|---|---|---|
Version number in the URL of the feed (see also: OpenAPI). | - | |
OpenAPI title in project in Encore. If empty: "Blueriq Rest Services”. | ||
OpenAPI description in project in Encore. If empty: “A specification of the rest services available in the Blueriq Runtime”. | ||
URL of the runtime server from which the feed is generated. | - | |
Name of the rest service element in which the operation is defined in Encore. | ||
/[Web service name of element in Encore]/[Fragment defined in rest service in Encore] | ||
Selected HTTP method of the operation in rest service in Encore. | ||
Name of operation in rest service in Encore. | ||
OpenAPI Description of operation in rest service in Encore | ||
Name of webservice + Name of operation in rest service in Encore | ||
Headers, arguments, and fragments in operation in rest service in Encore, including its properties such as OpenAPI description, whether the parameter is required, values of a value list that is attached to an attribute in case of a dynamic parameter. | ||
Request domain schema in operation in rest service in Encore. | ||
Response domain schema in operation in rest service in Encore. | ||
Default runtime responses named RestErrorResponse, InvalidJsonPathDetail, and InvalidJsonResponse that are used for default error responses (400, 401, 403, 404, 406, 500) | - | |
[ModuleName]_[DomainschemaName] | ||
Properties of a domain schema item, containing the name, data type, whether its required, whether its multivalued, OpenAPI description, values of a value list that is attached to an attribute that is mapped to a domain schema field. |
Overview
Content Tools