Annotations of ballerina.net.http.swagger package
annotation Authorization
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
name | string | |
description | string | |
authType | string | |
apiName | string | |
in | string | |
flow | string | |
authorizationUrl | string | |
tokenUrl | string | |
authorizationScopes | AuthorizationScope[] |
annotation AuthorizationScope
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
name | string | |
description | string |
annotation Header
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
name | string | |
description | string | |
headerType | string |
annotation Item
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
itemType | string | |
format | string | |
collectionFormat | string | |
items | string |
annotation ParameterInfo
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
in | string | |
name | string | |
description | string | |
required | boolean | |
allowEmptyValue | string | |
parameterType | string | |
format | string | |
collectionFormat | string | |
items | Item[] |
annotation ResourceConfig
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
schemes | string[] | |
authorizations | Authorization[] | |
name | string | |
scopes | string[] |
annotation ResourceInfo
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
tags | string[] | |
summary | string | |
description | string | |
externalDoc | ExternalDoc |
annotation Response
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
code | string | |
description | string | |
response | string | |
headers | Header[] | |
examples | Example[] |
annotation ServiceConfig
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
host | string | |
schemes | string[] | |
interface | string | |
authorizations | Authorization[] |
annotation ServiceInfo
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
title | string | |
version | string | |
description | string | |
termsOfService | string | |
contact | Contact | |
license | License | |
externalDoc | ExternalDoc | |
tags | Tag[] | |
organization | Organization | |
developers | Developer[] |
annotation Swagger
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
version | string | |
extension | SwaggerExtension[] |