Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Generate a complete OpenAPI specification from REST service rules (8.4)

Updated on May 3, 2021

Automatically generate a complete and accurate OpenAPI Specification (OAS) by using REST Service rules. You can use the OAS to better understand how to use your REST API in your application.

With the following enhancements, you can produce a comprehensive description of your REST APIs:

  • Pega Platform uses relevant records to more clearly define the schema for page and page list outputs.
  • Map values to JSON or Clipboard in the request, or map values from JSON or Clipboard in the response.
  • Schema type definitions are more detailed and more accurately reflect the properties to which you mapped in the request or response.

The following figure shows an example of the OAS that you can generate by using the enhancements in a REST service rule:

OAS on the OpenAPI tab of a REST service rule.

REST service rules now support using an automation for the implementation method instead of an activity. Although creating automations is restricted in Pega Platform 8.4, you can take full advantage of this capability in an upcoming Pega Platform release.

For more information, see Creating a REST service.

  • Previous topic Retrieve large data sets with improved paging in data pages (8.4)
  • Next topic Discover, configure, and use application settings more easily (8.3)

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us