(PC-31492)[API] feat: improve public api doc #5880

Job	Run time
Init job	39s
Tests pro	0s
MyPy cop / MyPy cop test	36s
[pcapi-console] build docker image. / Build pcapi-console:85fd2620912fde14c57eeb8922849d6ce73ef604	3m 34s
Tests API documentation / Check API documentation can be built	1m 4s
[pcapi] build docker image. / Build pcapi:85fd2620912fde14c57eeb8922849d6ce73ef604	2m 20s
[pcapi-tests] build docker image. / Build pcapi-tests:85fd2620912fde14c57eeb8922849d6ce73ef604	3m 47s
Dependabot	0s
[PRO] Deploy PR version for validation	0s
Tests pro E2E migrations / E2E tests and notifications	7m 52s
Tests pro E2E / E2E tests and notifications	8m 39s
Update api client template / Update API Client template	4m 53s
Tests api / Pylint	4m 6s
Tests api / Quality checks	2m 59s
Tests api / Pytest (tests/core/bookings tests/core/offers tests/core/finance)	5m 16s
Tests api / Pytest (tests/core --ignore=tests/core/bookings --ignore=tests/core/offers --ignore=tests/core/fi...	5m 12s
Tests api / Test database schema	3m 1s
Tests api / Pytest (tests/routes -m 'not backoffice')	6m 45s
Tests api / Pytest (tests --ignore=tests/core --ignore=tests/routes)	3m 7s
Tests api / Pytest (tests/routes/backoffice -m 'backoffice')	12m 28s
Push pcapi-console docker image to registry	0s
Push pcapi docker image to registry	0s
	1h 16m 18s

Provide feedback