Doc endpoints#97
Conversation
8793247 to
dd12bc9
Compare
dd12bc9 to
4fae4fa
Compare
ll-zerr
left a comment
There was a problem hiding this comment.
praise: Thanks, @LauraLangdon , for getting the endpoints into the docs! I agree, styling could be considered for improved UX but this is a solid start. 🙌🏻
I tested the product categories endpoints as my focus and found a few patterns came up consistently:
issue (blocking): Requests must include the /api prefix, for example https://localhost:1337/api/categories, or they return 404/405 errors.
suggestion (non-blocking): The docs show hyphenated id values, but the actual documentIds that are required appear as single 24-character strings without hyphens. I'm not sure how much this affects usage, but it may be worth aligning the docs with the actual format.
nitpick: Some of the 200 OK response examples appear to be duplicated across methods and may not reflect the actual response data. For example, the DELETE method returns 204 No Content with an empty body (similar to the Swagger docs for Strapi).
question: Could you clarify what the Informations heading is intended to represent in the API Reference Overview section? It appears to be referencing the OpenAPI spec but the label seems slightly confusing.
Done so far
schemas/aggregated-public-information.jsonstarlight-openapiplugin into docs site — generates API reference pages at/api-reference/##Still to do/consider: