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 Endpoint operation headers disappeared in latest version #1025

Closed
neptunecentury opened this issue Sep 18, 2024 · 11 comments
Closed

API Endpoint operation headers disappeared in latest version #1025

neptunecentury opened this issue Sep 18, 2024 · 11 comments

Comments

@neptunecentury
Copy link

Hi, we have been using the CDN with version 9.3.4 for some time, and the side navigation operation headers were showing before. After this recent update in 9.3.5, the navigation tags are missing.
image

I have manually downloaded 9.3.4 and removed CDN for now until the issue is resolved. Is there anything on my end I need to update to get this working again?

Thanks

@mrin9
Copy link
Collaborator

mrin9 commented Sep 18, 2024

can you provide me with a small sample spec where i can reproduce this ?

The example which uses RapiDoc 9.3.5 works fine

@douglasg14b
Copy link

We're also seeing the same thing on all of our Rapidoc sites

@neptunecentury
Copy link
Author

Actually, the demo page for Azure AD is broken too.
You can see it here:
https://rapidocweb.com/examples/api-demo.html
Select AzureAD from options on the right and you will see the headers missing

@mrin9
Copy link
Collaborator

mrin9 commented Sep 18, 2024

it is showing fine on my system Macbook (on chrome and safari)
image

@neptunecentury
Copy link
Author

it is showing fine on my system Macbook (on chrome and safari) image

image

The header in your screenshot is missing. Circled red

@neptunecentury
Copy link
Author

The gitlab example is working
image

@mrin9
Copy link
Collaborator

mrin9 commented Sep 18, 2024

okay got it, lemme check

@mrin9
Copy link
Collaborator

mrin9 commented Sep 18, 2024

@neptunecentury is your sepc swagger: "2.0" ?

@neptunecentury
Copy link
Author

neptunecentury commented Sep 18, 2024

Well, we generate swagger 2.0, but use an API to convert it to OpenAPI v3 using the swagger converter here https://converter.swagger.io/api/convert

It generates OpenAPI 3 spec

{"openapi":"3.0.1","info":{"title":"API Reference","description":"## Status Codes a...

@douglasg14b
Copy link

We generate 3.0 directly, if that's relevant.

@mrin9 mrin9 closed this as completed in 0373835 Sep 18, 2024
@mrin9
Copy link
Collaborator

mrin9 commented Sep 18, 2024

Is now fixed in release 9.3.6

It was introduced due to a new vendor-extention x-displayName that was added which allows you to provide more descriptive definitions for the tags. like shown below

paths:
  /path:
    get:
      summary: Endpoint
      tags:
        - xyz-id
tags:
  - name: xyz-id
    x-displayName: Custom Tag Name
    description: Custom Tag Description

Refer to https://github.com/rapi-doc/RapiDoc/blob/master/docs/specs/tag-displayname.yaml for its usage

Thanks for pointing out the issue !!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants