Namespace: Consultingwerk.OERA.Swagger
Class 
SwaggerDefinitionGenerator Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.Swagger.SwaggerDefinitionGenerator

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.Swagger.ISwaggerDefinitionGenerator

File:SwaggerDefinitionGenerator
Purpose:Swagger Definition Generation
Author(s):Martyn Kemp / Consultingwerk Ltd.
Created:Fri May 19 08:39:21 BST 2017

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonObject AddComponentsSchema (character, handle) Returns the Catalog for the Restful Services
# GetConfigurationSettings () Gets the Rest Application Configuration Settings
# Progress.Json.ObjectModel.JsonObject GetCountOperation (character, character, logical) Returns the JSON Count Operation
# Progress.Json.ObjectModel.JsonArray GetCountParameters () Returns the JSON Count Parameters Array
# Progress.Json.ObjectModel.JsonObject GetDefinitionCount () Returns the JSON Schema Definitions Count for the ProDataset
# Progress.Json.ObjectModel.JsonObject GetDefinitions (character, handle) Returns the JSON Schema Definitions for the ProDataset
# CHARACTER GetFilterDefaultValue () Returns the Filter Default Value
# Progress.Json.ObjectModel.JsonObject GetInvokeOperation (character, character, character, character, logical) Returns the JSON Invoke Operation
# Progress.Json.ObjectModel.JsonObject GetPathFilterOperation (character, character) Returns the JSON Path Filter Operation
# Progress.Json.ObjectModel.JsonObject GetPathOperation (character, character, character, character, logical, logical) Returns the JSON Path Operation
# Progress.Json.ObjectModel.JsonObject GetPathOperations (character, handle) Returns the Array of REST Operations for the given Dataset Name
# Progress.Json.ObjectModel.JsonObject GetPathParameters (character, character, character) Returns the JSON Path Array
# GetProperties (CharacterList, character, character) Adds the serializable properties from the given Serializable type to the list of properties
# GetPropertiesItems (CharacterList, character, JsonObject) Adds the serializable properties from the given Serializable type to the list of properties
# Progress.Json.ObjectModel.JsonArray GetRelations (handle) Returns the JSON Schema description of the Relations for the ProDataset
# Progress.Json.ObjectModel.JsonObject GetSchema (handle) Returns the JSON Schema description for the ProDataset
# CHARACTER GetService (RestServiceAddress) Returns a Service Instance
+ Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character) Returns the Catalog for a given Business Entity
+ GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character, longchar) Returns the Catalog for a given Business Entity
+ Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress, character) Returns the Catalog for a given Business Task
# Progress.Json.ObjectModel.JsonObject SetDescription (character) Returns the JSON Description
- Progress.Json.ObjectModel.JsonObject SetParameterProperties (character, character) Set parameter properties

Top Property Summary
Options Name Purpose
# HANDLE DatasetHandle
# CHARACTER EntityName
- LOGICAL InvokeMethods


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonObject AddComponentsSchema (character, handle)
Purpose: Returns the Catalog for the Restful Services
Notes:

Parameters:
pcEntityName CHARACTER
The Business Entity name
phDataset HANDLE
The Dataset Handle
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object containing the Restful Services Operations
Top

PROTECTED GetConfigurationSettings ()
Purpose: Gets the Rest Application Configuration Settings
Notes:

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetCountOperation (character, character, logical)
Purpose: Returns the JSON Count Operation
Notes:

Parameters:
pcEntityname CHARACTER
The Business Entity name
pcDatasetName CHARACTER
The Dataset Name
plFilter LOGICAL
Using Filtering
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Count Operation
Top

PROTECTED Progress.Json.ObjectModel.JsonArray GetCountParameters ()
Purpose: Returns the JSON Count Parameters Array
Notes:

Returns Progress.Json.ObjectModel.JsonArray
The JsonObject for Count Parameters Array
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetDefinitionCount ()
Purpose: Returns the JSON Schema Definitions Count for the ProDataset
Notes:

Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the Definitions Count schema
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetDefinitions (character, handle)
Purpose: Returns the JSON Schema Definitions for the ProDataset
Notes:

Parameters:
pcEntityName CHARACTER
The Business Entity
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the Schema Definitions
Top

PROTECTED CHARACTER GetFilterDefaultValue ()
Purpose: Returns the Filter Default Value
Notes: Rereading the dataset Schema because THIS-OBJECT:Datasethandle
contains field "seq" which is being return as the Index

