Configuration of the NaturalONE OpenAPI Plugin

The global default settings for OpenAPI service generation can be configured in the Eclipse Preferences window. These settings apply to all service files generated by the plugin.

To access these settings, go to Window on the main menu and select Preferences. On the navigation tree, expand the Software AG node, Natural node, and then select OpenAPI.

Eclipse Preferences window

The settings in the Preferences window define the default values used during OpenAPI service generation when a corresponding property has not been explicitly defined in the subprogram itself.

The following settings are available:

Use lowercase letters

Select this checkbox to automatically convert parameter names to lowercase during the OpenAPI service generation process.

API parameter name transformation

This setting provides options to automatically transform OpenAPI parameter names. The following options are available:

  • Keep API parameter names – This option keeps the parameter names unchanged.

  • Remove characters – This option removes specified characters from parameter names. An accompanying input field allows you to specify the characters to remove (for example, #, !, or @).

  • Replace characters – This option allows you to define mappings that specify which characters or strings to replace and the characters or strings to use as replacements instead of removing them.

String oversize value handling

This setting defines the default behavior for handling oversized string values. This setting can be overridden for an individual service in the OpenAPI Editor.

The following options are available:

  • Truncate – This option truncates the value when it exceeds the allowed size.

  • Error – This option generates an error when the value exceeds the allowed size.

Default HTTP request type

This setting defines the default HTTP request method that is selected when the OpenAPI Editor is opened, if no HTTP request type was defined in the subprogram.

Open OpenAPI service editor after generating JSON file

This setting controls whether the OpenAPI Editor opens automatically when Generate OpenAPI Service is triggered.

By default, this checkbox is selected. When it is cleared, the service file is generated immediately without opening the editor.

When multiple subprograms are selected and Generate OpenAPI Service is triggered, this setting is bypassed and the OpenAPI Editor is not opened.