apigee-api-catalog-drupal icon indicating copy to clipboard operation
apigee-api-catalog-drupal copied to clipboard

Published 20 hours ago • verified publisher icon apigee

Error: "Page not found" when trying to access developer portal documentation (Drupal + SmartDocs)

Open yuryninog opened this issue 1 year ago • 8 comments

Description

Using Drupal 9.5 and configuring SmartDocs as API Documentation tool, e get the message "Page not found". We have opened the "network" tab in the explorer inspector and saw that the smartdocs libraries are being referenced correctly and the OpenAPI 3.0 specification of the product is also loading correctly in the session storage

Steps to Reproduce

Steps to reproduce the behavior:

  1. Set up our developer portal in Drupal 9.5.8 using smardocs in order to render API products documentation.
  2. Open a specific documentation.
  3. We get the message "Page not found". We have opened the "network" tab in the explorer inspector and saw that the smartdocs libraries are being referenced correctly and the OpenAPI 3.0 specification of the product is also loading correctly in the session storage.

Actual Behavior

According to the official documentation, the use of smartDocs is allowed with Drupal, however we got the error described before.

Expected Behavior

We would like to identify the root cause of this issue and getting the documentation with SmartDocs.

Screenshots

Attached.

Notes

Add any other context about the problem here.

Version Info

ApigeeX Drupal 9.5.8

yuryninog avatar Feb 09 '24 01:02 yuryninog

Hi @yuryninog

Could you check if you are able to see /apis page?

shishir-intelli avatar Feb 12 '24 11:02 shishir-intelli

Could you also please check if Smartdoc is selected on OpenAPI specification field format in settings.

  • Log in to your portal as a user with admin or content creation privileges.
  • Go to Structure > API Doc settings > Manage display in the admin menu.
  • Change the OpenAPI specification field format to use the SmartDocs.

Example: image

shishir-intelli avatar Feb 12 '24 12:02 shishir-intelli

Hi! @shishir-intelli

Thank you so much for your follow up ... Indeed that is the configuration that we followed ... I am attaching the evidence: evidence_01 evidence_02

yuryninog avatar Feb 12 '24 13:02 yuryninog

Hi @yuryninog

Try this:

  • Go to Configuration > Development > Performance page.
  • In Bandwidth optimization tab, uncheck the Aggregate JavaScript files checkbox.
  • Save Configuration.
  • Clear the cache

image

If still you are not able to see the page, please share the console logs to investigate more on this issue.

shishir-intelli avatar Feb 14 '24 05:02 shishir-intelli

Hi! @shishir-intelli

Thank you so much! for this information. We have followed these instruction, but it still doesn't work. I really appreciate your support since this feature is critical in an implementation that we are running in the Google PSO Team.

image

yuryninog avatar Feb 14 '24 22:02 yuryninog

Hi @yuryninog

Could you please share us:

  • Screenshot of errors in the console logs or the HAR file.
  • The output of command composer show.

Note: Drupal 9 has reached its end of life, its essential to upgrade to Drupal 10.

shishir-intelli avatar Feb 15 '24 04:02 shishir-intelli

Hi! @shishir-intelli

Thank you so much! for your flawless support. I really appreciated it. According our separated conversation, I will sent you the screenshots there.

Again! thank you so much!

yuryninog avatar Feb 15 '24 15:02 yuryninog

Can you try updating your language selection to use Session Detection method. This will allow language to be selected from request parameter instead of the base path.

image image

giteshk avatar Apr 10 '24 16:04 giteshk