Resources
Last updated
Last updated
Add a new resource to the API definition, you can then concatenate more methods to the same resource: methods(),description(),header(),parameter(),placeholder(),schema(),sample()
Define a default return format for a resource
Add a description to a resource
Add methods to a resource
Define a default HTTP method for a resource
Argument
Type
Required
Default
Description
pattern
any
Yes
---
The SES pattern to register for the resource
handler
any
No
---
The description of the parameter
action
any
No
---
Is the parameter required or not
Argument
Type
Required
Default
Description
format
any
Yes
---
The format that will be the default
Argument
Type
Required
Default
Description
description
any
Yes
---
The description
Argument
Type
Required
Default
Description
methods
any
Yes
---
The methods list to allow
Argument
Type
Required
Default
Description
method
any
Yes
---
The HTTP method that will be the default