Forum Discussion

samej71's avatar
samej71
New Contributor
5 years ago

Two potential naming issues with api key authentication within SwaggerHub UI

I’m admittedly new to Swagger, and I’m having a hard time getting api_key working the way I believe it should be within the SwaggerHub UI.    The documentation at https://swagger.io/docs/specificat...
  • HKosova's avatar
    HKosova
    5 years ago

    Thanks for the additional details, I've passed them to the developers. To track the issue status you can open a support ticket and reference this thread and issue # STEAM-3967.

     

    The workaround seems to be to Save & refresh the editor after any changes in security schemes.

HKosova's avatar
HKosova
SmartBear Alumni (Retired)
5 years ago

Hi James,

 

I did some tests with security schemes, and the issue with empty authorizations list occurs if I import an external API definition containing security schemes, or add a new security scheme into an existing API. Saving the API and refreshing the page resolves the issue. Can you see if the issue persists after you refresh the editor page?

 

As for your questions about UI rendering of security scheme names vs their HTTP header names, hope this image helps clarify that:

 

  • samej71's avatar
    samej71
    New Contributor
    5 years ago

    Thank you for your reply. That is the functionality I was expecting, but not getting.

     

    It seems like refreshing the page triggered a "save" warning, so I let it save and after the refresh it was behaving as expected. However, after playing with it more, I was able to get it to break again. I updated the "name" attribute in YAML, let the UI "catch up" to the edit, then clicked the lock icon and the authorization dialog shows still shows the old value. You can see the updated YAML in the background and the old name value in the dialog.

     

    It seems like there is a bug where the UI stops fully reflecting the YAML contents. Some parts of the UI keep working, but other parts do not.

     

    I see a variety of cross-site warnings in the browser console, a TypeError, and some 404 errors. I'm not sure of any of these messages are related to the problem I'm experiencing.

     

    I am using Chrome Version 84.0.4147.105 (Official Build) (64-bit)

     

     

    • HKosova's avatar
      HKosova
      SmartBear Alumni (Retired)
      5 years ago

      Thanks for the additional details, I've passed them to the developers. To track the issue status you can open a support ticket and reference this thread and issue # STEAM-3967.

       

      The workaround seems to be to Save & refresh the editor after any changes in security schemes.

      • samej71's avatar
        samej71
        New Contributor
        5 years ago

        One more wrinkle: sometimes when I'm editing, I do not have a "Save" button at the top and it will be "Create New Version" instead. When this happens and I hit refresh, the page refreshes and I get a warning about unsaved changes, and usually my most recent edits are lost. At this point the button at the top says "Save" again and I can click it. It appears to remain "Save" for some period of time but at some point it is or becomes "Create New Version" and at that point I can no longer manually save my edits to the current version before hitting refresh.

         

        Thank you for your assistance. I will create a ticket.