| |
Options |
Name |
Purpose |
|
|
|
Close ()
|
/**
Finalizes and closes the writer.
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter IncludeRoleRequirements ()
|
/**
Enables the inclusion of role requirements in the OpenAPI document.
By default, role names are not exposed for security reasons.
Uses decorator API pattern to allow method chaining.
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
Open ()
|
/**
Initializes the writer and creates the root OpenAPI document structure.
After creating the structure, applies any user-provided context (version, servers).
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter SetDocumentVersion (character)
|
/**
Sets the document API version for the OpenAPI specification.
Uses decorator API pattern to allow method chaining.
@param character The API version string (e.g., "1.0.0", "2.1.3")
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter SetServer (character, character, integer, character, character)
|
/**
Sets a direct server configuration to be inserted as the first server entry.
Uses decorator API pattern to allow method chaining.
@param character Scheme (http/https), ? or empty to use default
@param character Hostname, ? or empty to use default
@param integer Port number, ? or 0 to use default
@param character Context path, ? or empty to use default
@param character Base path, ? or empty to use default
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBasicAuth (character)
|
/**
Configures HTTP Basic Authentication as the security scheme.
Uses decorator API pattern to allow method chaining.
@param character Realm name (e.g., from http.all.realm property)
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBasicAuth (character, character)
|
/**
Configures HTTP Basic Authentication as the security scheme with custom description.
Uses decorator API pattern to allow method chaining.
@param character Realm name (e.g., from http.all.realm property)
@param character Custom description for the scheme
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBearerAuth (character)
|
/**
Configures Bearer token authentication as the security scheme.
Uses decorator API pattern to allow method chaining.
@param character Bearer format (e.g., 'JWT', 'Client-Principal', 'SAML')
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBearerAuth (character, character)
|
/**
Configures Bearer token authentication as the security scheme with custom description.
Uses decorator API pattern to allow method chaining.
@param character Bearer format (e.g., 'JWT', 'Client-Principal', 'SAML')
@param character Custom description for the scheme
@return IOpenAPIServiceWriter Returns this instance for method chaining
*/
|
|
|
|
Write (Object[])
|
/**
Writes service data to the OpenAPI document.
@param DataObjectService The service to write to the document
*/
|