REST configuration files

Place the YAML Swagger and JSON configuration files that you create in subdirectories of the Integration directory in the Guidewire Studio Project window:
  • configuration > config > Integration > ...

The Integration folder contains the following directory structure.

/apis
The Integration > apis folder contains the following types of files.
File type Description
name-version.swagger.yaml Describes the Swagger schema to use with the REST API, including:
  • The endpoints the REST API supports
  • The methods each path supports
  • The schema responses to expect
published-apis.yaml Controls which Swagger schemas the REST servlet exposes. Every API that file published-apis.yaml lists is addressable through the REST servlet.
/filters
The Integration > filters folder contains the following types of files.
File type Description
name-version.gql Provides GraphQL-style filters; the filter serves as a white list of properties to include with object fields to actually materialize and serialize.
/mappings
The Integration > mappings folder contains the following types of files.
File type Description
name-version.mapping.json Describe how to transform PolicyCenter data into a JSON object that conforms to a specific JSON schema document.
/schemas
The Integration > schemas folder contains the following file types.
File type Description
name-version.schema.json Describes the structure of a JSON object with which an API client interacts.
schema_reserved_words.txt Defines a set of reserved words that are impermissible to use as JSON schema property names.