We have been adding routes in YAML format, which provides an easy path for adding Markdown documentation. The reference route should be migrated.
Created attachment 125105 [details] [review] Bug 29072: Move reference route /cities spec to YAML This patch moves the /cities routes spec and related files into YAML so devs can use it as a reference for future routes. To test: 1. Run: $ kshell k$ prove t/db_dependent/api/v1/cities.t => SUCCESS: Tests pass 2. Apply this patch 3. Repeat 1 => SUCCESS: Tests still pass! 4. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Created attachment 125106 [details] [review] Bug 29072: Move reference route /cities spec to YAML This patch moves the /cities routes spec and related files into YAML so devs can use it as a reference for future routes. To test: 1. Run: $ kshell k$ prove t/db_dependent/api/v1/cities.t => SUCCESS: Tests pass 2. Apply this patch 3. Repeat 1 => SUCCESS: Tests still pass! 4. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Nice One! This is great, I'll stop defaulting to JSON now (as I often use this as a template for creating other new routes!) All works before and after patch, tests passing, QA script happy.. Going for a straight PQA again here! It's only a string patch really.
Pushed to master for 21.11, thanks to everybody involved!
Pushed to 21.05.x for 21.05.05
Depends on Bug 28189 not in 20.11.x
(In reply to Fridolin Somers from comment #6) > Depends on Bug 28189 not in 20.11.x It wouldn't hurt to backported both, for the sake of better documentation. I'm willing to generate a revised patch if you would push it
Bug 28189 imself depends on Bug 28157. With new cycle about to start, I'm not sure it is worth spending the time on it. Better keep 20.11 as stable as possible in my opinion.