Allowing user to set "AUTH_TOKEN" in env to download privately hosted schema as well

[manzarul]

In certain use cases where OpenAPI specifications reference schemas hosted on private URLs, it's important to support authentication to allow access to these resources. I identified this section of code that resolves schema references. To enable seamless access to private URLs, I propose extending the functionality to include an Authorization header if a user sets an authentication token via an environment variable. This way, when the schema reference is hosted on a private server, users can authenticate by setting the auth token in their environment, allowing the private URL to be accessed.

Description

Allowing user to "AUTH_TOKEN" in env to download privately hosted schema as well.

Motivation and Context

Currently Editor can resolve only ref which is publicly available , but if we add this then it can allow to resolved authenticated url as well.

Not sure!

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• No code changes (changes to documentation, CI, metadata, etc)
• Dependency changes (any modification to dependencies in package.json)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[char0n]

Hi @manzarul,

swagger-client is an isomorphic library - it must work in browser and Node.js like environment. Reading environment variables is platform specific thing.

I would say, that what you're trying to achieve if fully possible by using requestInterceptor. Please see the following docs section, and let me know if it resolves your requirement:

• https://github.com/swagger-api/swagger-js/blob/master/docs/usage/http-client.md#loading-specification
• https://github.com/swagger-api/swagger-js/blob/master/docs/usage/http-client.md#request-interceptor