ballerina.net.http.swagger package

public annotation Authorization

Attribute Name Data Type Description
name string
description string
authType string
apiName string
inFlow string
flow string
authorizationUrl string
tokenUrl string
authorizationScopes AuthorizationScope[]

public annotation AuthorizationScope

Attribute Name Data Type Description
name string
description string

public annotation Contact

Attribute Name Data Type Description
name string
email string
url string

public annotation Developer

Attribute Name Data Type Description
name string
email string

public annotation Example

Attribute Name Data Type Description
exampleType string
value string

public annotation ExternalDoc

Attribute Name Data Type Description
description string
url string

Attribute Name Data Type Description
name string
description string
headerType string

public annotation Item

Attribute Name Data Type Description
itemType string
format string
collectionFormat string
items string

public annotation License

Attribute Name Data Type Description
name string
url string

public annotation Organization

Attribute Name Data Type Description
name string
url string

public annotation ParameterInfo

Attribute Name Data Type Description
inInfo string
name string
description string
required boolean
allowEmptyValue string
parameterType string
format string
collectionFormat string
items Item[]

public annotation ParametersInfo

Attribute Name Data Type Description
value ParameterInfo[]

public annotation ResourceConfig

Attribute Name Data Type Description
schemes string[]
authorizations Authorization[]
name string
scopes string[]

public annotation ResourceInfo

Attribute Name Data Type Description
tags string[]
summary string
description string
externalDoc ExternalDoc

public annotation Response

Attribute Name Data Type Description
code string
description string
response string
headers Header[]
examples Example[]

public annotation Responses

Attribute Name Data Type Description
value Response[]

public annotation ServiceConfig

Attribute Name Data Type Description
host string
schemes string[]
interface string
authorizations Authorization[]

public annotation ServiceInfo

Attribute Name Data Type Description
title string
serviceVersion string
description string
termsOfService string
contact Contact
license License
externalDoc ExternalDoc
tags Tag[]
organization Organization
developers Developer[]

public annotation Swagger

Attribute Name Data Type Description
swaggerVersion string
extension SwaggerExtension[]

public annotation SwaggerExtension

Attribute Name Data Type Description
target string

public annotation Tag

Attribute Name Data Type Description
name string
description string