WSSummary

The WSSummary attribute allows you to provide a short, human-readable summary for a REST operation. It corresponds to the summary keyword in the OpenAPI specification.

Syntax

WSSummary=" summary "
Where:
  1. summary gives a concise summary of the function it is applied to.

WSSummary is an optional attribute.

Usage

Provides a concise description of the operation’s purpose, helping developers quickly understand the role of each endpoint. Complements WSDescription, which can be used for a more detailed explanation.

Example

FUNCTION getCustomer(
    id INTEGER ATTRIBUTE(WSParam))
    ATTRIBUTES(WSGet,
        WSPath = "/customer/{id}",
        WSTags = "Customer",
        WSSummary = "Retrieve a customer by ID",
        WSDescription = "Returns the customer details for the given ID")
    RETURNS(customerType)

END FUNCTION

OpenAPI

paths:
  /customer/{id}:
    get:
      tags:
        - Customer
      summary: Retrieve a customer by ID
      description: Returns the customer details for the given ID
      responses:
        '200':
          description: successful operation

Compilation rules

  1. WSSummary applies only to operation objects (functions exposed via Web Services).
  2. Accepted values: a single string.
  3. Must contain a value.

GWS engine

Length recommendation: keep the text short to ensure good display in Swagger UI and client documentation.

The GWS engine exports the WSSummary text to the OpenAPI document under the summary keyword. At runtime, the summary has no functional effect: it is used for documentation and tooling only.

fglrestful

fglrestful includes the summary text in the generated OpenAPI file.

The summary may also appear in generated client documentation to help developers quickly identify the purpose of each client function.