You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
OpenAPI feed (Runtime) | OAS | Corresponds with… | Location (editor) in Encore |
OpenAPI version | 4.1 | Version number in the URL of the feed. | - |
Title | 4.8.2.1 | OpenAPI title in project in Encore. If empty: “…” | Project |
Description | 4.8.2.1 | OpenAPI description in project in Encore. If empty: “…” | Project |
Server url | 4.8.5 | URL of the runtime server from which the feed is generated. | - |
Operation tag (group) | 4.8.22 | Name of the rest service element in which the operation is defined in Encore. | Rest service |
Path item object | 4.8.9 | Name of the web service element in Encore + / + Fragments | Web service |
Operation object | 4.8.10 | Selected HTTP method of the operation in rest service in Encore | Rest service |
Operation summary | 4.8.10 | Name of operation in rest service in Encore | Rest service |
Operation description | 4.8.10 | OpenAPI Description of operation in rest service in Encore | Rest service |
Operation id | 4.8.10 | Name of webservice + Name of operation in rest service in Encore | Web service, rest service |
Operation parameters | 4.8.12 | A collection of all (Except for constant fragments but including constant arguments!) headers, arguments, and fragments in rest service in Encore, including its properties such as whether it is required, OpenAPI description, values of a value list that is attached to an attribute. | Rest service, value list, attribute, value list |
Request body | 4.8.13 | Request domain schema in operation in rest service in Encore | Rest service |
Response 200 OK | 4.8.17 | Response domain schema in operation in rest service in Encore | Rest service |
Other responses | 4.8.17 | Default runtime responses named RestErrorResponse, InvalidJsonPathDetail, and InvalidJsonResponse that are used for default error responses (400, 401, 403, 404, 406, 500) | - |
Schema | 4.8.24 | [ModuleName]_[DomainschemaName] | Module, domain schema |
Schema property | 4.8.24 | 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. | Domain schema, attribute, value list |
Overview
Content Tools