Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Web.DataObject.Writer.OpenAPI31ServiceWriter

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.OpenAPI31ServiceWriter

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

Inherits: OpenEdge.Web.DataObject.Writer.OpenAPI30ServiceWriter

/* *************************************************************************************************************************
Copyright (c) 2026 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:OpenAPI31ServiceWriter
Purpose:Writes a DataObjectService to a OpenApi (Swagger) 3.1 spec
Author(s):dugrau
Created:2026-01-15
Notes:Supported Specification History:
Builds upon the original OpenAPI 3.0 implementation (see OE.W.DO.Writer.OpenAPI30ServiceWriter.cls)
Starting Implementation: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.2.md



Method Summary
  Options Name Purpose
  AddNullableProperty (JsonObject) /** Overrides 3.0.x behavior to remove explicit nullable property. In OpenAPI 3.1.x with JSON Schema 2020-12, all fields are nullable by default unless explicitly marked as required in the parent schema's required array. @param JsonObject The schema object (no-op in 3.1.x - nullable is default) */
  ApplyFieldFormat (JsonObject, character) /** Overrides 3.0.x behavior for binary field format. In OpenAPI 3.1.x with JSON Schema 2020-12, binary data uses contentEncoding and contentMediaType instead of the removed 'format: binary'. @param JsonObject The schema object to apply format to @param character The format value (e.g., 'date', 'int32', 'binary') */
  MarkRequiredField (JsonObject, character, character) /** Overrides 3.0.x per-field required marking. In OpenAPI 3.1.x with JSON Schema 2020-12, required is expressed as an array on the parent items object, not as a boolean on individual field schemas. This method is a no-op â'' required fields are applied by MarkRequiredFields instead. @param JsonObject The field schema object (unused in 3.1.x) */
  MarkRequiredFields (JsonObject, character) /** Overrides 3.0.x no-op to write a JSON Schema 2020-12 compliant required array. Splits pRequiredFlds by comma and adds a 'required' array to the items schema containing each unique field's name. @param JsonObject The items schema object of the table @param character Comma-delimited list of unique (required) field names */

Constructor Summary
  Options Name Purpose
  OpenAPI31ServiceWriter ()

Method Detail
Top

AddNullableProperty (JsonObject)

Purpose:
Overrides 3.0.x behavior to remove explicit nullable property.
In OpenAPI 3.1.x with JSON Schema 2020-12, all fields are nullable by default
unless explicitly marked as required in the parent schema's required array.
Parameters:
pSchemaObject Progress.Json.ObjectModel.JsonObject
 
Top

ApplyFieldFormat (JsonObject, character)

Purpose:
Overrides 3.0.x behavior for binary field format.
In OpenAPI 3.1.x with JSON Schema 2020-12, binary data uses contentEncoding
and contentMediaType instead of the removed 'format: binary'.
Parameters:
pSchemaObject Progress.Json.ObjectModel.JsonObject
 
pFormat CHARACTER
 
Top

MarkRequiredField (JsonObject, character, character)

Purpose:
Overrides 3.0.x per-field required marking.
In OpenAPI 3.1.x with JSON Schema 2020-12, required is expressed as an array
on the parent items object, not as a boolean on individual field schemas.
This method is a no-op â'' required fields are applied by MarkRequiredFields instead.
Parameters:
pFieldSchema Progress.Json.ObjectModel.JsonObject
 
pFieldName CHARACTER
 
pRequiredFlds CHARACTER
 
Top

MarkRequiredFields (JsonObject, character)

Purpose:
Overrides 3.0.x no-op to write a JSON Schema 2020-12 compliant required array.
Splits pRequiredFlds by comma and adds a 'required' array to the items schema
containing each unique field's name.
Parameters:
pItemsSchema Progress.Json.ObjectModel.JsonObject
 
pRequiredFlds CHARACTER
 


Constructor Detail
Top

STATIC OpenAPI31ServiceWriter ()


Alert