2.2 Overview of the API Reference

Figure 2-1 identifies key areas of the Migrate API reference documentation. Each area is described below.

Figure 2-1 Layout of PlateSpin Migrate API Reference Documentation

2.2.1 API Version

Version 2019.8 is the latest release version of PlateSpin Migrate API. As development continues, we expect breaking changes to require a new release version. When a new version is released, we currently plan to support the prior version for up to one year from that date.

2.2.2 Open API Specification

The Migrate API is based on the specified Open API Specification. You can download the Open API Specification and use it to generate client libraries through the Swagger toolset. We have not tested this capability of the Swagger toolset.

2.2.3 Migrate Resources

Migrate Resources represent paths that can be called to support operations. Expand a section to see the methods of interaction that are allowed with the resource, such as GET, POST, PUT, or DELETE.

For example, you can expand the Platforms resource to show valid operations. See Figure 2-2.

Figure 2-2 Methods of Interaction Allowed for Platforms Resources

To learn more about how to navigate the API reference to understand the resources, methods, operations, and relationships, continue with Section 2.3, Exploring Migrate Resources.

2.2.4 Schemas

The Schemas option at the bottom of the Migrate API landing page provides definitions of data types that can be passed or returned. See Section 2.4, Exploring Schemas.