@@ -4,33 +4,50 @@ Designed to work with [Laravel JSON:API](https://laraveljsonapi.io/)
44
55!!! Disclaimer: this project is work in progress and likely contains many bugs, etc !!!
66
7+ ## What it can and can't
8+
9+ ### Can
10+
11+ - [x] Generate Schemas/Responses/Request/Errors for all default [ Laravel JSON: API ] ( https://laraveljsonapi.io/ ) routes
12+ - [x] Use a seeded database to generate examples
13+
14+ ### Can't yet
15+ - [ ] Customisation of the generation
16+ - [ ] Generation for custom actions
17+ - [ ] Generation for custom filters
18+ - [ ] Generation for anything custom
19+ - [ ] Generation for MorphTo relations (MorphToMany works)
20+ - [ ] Generation of Pagination Meta
21+ - [ ] Generation of Includes
22+ - [ ] Generation of Authentication/Authorization
23+
724## TODO
825
926- [x] Command to generate to storage folder
1027- [x] Get basic test suite running with GitHub Actions
1128- [x] Add extra operation descriptions via config
1229- [x] Add in tags & x-tagGroups (via config)
1330- [x] Add tests (Use the dummy by laraveljsonapi to integrate all features)
14- - [x ] Add custom actions
31+ - [ ] Add custom actions
1532- [x] Split schemas/requests/responses by action
1633- [ ] Consider field attributes
1734 - [x] bool readonly
1835 - [x] bool hidden
1936 - [ ] closure based readonly (create/update)
2037 - [ ] closure based hidden
21- - [ ] List sortable fields
38+ - [x ] List sortable fields
2239- [ ] Fix includes and relations
2340 - [x] Add relationship routes
2441 - [ ] Add includes
2542- [ ] Add authentication
2643- [ ] Add custom queries/filters
2744- [ ] Add a way to document custom actions
2845- [ ] Tidy up the code!!
29- - [ ] Replace ` cebe/php-openapi ` with ` goldspecdigital/oooas `
30- - [ ] Move to an architecture inspired by ` vyuldashev/laravel-openapi `
46+ - [x ] Replace ` cebe/php-openapi ` with ` goldspecdigital/oooas `
47+ - [x ] Move to an architecture inspired by ` vyuldashev/laravel-openapi `
3148- [ ] Use php8 attributes on actions/classes to generate custom docs
3249
33- 🙏 Based upon initial prototype by [ martianatwork] ( https://github.com/martianatwork )
50+ 🙏 Based upon initial prototype by [ martianatwork] ( https://github.com/martianatwork ) and [ glennjacobs ] ( https://github.com/glennjacobs )
3451
3552## Usage
3653
0 commit comments