Generate OpenAPI interface property

Official Content
This documentation is valid for:
Declares whether the Rest web services in GeneXus will have their Open API documentation in a file called default.yaml, located under the application directory.

Values

No The Open API interface documentation won't be generated.
Use Environment property value The value configured for the Environment (under the Back end node > Generator) will be used.
Yes The Open API interface will be generated for this REST service.

Scope

Objects: Business Component, Data Provider, Procedure, API

Description

The default value for the property at Generator level is: No.

The default value for the property at object level is: Use Environment property value.

The default.yaml file is updated when any of these objects is generated:

When working with the API object an independent Yaml is generated.

How to apply changes

To apply the corresponding changes when the property value is configured, execute a Rebuild All.

See Also

Documenting RestFul services
Rest web services in GeneXus
Open API