Returns CHARACTER
The Default Filer Value for Filtered paths
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetInvokeOperation (character, character, character, character, logical)
Purpose: Returns the JSON Invoke Operation
Notes:

Parameters:
pcEntityname CHARACTER
The Business Entity name
pcDatasetName CHARACTER
The Dataset Name
pcMethodName CHARACTER
The Method Name
pcParameterClassName CHARACTER
The parameter class name
plDatasetInput LOGICAL
Using Dataset as Input
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Invoke Operation
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetPathFilterOperation (character, character)
Purpose: Returns the JSON Path Filter Operation
Notes:

Parameters:
pcEntityname CHARACTER
The Business Entity name
pcDatasetName CHARACTER
The Dataset Name
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Path Filter Operation
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetPathOperation (character, character, character, character, logical, logical)
Purpose: Returns the JSON Path Operation
Notes:

Parameters:
pcEntityname CHARACTER
The Business Entity name
pcDatasetName CHARACTER
The Dataset Name
pcTableName CHARACTER
The Table Name
pcVerb CHARACTER
The Verb
plConsumes LOGICAL
Consumable
plParameters LOGICAL
Has parameters
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Path Operation
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetPathOperations (character, handle)
Purpose: Returns the Array of REST Operations for the given Dataset Name
Notes:

Parameters:
pcEntityName CHARACTER
The name of the business entity
phDataset HANDLE
The handle of the ProDataset
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the operations
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetPathParameters (character, character, character)
Purpose: Returns the JSON Path Array
Notes:

Parameters:
pcName CHARACTER
Path Node Name
pcSchema CHARACTER
Schema Node Name
pcDescription CHARACTER
Description Node Name
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Paths Array
Top

PROTECTED GetProperties (CharacterList, character, character)
Purpose: Adds the serializable properties from the given
Serializable type to the list of properties
Notes:

Parameters:
poProperties Consultingwerk.Framework.Collections.CharacterList
The CharacterList to add properties to
pcClassName CHARACTER
The JsonSerializable class name
pcPrefix CHARACTER
The prefix to add to the properties
Top

PROTECTED GetPropertiesItems (CharacterList, character, JsonObject)
Purpose: Adds the serializable properties from the given
Serializable type to the list of properties
Notes:

Parameters:
poProperties Consultingwerk.Framework.Collections.CharacterList
The CharacterList to add properties to
pcClassName CHARACTER
The JsonSerializable class name
oPropertyItems Progress.Json.ObjectModel.JsonObject
The Properties JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonArray GetRelations (handle)
Purpose: Returns the JSON Schema description of the Relations for the ProDataset
Notes:

Parameters:
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonArray
The JsonObject representing the relations
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetSchema (handle)
Purpose: Returns the JSON Schema description for the ProDataset
Notes:

Parameters:
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the schema
Top

PROTECTED CHARACTER GetService (RestServiceAddress)
Purpose: Returns a Service Instance
Notes:

Parameters:
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
Returns CHARACTER
The Service Instance Value
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character)
Purpose: Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Entity
Top

PUBLIC GetSwaggerDefinitionForBusinessEntity (character, RestServiceAddress, character, longchar)
Purpose: Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
pcSwaggerDefinition LONGCHAR
OUTPUT The Swagger Annotation Catalog for the Business Entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSwaggerDefinitionForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress, character)
Purpose: Returns the Catalog for a given Business Task
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The name of the Business Task
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcServiceURI CHARACTER
The Service URI
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Task
Top

PROTECTED Progress.Json.ObjectModel.JsonObject SetDescription (character)
Purpose: Returns the JSON Description
Notes:

Parameters:
pcDescription CHARACTER
Description Value for the JsonObject
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject for the Description Node
Top

PRIVATE Progress.Json.ObjectModel.JsonObject SetParameterProperties (character, character)
Purpose: Set parameter properties
Notes:

Parameters:
pcParameterPath CHARACTER
Parameter Path
pcParameterClassName CHARACTER
Parameter Class Name
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object parameter properties for the Parameter Class


Property Detail
Top

PROTECTED HANDLE DatasetHandle

Returns HANDLE
Top

PROTECTED CHARACTER EntityName

Returns CHARACTER
Top

PRIVATE LOGICAL InvokeMethods

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:13:55