helm-swagger-ui icon indicating copy to clipboard operation
helm-swagger-ui copied to clipboard

[cetic/swaggerui] Support for OpenAPI specification in YAML format

Open docktermj opened this issue 3 years ago • 0 comments

I see in the Configuration documentation that you have support for swaggerui.jsonUrl. Which seems to only support OpenAPI Specification in JSON format based on what I'm seeing at

https://github.com/cetic/helm-swagger-ui/blob/e46ca44cd1d623aaa8d99acd296baae50586f6aa/templates/deployment.yaml#L37-L41

I know that the swaggerapi/swagger-ui Docker container can accept a YAML OpenAPI Specification file as identified by the URL environment variable. Example:

docker run \
  --env URL=https://raw.githubusercontent.com/Senzing/senzing-rest-api-specification/master/senzing-rest-api.yaml \
  --name senzing-swagger-ui \
  --publish 9180:8080 \
  --rm \
  swaggerapi/swagger-ui

Can you support YAML files, too? Or at least provide a way to disable setting args: so that I can pass in the URL environment variable via .Values.deployment.extraEnv?

You may want to consider only using the URL environment variable. The technique currently used mutates the container. Most folks want immutable containers. Just a thought.

Thank you!

By the way, nice work!

docktermj avatar Nov 10 '21 21:11 docktermj