Add the ability to specify api via swagger in manifest #1078
Conversation
Adds the ability for swagger file specifying the api to be referenced in the manifest under project.config. The config name was chosen to be consistent with whisk-cli -c/--config option.
* Fix nil pointer error when no swagger present in undeploy * update godeps
pwplusnick
force-pushed
the
add_swagger_conf_to_manifest
branch
from
63eb7a4 to
3a39d3e
Compare
|
@pwplusnick we should add as a follow-on PR the i18n error/warning messages/strings specific to swagger (config) document parsing/mgmt. |
| "Rev": "78658fd2d1772b755720ed8c44367d11ee5380d6" | ||
| }, | ||
| { | ||
| "ImportPath": "github.com/ghodss/yaml", |
There was a problem hiding this comment.
Hey @pwplusnick, not sure how github.com/ghodss/yaml is different from gopkg.in/yaml.v2
There was a problem hiding this comment.
I can rewrite it, but it is used in a function I lifted from openwhisk-cli to do the swagger parsing. Ideally, we move that function to openwhisk-client-go and that dependency will get removed.
deployers/servicedeployer.go
Outdated
| return err | ||
| var err error | ||
| // Only deploy either swagger or manifest defined api, but not both | ||
| // Swagger API takes precedence |
There was a problem hiding this comment.
please add caps NOTE saying the same, Swagger API take precedence over the apis defined in manifest YAML.
| // Swagger API takes precedence | ||
| if deployer.Deployment.SwaggerApi != nil && deployer.Deployment.SwaggerApiOptions != nil { | ||
| err = deployer.createSwaggerApi(deployer.Deployment.SwaggerApi) | ||
| } else { |
| # | ||
| --> | ||
|
|
||
| # API Gateway |
There was a problem hiding this comment.
rename it to something more specific to API specifications?
| - the root key is now project as the open api specification is a project wide concept. | ||
| - a new `config` key specifying where the Open API Specification is located. | ||
|
|
||
| The `config` key under `project` in the manifest file specifies where the Open API Specification is located. The keyword `config` was chosen to remain consistent with the OpenWhisk CLI flag option. The Open API Specification describes in a JSON document the the base path, endpoint, HTTP verb, and other details describing the API. For example, the document above describes a GET endpoint at `/hello/world` that recieves JSON as input and returns JSON as output. |
There was a problem hiding this comment.
is it config or config-file in CLI? it says config-file here https://github.com/apache/openwhisk-cli/blob/07993fd22c5618ee153eade186369d7d6084d1b7/commands/api.go#L174
|
@pwplusnick are we checking if an action is a web action before creating an API using the specification? please confirm. |
|
@pritidesai It does not check to see if the action is a web action. In fact, this does not do much checking on the swagger at all. It does a few very basic checks to make sure the base bath is valid, but apart from that it does not check the swagger on the client side. It basically shoves the swagger up to the api gateway and looks for errors there. It might be a good follow up PR to actually properly parse the swagger, and do that kind of checking. |
pritidesai
changed the title
Adds the ability for swagger file specifying the api to be
referenced in the manifest under project.config. The config
name was chosen to be consistent with whisk-cli -c/--config
option.
Note: I'll be adding a few documentation updates at the end of the day