Operation

struct
Property Type Description
arguments All arguments provided to this operation. Each argument is mapped to a location from the HTTP request i.e. query or body
authorization Boolean Indicates whether this operation needs authorization, if set to false the client will not send an authorization header, default it is true
description String A short description of this operation. The generated code will include this description at the method so it is recommend to use simple alphanumeric characters and no new lines
method String The HTTP method which is associated with this operation, must be a valid HTTP method i.e. GET, POST, PUT etc.
path String The HTTP path which is associated with this operation. A path can also include variable path fragments i.e. /my/path/:year then you can map the variable year path fragment to a specific argument
return Response The return type of this operation. The return has also an assigned HTTP success status code which is by default 200
security
ArrayString
An array of scopes which are required to access this operation
stability Integer Indicates the stability of this operation: 0 - Deprecated, 1 - Experimental, 2 - Stable, 3 - Legacy. If not explicit provided the operation is by default experimental
throws All exceptional states which can occur in case the operation fails. Each exception is assigned to an HTTP error status code
part of the Apioo-Project