Unable to open the Access Control swagger REST API documentation page in the UI
search cancel

Unable to open the Access Control swagger REST API documentation page in the UI

book

Article ID: 435366

calendar_today

Updated On:

Products

VCF Automation

Issue/Introduction

  • You are logged into the VM Apps organization in VMware Cloud Foundation Automation as an Admin.
  • In VCF Automation 9.0.2, you are attempting to open the link for Access Control in the API Help Center documentation  > Automation APIs > Access Control
  • Or you may be accessint he direct link at https://<VCFA appliance_FQDN>/automation/api-docs/#/automation-apis and the Access Contol page is not accessible
  • The following error is presented: 
    "Errors
    Parser error on line 21
    end of the stream or a document separator is expected"
    "Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.x.y (for example, openapi: 3.1.0).

Environment

VCF Automation 9.0.2

Resolution

This is a known issue in 9.0.2, and it is planned to be fixed in a future release. 

To work around the issue:

  1. The raw json spec can be accessed with the following URLs:
    <vcfa-host>/tm/api-explorer/tenant/<your_tenant>/orgForVmApps.json
    <vcfa-host>/tm/api-explorer/tenant/<your_tenant>/orgForAllApps.json 

     

  2. API documentation is also available from the Broadcom Developer Portal at https://developer.broadcom.com/xapis/org-management-vm-apps-org/latest/

Additional Information

https://vmw-jira.broadcom.net/browse/VCFAPR-1406