Within the context of Cloud API, a swagger file defines the endpoints and operations for a given API. Typically, there is no need for an insurers to configure a Cloud API swagger file.
Swagger files are stored in the
Swagger file syntax
A swagger file can contain a section that defines an API. For example, the following
is a portion of the
common_pl-1.0.swagger.yaml file, which defines
the Common API.
swagger: "2.0" info: title: "Common API" description: "APIs for common InsuranceSuite platform objects like activities and notes" version: "1.4.0" basePath: /common/v1 consumes: - application/json produces: - application/json
A swagger file can also contain a
paths section, which defines a set
of endpoint paths and the associated operations and resources for that path. For
example, the following is a portion of the
common_pl-1.0.swagger.yaml file, which defines the first path
in the Common API,
paths: /activities: get: summary: "Retrieve the `Activity` elements that are assigned to the caller" description: "Retrieves the `Activity` elements that are assigned to the caller" operationId: getActivities x-gw-extensions: childResourceType: Activity operationType: get-collection resourceType: Activities x-gw-parameter-sets: - get-collection responses: "200": description: "The paginated list of `Activity` elements" schema: $ref: "#/definitions/ActivityList"