Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Catalog does not render API documentation when using YML specs. #152

Closed
wongjoey opened this issue Jan 11, 2022 · 3 comments · Fixed by apigee/apigee-devportal-kickstart-drupal#556 or #176
Assignees
Labels
bug Something isn't working

Comments

@wongjoey
Copy link

Description

When creating a new API to be published in Drupal, the plugin (see screenshot) indicates that yml, yaml and json are allowed.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Login as admin
  2. Click on Content > API Catalog
  3. Click on Add API Doc
  4. Fill in the mandatory fields
  5. Change Specification source type to File and select a spec file with extension of yml.
  6. Click Save
  7. Navigate back to API Catalog and click on the newly created API Doc.

Actual Behavior

The detailed API Doc page does not render any of the API spec (i.e. blank API page is displayed)

Expected Behavior

The detailed API Doc page should render all the resources and verbs of the API spec correctly.

Screenshots

image
image

Notes

Used kickstart profile in docker example provided on https://github.com/apigee/docker-apigee-drupal-kickstart

Version Info

Version: 8.x-2.6

@wongjoey wongjoey added the bug Something isn't working label Jan 11, 2022
@raakesh-blokhra raakesh-blokhra self-assigned this Mar 1, 2022
@raakesh-blokhra
Copy link

We are working on this issue. We will support *.yaml (YAML) file extensions and not *.yml as YAML is the preferred choice.

@mhottinger1
Copy link

Would it be possible to re-open this? Only having support for .yaml is a bit limiting since .yml is definitely a valid file extension for YAML files.

@raakesh-blokhra
Copy link

Hi @mhottinger1, as mentioned earlier, we do not plan to add support for *.yml. IF that changes, we will definitely reopen and confirm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment