WSInfo

Specify information about the Web service such as title, version, contact details, scopes, etc.

Syntax

WSInfo

Usage

You use this attribute to specify information that describes the service such as the service title, version, and contact details.

The WSInfo attribute must be set in an ATTRIBUTE() clause on the information record at the module level. This allows you to provide service information that is useful to clients.

WSInfo is an optional attribute.

Example using WSInfo in the service information record

The example service information record follows the OpenAPI standard.
Note:

The GWS does not check the record structure used with WSInfo attribute. You are therefore allowed to add the fields you want to be available in the OpenAPI specification.

# Web service server module

PUBLIC DEFINE serviceInfo
   RECORD ATTRIBUTE(WSInfo, WSScope = "myusers",
                    WSVersion = "myv2", WSVersionMode = "uri")
      title STRING,
      description STRING,
      termOfService STRING,
      contact RECORD
        name STRING,
        url STRING,
        email STRING
      END RECORD,
      version STRING
   END RECORD = ( title: "my service", version: "1.0",
                  contact: ( email:"helpdesk@mysite.com" ) )

# ... service functions ...