Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: August 18, 2026
  • 4 minute read
    • OpenEdge
    • Version 12.8
    • Documentation
Namespace: OpenEdge.Web.DataObject.Writer
Type: Interface IOpenAPIServiceWriter
Parent Classes:
Inherits: Progress.Lang.Object

Copyright (c) 2026 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:IOpenAPIServiceWriter
Purpose:Interface for OpenAPI service writers with decorators
Description:Provides minimal, expected properties/methods for use
Author(s):dgrau
Created:2026-01-22
Notes:Provides guaranteed methods which should be available
regardless of the OAS specification to be implemented by a concrete
class. Allows for applying a decorator pattern for certain actions.
Purpose: The JsonObject instance which will store the catalog data.



Method Summary
  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 */

Property Summary
  Options Name Purpose
  Progress.Lang.Object Value


Method Detail
Top

Close ()

Purpose:
Finalizes and closes the writer.
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter IncludeRoleRequirements ()

Purpose:
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.
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

Open ()

Purpose:
Initializes the writer and creates the root OpenAPI document structure.
After creating the structure, applies any user-provided context (version, servers).
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter SetDocumentVersion (character)

Purpose:
Sets the document API version for the OpenAPI specification.
Uses decorator API pattern to allow method chaining.
Parameters:
pcVersion CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter SetServer (character, character, integer, character, character)

Purpose:
Sets a direct server configuration to be inserted as the first server entry.
Uses decorator API pattern to allow method chaining.
Parameters:
pcScheme CHARACTER
 
pcHost CHARACTER
 
piPort INTEGER
 
pcContext CHARACTER
 
pcBasePath CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBasicAuth (character)

Purpose:
Configures HTTP Basic Authentication as the security scheme.
Uses decorator API pattern to allow method chaining.
Parameters:
pcRealm CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBasicAuth (character, character)

Purpose:
Configures HTTP Basic Authentication as the security scheme with custom description.
Uses decorator API pattern to allow method chaining.
Parameters:
pcRealm CHARACTER
 
pcDescription CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBearerAuth (character)

Purpose:
Configures Bearer token authentication as the security scheme.
Uses decorator API pattern to allow method chaining.
Parameters:
pcFormat CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter UseBearerAuth (character, character)

Purpose:
Configures Bearer token authentication as the security scheme with custom description.
Uses decorator API pattern to allow method chaining.
Parameters:
pcFormat CHARACTER
 
pcDescription CHARACTER
 
Returns OpenEdge.Web.DataObject.Writer.IOpenAPIServiceWriter
  IOpenAPIServiceWriter Returns this instance for method chaining
Top

Write (Object[])

Purpose:
Writes service data to the OpenAPI document.
Parameters:
poData Progress.Lang.Object
 


Property Detail
Top

Progress.Lang.Object Value

Returns Progress.Lang.Object
 


Alert