Feature/api documentation #10
Merged
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
…uration with areas and default area page redirection - added API documentation annotations as a kind of test on SecurityController
…references - created AbstractAPIController to clean controllers - fixed PartnerController and DoctrineCacheConverter to manage cache with controller forwarding when partner details are requested thanks to his email - cleaned SecurityController API documentation
…dels custom names and descriptions depending on Nelmio API doc bundle - cleaned PartnerController API documentation, DoctrineSubscriber, Partner and Client entities
…ller and PhoneController
…ler and nelmio_api_doc.yaml file
…ers and nelmio_api_doc.yaml file
…match() on request URI and CacheKernel with request called twice due to use of validate() method - defined correctly X-App-Cache-Id custom header as one of two keys for Vary header to differenciate cache storage
…as possible for collection or single resource - reviewed all controllers classes to take into account changes - need to produce functional tests later on controllers to strengthen them
…EOAS representation in schemas for requests which concern list results
… and improve full_list query parameter UX for API documentation
…o header and improve full_list query parameter UX for API documentation" This reverts commit 0eb6828.
… and improve full_list query parameter UX for API documentation
…tication with a refresh token - customized a particular entity and configuration to manage refresh token process - added this action to API documentation
…sting invalid refresh tokens in database each time a new refresh token is created - please note that a CRON job would be more adapted in this case
|
Merge accepted! Please note that: Manage a tests suite (functional tests and maybe a few unit tests) and also code reviews is the next and final step! |
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.
This branch manages API Documentation with application services. Please note that a JWT refresh token process was added to improve API.
This merge aims at testing better workflow with development and features branches added to master. No issue is referenced for this pull request.
This branch treated expected changes and "fixed" issue: #8
Configured API documentation on two different pages to separate consumer and administrator available actions
Customized Nelmio bundle API documentation Swagger UI with a particular recommended Twig template and CSS styles (no "Nelmio" header and hide "full_list" query parameter form without value to fill in, and changed empty value checkbox text) to improve UX
Detailed as much as possible API documentation (path & query parameters, request bodies, responses type & responses headers such as "cache" ones or others) and formatted also collection representation paginated results HAL responses
Created a SecurityController class to manage JWT process API documentation with annotations
Cleaned controllers with an AbstractAPIController class
Added a JWT refresh token process to simplify authentication action with single use to keep a better security approach
Added RefreshedTokenListener service class to delete all invalid existing refresh tokens in database
Fixed several detected bugs as concerns DoctrineCacheConverter cache list results, DoctrineSubscriber HTTPCache entity deletion, and "Vary" response header
Message: please accept this merge and be conscious multiple changes will be made later.