Operation ids from same function name

[vitalik]

@api.get('/foo')
def operation(request):  #!
     pass

@api.get('/bar')
def operation(request):  #!
     pass

^ this is currently a valid and working code, but it generates two identical operation_IDs

it should validate if that happens and throw and error that operation id is already taken - pelase rename your function or set id manually

[yedpodtrzitko]

Hi,
should this really be a responsibility of the framework? To me it looks like a job for linting/static analysis tools. Both mypy or pylint (the most common tools for this purpose) are catching this kind of error. Seems good enough to me:

$ cat collide.py
def foo(): pass
def foo(): pass

$ mypy collide.py
collide.py:2: error: Name 'foo' already defined on line 1

$ pylint collide.py
collide.py:2:0: E0102: function already defined line 1 (function-redefined)

[vitalik]

hi @yedpodtrzitko

well it is, but technically it still a valid python code..
larger problem is here actually in operation id's - if they are the same - swagger ui basically blocks you from opening 2nd operation

[yedpodtrzitko]

well it is

sorry I'm not sure which things are you answering to - that it is part of framework's responsibilities or the CI tools?

but technically it still a valid python code..

yes. that's why the tools are able to detect and report such errors which are relatively easy to make.

larger problem is here actually in operation id's - if they are the same - swagger ui basically blocks you from opening 2nd operation

Maybe I'm missing here some piece of information - is operation a magic name which is expected to be present in order for the API docs to be generated? As such, more API endpoints in the same file would need to have the same name to get their docs generated? If not, then again - why not leave this to the CI tools?

[vitalik]

why not leave this to the CI tools?

because people do not do this :) and I already got lot of issues when functions are named the same

basically there two solutions here:

• either throw exceptoin or warning when same function name detected
• or OpenId operationId in sequence -> operation, operation_1, operation_2, , operation_3 automatically

[vitalik]

Maybe I'm missing here some piece of information - is operation a magic name which is expected to be present in order for the API docs to be generated?

https://swagger.io/docs/specification/paths-and-operations/

[vitalik]

0.12.3 - showing a warning
0.13.0 - will throw an error