org.wso2.apimgt.gateway.cli.model.template.service

Interface BallerinaOpenAPIObject<C,D>

Type Parameters:

C - Ballerina wrapper type that is being implemented

D - Swagger parser model type

All Known Implementing Classes:

BallerinaOperation, BallerinaParameter, BallerinaPath, BallerinaService

public interface BallerinaOpenAPIObject<C,D>

Contract interface for creating a ballerina wrapper from a swagger parser object model.

Method Summary

Modifier and Type	Method and Description
C	buildContext(D definition) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
C	buildContext(D definition, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
C	getDefaultValue() Retrieve the default value for this type.

Method Detail

buildContext

C buildContext(D definition)
        throws BallerinaServiceGenException

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

Parameters:

definition - Open Api definition or component

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

buildContext

C buildContext(D definition,
               ExtendedAPI api)
        throws BallerinaServiceGenException

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

OpenAPI definition openApi can be used to access the parent context helpful for building the current context

Parameters:

definition - Swagger Api definition or component

api - openApi object model

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

getDefaultValue

C getDefaultValue()

Retrieve the default value for this type.

Returns:

default values