discourse/spec/requests/api
Blake Erickson fe676f334a
FEATURE: Return subcategories on categories endpoint (#14492)
* FEATURE: Return subcategories on categories endpoint

When using the API subcategories will now be returned nested inside of
each category response under the `subcategory_list` param. We already
return all the subcategory ids under the `subcategory_ids` param, but
you then would have to make multiple separate API calls to fetch each of
those subcategories. This way you can get **ALL** of the categories
along with their subcategories in a single API response.

The UI will not be affected by this change because you need to pass in
the `include_subcategories=true` param in order for subcategories to be
returned.

In a follow up PR I'll add the API scoping for fetching categories so
that a readonly API key can be used for the `/categories.json` endpoint. This
endpoint should be used instead of the `/site.json` endpoint for
fetching a sites categories and subcategories.

* Update PR based on feedback

- Have spec check for specific subcategory
- Move comparison check out of loop
- Only populate subcategory list if option present
- Remove empty array initialization
- Update api spec to allow null response

* More PR updates based on feedback

- Use a category serializer for the subcategory_list
- Don't include the subcategory_list param if empty
- For the spec check for the subcategory by id
- Fix spec to account for param not present when empty
2021-10-05 12:12:31 -06:00
..
schemas FEATURE: Return subcategories on categories endpoint (#14492) 2021-10-05 12:12:31 -06:00
shared document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
backups_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
badges_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
categories_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
groups_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
invites_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
notifications_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
posts_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
private_messages_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
search_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
site_spec.rb DEV: Add site.json to api docs (#14249) 2021-09-07 10:36:05 -06:00
tags_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
topics_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
uploads_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
user_badges_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
users_spec.rb DEV: Refactor the api docs for the user endpoint (#14377) 2021-09-20 10:04:57 -06:00