Namespace: OpenEdge.Web.DataObject.Writer
Type: Class OpenAPI30ServiceWriter
Parent Classes:
Progress.Lang.Object
OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
OpenEdge.Web.DataObject.Writer.OpenAPI30ServiceWriter

Inherits: OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter

/* *************************************************************************************************************************
Copyright (c) 2018, 2021 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:OpenAPI30ServiceWriter
Purpose:Writes a DataObjectService to a OpenApi (Swagger) 3.0 doc
Author(s):pjudge
Created:2018-09-20
Notes:- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md



Method Summary
  Options Name Purpose
  CHARACTER FieldInfo (character, character)
  Progress.Json.ObjectModel.JsonObject GetPathJson (DataObjectService, character, MethodEnum)
  Open ()
  Progress.Json.ObjectModel.JsonObject WriteDataset (handle)
  WriteDefaultFieldValue (handle, JsonObject) /* Writes the correctly-typed default value for a field @param handle A valid buffer-field handle @param JsonObject A valid JSON object representing the field */
  Progress.Json.ObjectModel.JsonObject WriteDefaultSchemas ()
  Progress.Json.ObjectModel.JsonArray WriteDefaultServers ()
  Progress.Json.ObjectModel.JsonObject WriteHeaders (MappedOperation)
  Progress.Json.ObjectModel.JsonObject WriteInfo ()
  WriteOperation (DataObjectService, MappedOperation)
  WriteSchema (DataObjectService, handle)
  WriteService (DataObjectService)
  Progress.Json.ObjectModel.JsonObject WriteServiceRoot ()
  Progress.Json.ObjectModel.JsonObject WriteTable (handle)
  WriteTag (character, character, JsonObject)
  WriteURI (URI) /* Writes a URI to the output @param URI The URI to write */

Constructor Summary
  Options Name Purpose
  OpenAPI30ServiceWriter ()
  OpenAPI30ServiceWriter () /* Default constructor */

Property Summary
  Options Name Purpose
  OpenEdge.Core.SemanticVersion OPEN_API_VERSION


Method Detail
Top

CHARACTER FieldInfo (character, character)

Parameters:
pAblType CHARACTER
 
pFormat CHARACTER
 
Returns CHARACTER
 
Top

Progress.Json.ObjectModel.JsonObject GetPathJson (DataObjectService, character, MethodEnum)

Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
 
pUri CHARACTER
 
pMethod OpenEdge.Net.HTTP.MethodEnum
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

Open ()
Top

Progress.Json.ObjectModel.JsonObject WriteDataset (handle)

Parameters:
pDataset HANDLE
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

WriteDefaultFieldValue (handle, JsonObject)

/* Writes the correctly-typed default value for a field
Parameters:
pField HANDLE
 
pJson Progress.Json.ObjectModel.JsonObject
 
Top

Progress.Json.ObjectModel.JsonObject WriteDefaultSchemas ()

Returns Progress.Json.ObjectModel.JsonObject
 
Top

Progress.Json.ObjectModel.JsonArray WriteDefaultServers ()

Returns Progress.Json.ObjectModel.JsonArray
 
Top

Progress.Json.ObjectModel.JsonObject WriteHeaders (MappedOperation)

Parameters:
pData OpenEdge.Web.DataObject.MappedOperation
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

Progress.Json.ObjectModel.JsonObject WriteInfo ()

Returns Progress.Json.ObjectModel.JsonObject
 
Top

WriteOperation (DataObjectService, MappedOperation)

Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
 
pData OpenEdge.Web.DataObject.MappedOperation
 
Top

WriteSchema (DataObjectService, handle)

Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
 
pData HANDLE
 
Top

WriteService (DataObjectService)

Parameters:
pData OpenEdge.Web.DataObject.DataObjectService
 
Top

Progress.Json.ObjectModel.JsonObject WriteServiceRoot ()

Returns Progress.Json.ObjectModel.JsonObject
 
Top

Progress.Json.ObjectModel.JsonObject WriteTable (handle)

Parameters:
pTable HANDLE
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

WriteTag (character, character, JsonObject)

Parameters:
pName CHARACTER
 
pDescription CHARACTER
 
pExtDoc Progress.Json.ObjectModel.JsonObject
 
Top

WriteURI (URI)

/* Writes a URI to the output
Parameters:
pData OpenEdge.Net.URI
 


Constructor Detail
Top

STATIC OpenAPI30ServiceWriter ()
Top

OpenAPI30ServiceWriter ()

/* Default constructor


Property Detail
Top

OpenEdge.Core.SemanticVersion OPEN_API_VERSION

Returns OpenEdge.Core.SemanticVersion