Skip to content

Doc endpoints#97

Open
LauraLangdon wants to merge 2 commits into
mainfrom
doc-endpoints
Open

Doc endpoints#97
LauraLangdon wants to merge 2 commits into
mainfrom
doc-endpoints

Conversation

@LauraLangdon

@LauraLangdon LauraLangdon commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

Done so far

  • Added static OpenAPI 3.1.0 spec at schemas/aggregated-public-information.json
  • Integrated starlight-openapi plugin into docs site — generates API reference pages at /api-reference/

##Still to do/consider:

@LauraLangdon LauraLangdon marked this pull request as ready for review June 4, 2026 04:46
@LauraLangdon LauraLangdon requested a review from a team as a code owner June 4, 2026 04:46
@LauraLangdon LauraLangdon requested a review from ll-zerr June 4, 2026 04:49
@LauraLangdon LauraLangdon added the documentation Improvements or additions to documentation label Jun 4, 2026
@github-project-automation github-project-automation Bot moved this to Triage in DA Tech Jun 4, 2026
@LauraLangdon LauraLangdon moved this from Triage to Ready for Review in DA Tech Jun 4, 2026

@ll-zerr ll-zerr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

2 participants