pyramid_openapi3 messes up routes when the server prefix matches

[Wim-De-Clercq]

openapi.yaml:

servers:
  - url: /v
paths:
  /version:
    get:
      ...

pyramid config:

config.add_route("version", "/version")

(along with this config to deal with the prefix on the server)

[filter:paste_prefix]
use = egg:PasteDeploy#prefix
prefix = /v

This code

pyramid_openapi3/pyramid_openapi3/__init__.py

Lines 371 to 377 in 2904c34

	def remove_prefixes(path):
	path = f"/{path}" if not path.startswith("/") else path
	for prefix in prefixes:
	if path.startswith(prefix):
	prefix_length = len(prefix)
	return path[prefix_length:]
	return path

Will remove the /v from /version and then complain that route "/version" is missing even though it is clearly present in the code. Are prefixes ever part of the route that they need to be removed?

[zupo]

Huh, I've personally never used paste_prefix before so don't have any intuition into what could be wrong.

Can you provide a minimal runnable example that exercises this bug? Ideally as a fork of this repo and add it to the examples/ folder, so we can run it in CI from now on and make sure prefixes keep working.

[Wim-De-Clercq]

I've made an example here #147

You'll see it's a bit different because I don't know how else to replicate a proper pserve startup with the from wsgiref.simple_server import make_server code from the other example apps.
(/app and /applications as a route was probably a little more realistic than just /v and /version... anyway.)
Looking at https://swagger.io/docs/specification/api-host-and-base-path/

Examples of the url are

servers:
  - url: https://api.example.com/v1 
  - url: https://api.example.com/v1
    description: Production server (uses live data)
  - url: https://sandbox-api.example.com:8443/v1
    description: Sandbox server (uses test data)
  - url: https://{customerId}.saas-app.com:{port}/v2
  - url: /v2

Surely nobody is writing that in the routes. So is there a need to remove them ever?
In my opinion the fix to this issue would be to just remove the code that removes the prefixes. I don't really see a scenario where the routes would contain those server urls.
However, the code is not written without a reason. Maybe this setup creates different routes than other ones?
(original ticket #97)

Edit: Well I guess it's possible that people actually write /v1/ etc as part of the routes and then update all the routes for every version... Maybe an extra check should be added for the slash after the prefix then.

[zupo]

Surely nobody is writing that in the routes.

What exactly is that in this sentence?

[Wim-De-Clercq]

Surely nobody is writing that in the routes.

What exactly is that in this sentence?

Any of the url examples from openapi.yaml.

[zupo]

I often use the following:

servers:
  - url: /api

See https://github.com/niteoweb/pyramid-realworld-example-app/blob/master/src/conduit/openapi.yaml#L625