Adding examples to endpoints

I’m looking for a way to add examples.

I’m trying to add them with Blueprint.doc, but it seems they are thrown away by Blueprint._prepare_doc.

Is there some other way?

[lafrech]

I’ll make the int -> string change independently. I’d rather be sure about what the doc requires before doing it.

Regarding this change, I think it is complete. I just need to take the time to clean it up, maybe find a better attribute name. Then update changelog, release, etc.

[lafrech]

No, I think they do propagate already.

I just meant adding private attributes to external objects is a smell.

Generally, I’d rather have

    my_mapping[func_obj] = doc_dict

than

    func_obj._apispec = doc_dict

so as not to modify the view function object.

But the key (the view func) registered by a decorator would be wrong when the next decorator returns another view func.

By the time you want to get the doc dict, all you have is the decorated func object and the key in the mapping may be the func object before another decoration, so the link is lost.

No big deal. Let’s keep view func object attributes for now.