Ballerina API Documentation

Annotations of ballerina.net.http.swagger package

annotation Authorization

Attributes:

Attribute NameData TypeDescription
namestring
descriptionstring
authTypestring
apiNamestring
instring
flowstring
authorizationUrlstring
tokenUrlstring
authorizationScopesAuthorizationScope[]

annotation AuthorizationScope

Attributes:

Attribute NameData TypeDescription
namestring
descriptionstring

annotation Contact

Attributes:

Attribute NameData TypeDescription
namestring
emailstring
urlstring

annotation Developer

Attributes:

Attribute NameData TypeDescription
namestring
emailstring

annotation Example

Attributes:

Attribute NameData TypeDescription
exampleTypestring
valuestring

annotation ExternalDoc

Attributes:

Attribute NameData TypeDescription
descriptionstring
urlstring

annotation Header

Attributes:

Attribute NameData TypeDescription
namestring
descriptionstring
headerTypestring

annotation Item

Attributes:

Attribute NameData TypeDescription
itemTypestring
formatstring
collectionFormatstring
itemsstring

annotation License

Attributes:

Attribute NameData TypeDescription
namestring
urlstring

annotation Organization

Attributes:

Attribute NameData TypeDescription
namestring
urlstring

annotation ParameterInfo

Attributes:

Attribute NameData TypeDescription
instring
namestring
descriptionstring
requiredboolean
allowEmptyValuestring
parameterTypestring
formatstring
collectionFormatstring
itemsItem[]

annotation ParametersInfo

Attributes:

Attribute NameData TypeDescription
valueParameterInfo[]

annotation ResourceConfig

Attributes:

Attribute NameData TypeDescription
schemesstring[]
authorizationsAuthorization[]
namestring
scopesstring[]

annotation ResourceInfo

Attributes:

Attribute NameData TypeDescription
tagsstring[]
summarystring
descriptionstring
externalDocExternalDoc

annotation Response

Attributes:

Attribute NameData TypeDescription
codestring
descriptionstring
responsestring
headersHeader[]
examplesExample[]

annotation Responses

Attributes:

Attribute NameData TypeDescription
valueResponse[]

annotation ServiceConfig

Attributes:

Attribute NameData TypeDescription
hoststring
schemesstring[]
interfacestring
authorizationsAuthorization[]

annotation ServiceInfo

Attributes:

Attribute NameData TypeDescription
titlestring
versionstring
descriptionstring
termsOfServicestring
contactContact
licenseLicense
externalDocExternalDoc
tagsTag[]
organizationOrganization
developersDeveloper[]

annotation Swagger

Attributes:

Attribute NameData TypeDescription
versionstring
extensionSwaggerExtension[]

annotation SwaggerExtension

Attributes:

Attribute NameData TypeDescription
targetstring

annotation Tag

Attributes:

Attribute NameData TypeDescription
namestring
descriptionstring


Menu

  • Annotations
    • Authorization
    • AuthorizationScope
    • Contact
    • Developer
    • Example
    • ExternalDoc
    • Header
    • Item
    • License
    • Organization
    • ParameterInfo
    • ParametersInfo
    • ResourceConfig
    • ResourceInfo
    • Response
    • Responses
    • ServiceConfig
    • ServiceInfo
    • Swagger
    • SwaggerExtension
    • Tag

Copyright 2017 Ballerina API Documentation