Working with schema parameters

It is possible for a resource to define, and use, any of the following parameter types:
  • path
  • query
  • header
  • body

In Swagger files, the 'in' field on the parameters element defines the parameter type, 'in: path', or, 'in: query', for example.

Depending on the type of parameter, it is possible to specify a constraint that ensures the request conforms to expected schema definition.

The Guidewire x-gw-type property

In addition to the standard parameter options specified in the Swagger schema 2.0, Guidewire supports a custom x-gw-type property for the following parameter types:
  • path
  • query
  • header
The value of a x-gw-type property must be a typecode from a valid PolicyCenter typekey. The following Swagger code snippet illustrates this concept.
/destinations/{destinationId}/retry:
    post:
      summary: "Retry messages for a destination that had errors"
      description: ''
      operationId: retryMessages
      parameters:
      - $ref: "#/parameters/destinationId"
      - name: retryLimit
        in: query
        required: false
        type: integer
        format: int32
      - name: category
        in: query
        required: false
        type: string
        x-gw-type: typekey.ErrorCategory
      ...