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.
| 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. |
Objects: Business Component, Data Provider, Procedure, API, Panel, Work With
The default value for the property at Generator level is:
- Yes, if the KB or environment is created with GeneXus 18 or higher
- No, otherwise.
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.
To apply the corresponding changes when the property value is configured, execute a Rebuild All.
Documenting RESTFul services
Rest web services in GeneXus
Open API