feat: Increase config version add new config key for documentation saving and check directory existing #127
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
-increase config version -on documentation saving directory should be created if not exists
add new config key for documentation saving and check directory existing
…agger into change-drivers-config
DenTray
reviewed
Apr 30, 2024
config/auto-doc.php
Outdated
| @@ -128,7 +128,7 @@ | |||
| 'drivers' => [ | |||
| 'local' => [ | |||
| 'class' => LocalDriver::class, | |||
| 'production_path' => storage_path('documentation.json') | |||
| 'production_path' => storage_path(env('SWAGGER_DOCUMENTATION_PATH', '/swagger/documentation.json')), | |||
There was a problem hiding this comment.
please move directory as a separate config key
src/Drivers/LocalDriver.php
Outdated
| @@ -18,6 +18,10 @@ public function __construct() | |||
| if (empty($this->prodFilePath)) { | |||
| throw new MissedProductionFilePathException(); | |||
| } | |||
|
|
|||
| if (!is_dir(dirname($this->prodFilePath))) { | |||
| mkdir(dirname($this->prodFilePath),0777, true); | |||
There was a problem hiding this comment.
Suggested change
| mkdir(dirname($this->prodFilePath),0777, true); | |
| mkdir(dirname($this->prodFilePath), 0777, true); |
src/Drivers/StorageDriver.php
Outdated
| @@ -21,6 +21,10 @@ public function __construct() | |||
| if (empty($this->prodFilePath)) { | |||
| throw new MissedProductionFilePathException(); | |||
| } | |||
|
|
|||
| if (!is_dir(dirname($this->prodFilePath))) { | |||
| mkdir(dirname($this->prodFilePath),0777, true); | |||
There was a problem hiding this comment.
I not sure that it will works for S3 or GCS drivers
DenTray
requested changes
May 14, 2024
config/auto-doc.php
Outdated
| @@ -128,7 +128,7 @@ | |||
| 'drivers' => [ | |||
| 'local' => [ | |||
| 'class' => LocalDriver::class, | |||
| 'production_path' => storage_path('documentation.json') | |||
| 'production_path' => storage_path(env('SWAGGER_DOCUMENTATION_PATH', '/swagger').DIRECTORY_SEPARATOR.'documentation.json'), | |||
There was a problem hiding this comment.
Suggested change
| 'production_path' => storage_path(env('SWAGGER_DOCUMENTATION_PATH', '/swagger').DIRECTORY_SEPARATOR.'documentation.json'), | |
| 'file_name' => 'documentation.json', | |
| 'file_path' => env('SWAGGER_DOCUMENTATION_PATH', 'documentation'), |
tests/LocalDriverTest.php
Outdated
| $productionPath = __DIR__ . '/../storage/non_existent_directory/documentation.json'; | ||
| config(['auto-doc.drivers.local.production_path' => $productionPath]); | ||
|
|
||
| mkdir(dirname($productionPath), 0777, true); |
There was a problem hiding this comment.
directory should be created by the testable class, not via the native php function
|
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.
feat: Increase config version
add new config key for documentation saving and check directory existing