Support for OpenAPI Links?

[fsabr]

Is there support for OpenAPI Links? I couldn't find it anywhere.

Manually adding the following to the docstring works

links:
    Get User By Id:
        operationId: UserGet
        parameters:
            id: $response.body#/id

but I don't think the validation part works, as something like this

links:
    Get User By Id:
        operationId: UserGet
        parameters:
            id: RandomString

also validates (using apispec.utils.validate_spec).

[lafrech]

Hi.

There is currently nothing in apispec to provide a link feature.

If it works by writing the link manually in the docstring, that's fine.

I can't look into it right now, but if there's anything apispec could do to make it less manual (and avoid typos), then suggestions are welcome.

The validation feature is just a wrapper to an external validator (prance). The fact that validation passes has nothing to do with apispec support but only with the parsers used by prance.

[mjpieters]

See the Links section on swagger.io.

apispec could generate this, with a little help:

• It has enough information to produce operationRef values if no operationId is available.
• you'd need a way of mapping path parameters to schema fields

The latter is a lot easier if you are using a web server framework with plugins; e.g. you could mark up Marshmallow fields to mark them as identifiers, then link those with Flask-Smorest route parameters.