search

totersapp / asana-integration-test

0 stars 0 forks source link

Fix & re-generate API docs #13

Open abbood opened 5 years ago

abbood commented 5 years ago

Business Value Added

Keep API docs up to date to avoid working with stale documentation which could incur bugs

Analysis

I (Joubran) worked on removing is_agora from the following tables: items, users and stores and I tried to re-generate the documentation using this command

php artisan api:doc --output-file=./wiki/...

however it failed due to multiple errors (fixing one reveals another one)

abbood commented 5 years ago

➤ Jad Joubran commented:

Sample failure:

[Doctrine\Common\Annotations\AnnotationException] [Syntax Error] Expected Doctrine\Common\Annotations\DocLexer::T_CLOSE_CURLY_BRACES, got ')' at position 660 in method App\Http\Controllers\RetailerCreate OrderController::create().However fixing one of these issues proceeds to the next error

abbood commented 5 years ago

➤ Jad Joubran commented:

Pushed my progress so far, fixed several issues with annotations however I'm stuck on this:

[InvalidArgumentException] Expected a string. Got: booleanit seems like an issue from dingo/api

abbood commented 5 years ago

➤ Jad Joubran commented:

I got stuck again on this issue If you add -vvv to get verbose output it shows no files coming from the app namespaces, all of them from the vendor so I'm not sure where it's breaking It could be fixable by updating the version of dingo/api but this would require a lot of testing so I'll keep this to [~iarnous] at the moment as he has more experience with this documentation package