-
Notifications
You must be signed in to change notification settings - Fork 3
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
Meta views #480
Merged
Merged
Meta views #480
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lective structures
…est wrapper returning a format instance
…for remaining types
… with classnames, not hardcoded strings
…rly using a stdClass)
…e done using Validators (except for nullability/required)
…rter, changed param attribute argument order
…s well (no actual behavioral changes, all the changed endpoint parameters were optional so nullable by default, now they are explicitly nullable as well)
…sh set of format names
krulis-martin
approved these changes
Mar 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added the new concept of formats. Formats are classes that streamline request parameter validation. There are two types of formats:
@param
and@Param
endpoint annotations to make the syntax more consistent, add syntax highlighting, and add more control over parameter validation with Validator classes.A new command
meta:convert
was added that can convert@param
and@Param
endpoint annotations to loose format attributes.The swagger generator was made dependent on the new format attributes and newly includes endpoint descriptions, value examples based on format type, and array type support.
The existing endpoints were converted using
meta:convert
. TheBasePresenter
was refactored to validate requests using the new format attributes. TheRegistrationPresenter::actionCreateInvitation
endpoint was refactored to use a format class as an example.PATH parameters are not validated yet, but were assigned loose format attributes. Nested format classes are not yet supported.