-
-
Notifications
You must be signed in to change notification settings - Fork 487
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
Update Swagger definition in order to be compatible with string identifiers #1198
Conversation
@wbloszyk, could you please confirm if the sandbox is working fine without these restrictions? |
In |
AFAIK, the @apidoc annotations are used to build the Open API Specification, which is consumed by the built-in sandbox to display the information which you are referencing and to create the "Try it out" forms. It also can be consumed by 3rd party compatible clients. |
If you can, please check the resulting definition at Swagger Editor. You can also play with the changes you're proposing in order to check if the result works as expected.
I wouldn't use "UUID" as type, since their type is really a string. |
For swagger for path parameter you have to: @SWG\Parameter(name="id", in="path", type="string") Type must be "string", "number", "integer", "boolean", "array", "file". |
Why do you think is not a good idea? IMO, we could use |
Could you please rebase your PR and fix merge conflicts? |
688182d
to
b2bfba6
Compare
Thanks @phansys |
Subject
Update OpenAPI (Swagger) definition in order to be compatible with string identifiers (like UUIDs).
These changes are consistent with the API narrowing made at sonata-project/admin-bundle (see
AdminInterface::id()
).I am targeting this branch, because these changes respect BC.
Changelog