WSDescription

Specifies a description.

Syntax

WSDescription

Usage

You use this attribute to provide a useful description related to the function. You set the WSDescription attribute in the ATTRIBUTES() clause of the function.

Information you specify with this attribute, is generated in the "paths" section for the function in the OpenAPI specification file.

Example using WSDescription

PUBLIC FUNCTION deleteUserProfile(
    id STRING ATTRIBUTE(WSParam) )
  ATTRIBUTES (WSDelete,
              WSPath="/users/{id}",
              WSDescription='Deletes a user profile',
              WSThrows='404:user not found' )
  RETURNS STRING
    DEFINE ret STRING
    # ... function code  ...
    LET ret = SFMT("Deleted user with ID: %1",id)
    RETURN ret
END FUNCTION