The Swagger Response object

The Response object describes a single response from an API operation. Guidewire does not support the following properties from the Swagger 2.0 specification on the Swagger Response object:
  • examples

Required properties

Property Type Description Combination style
description string Required if not using $ref. Documentation only. First non-null

Required properties

Property Type Description Combination style
$ref string

References a response defined on the Swagger root document. It is not possible to combine this property with any other properties.

Use the following syntax for the string value:
  • #/responses/name
 First non-null
headers map<string, header>

The keys (string values) of the map are the names of custom HTTP headers that it is possible to return with the response.

 Merge by key
schema Response schema object Defines the schema to which the response body must conform, if any. First non-null