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 v2 management allows swagger config to have basepath and path both set to / #253

Open
csantanapr opened this issue Aug 3, 2017 · 7 comments

Comments

@csantanapr
Copy link
Member

When creating a new api, a swagger is sent to api management with both base path and operation path set to / the API doesn't error out.

To reproduce you should could use the WSK CLI

wsk api create / / get myaction
wsk api list -f
Action: /guest/myaction
  API Name: /
  Base path: /
  Path: /
  Verb: get
  URL: https://service.eu.apiconnect.ibmcloud.com/gws/apigateway/api/123/

api management doesn't return error to know that there is an invalid combination to have both base path and operation path set to /

@mdeuser
Copy link
Contributor

mdeuser commented Aug 3, 2017

If an API happens to be created with a basepath and path of / each, subsequent APIs created after this "/" API can be affected -> successful API creation followed by API invocation results in a 404 status code

@akrabat
Copy link
Member

akrabat commented Aug 4, 2017

FWiW, I would like this to work. I can't remember the last time I created an API that didn't have a root endpoint.

@mhamann
Copy link
Member

mhamann commented Aug 4, 2017

@akrabat but would you really want an API that has a root endpoint and basically no base path?

@akrabat
Copy link
Member

akrabat commented Aug 4, 2017

To be honest I have no idea what the base path is and how it differs from the api path.

I do want to be able to do curl https://my-cnamed-domain.com/ and get back a response. I expect that this API needs to be in it's own namespace for this to work though.

@csantanapr
Copy link
Member Author

I can see how a URL like "https://my-cnamed-domain.com/"
invokes a web action like "public/index" that receive a __ow-path with "/" returns the html content for a website

@akrabat
Copy link
Member

akrabat commented Aug 5, 2017

I can see how a URL like "https://my-cnamed-domain.com/" invokes a web action like "public/index" that receive a __ow-path with "/" returns the html content for a website

Yes. For APIs, I was thinking along the lines of the Home Documents for HTTP APIs proposal.

@mhamann
Copy link
Member

mhamann commented Aug 9, 2017

When it comes to the typical REST API, I don't know how often this scenario occurs. The HTML use case is the most compelling, given that you typically want a home document.

Obviously, this is a use case for Whisk itself, but is it one for the API gateway? Would someone typically front an HTML page with the gateway?

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

4 participants