How to extract yaml files referenced in pega native REST services

General
, , ,
1

Hello !
We are currently trying to expose native REST services in our own service package. Our front team who will use those services would like to have access to our yaml files but it seems that some native services are referring internal yaml files :

  • $ref: “webwb/pzData.yaml”
  • $ref: “webwb/pzUIResources.yaml”
  • $ref: “webwb/pzGetFeed.yaml”
  • $ref: “webwb/pzNextAssignment.yaml”

Unfortunately it seems that those files are nowhere to be found. Is there a way to access them to create a custom yaml file ?

2

@maximeBricet does the information in the documentation OpenAPI Specification in Pega Platform help at all?

3

@MarijeSchillern Hello Marije, I have the same question like Maxime and the link that you have provided unfortunately does not answer the question. As Maxime states above, when accessing the YAML file on the OpenAPI tab of the OOTB Pega API service package (e.g. the application package), then we find references to other files in there:

       content:
            application/json:
              schema:
                $ref: "#/components/schemas/SCHEMA_FILE_WEBWB_PZGETASSIGNMENT"

Because of the reference to “#/components/schemas/SCHEMA_FILE_WEBWB_PZGETASSIGNMENT” and other such references we don’t have a complete YAML file and it is also not clear where to find the referenced files.

4

@SEIFM thanks for the additional context. This will need the relevant SME’s input.

I believe that previous questions about this had the response that it is designed like this - there is no Option to export OAS doc (complete yaml) for DX API.

The OAS generation functionality was intended to be used as ‘preview’ only and not with the purpose of being exported to external consumers systems. To improve performance, the OAS generation does not generate all the referenced endpoints.

Main documentation:

Generating OpenAPI Specification documentation for application-specific REST APIs

OpenAPI Specification in Pega Platform

Best practices for generating OpenAPI Specification documentation#

@maximeBricet

I have been informed by the SME that the product team are aware of this issue and have plans to address this in a future roadmap.

cc

@nvkap