WSVersion (module)
Set a default set of operations to display in the OpenAPI documentation.
Syntax
WSVersion = "{
version }
"
- version is a string value setting the version of the Web service.
WSVersion
is an optional attribute.
Usage
You use this attribute to specify version at the module level. It activates versioning for the Web service.
WSVersion
attribute in the service information record of the
module. By doing this you specify the version of operations of the Web service that are displayed in
the OpenAPI document and in the generated stub file. WSVersion
at the module level, be aware that it
can only contain one value, and the value must not be called "default". Setting more than one version or setting
WSVersion ="default"
is only allowed with WSVersion
, but causes compilation
error-9140 to be thrown when detected at the
module level. 404 (Not found)
error response and internally
the server will throw error
41. - operations whose version name matches the version name set in the
WSVersion
of REST functions.Tip: First versionIt is possible to use a version name which is not used in any operation. This new version will only display operations without
WSVersion
or withWSVersion="default"
. This option is useful if you want to use versioning in the first release of your Web service (for example,WSVersion="v1"
), where, in fact, no operation has been versioned. It will introduce clients to the concept of version control in your Web service. - operations with a default
version. These are operations which are general to all versions as they either do not have a
WSVersion
set in the function or are set withWSVersion=default
.
To learn more setting a default version of operations, see Default version of the OpenAPI document.
Example using WSVersion in the information record
In the example, the WSVersion
is set to "v3". This defines version v3 as the
default version of operations displayed in the OpenAPI documentation of the Web service.
PUBLIC DEFINE serviceInfo RECORD ATTRIBUTE(WSInfo, WSScope="users", WSVersion="v3")
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") )
WSInfo
attribute) is to document the REST service. If you are not setting the
version at the modular level here, the record is still needed to provide service information.