Template Repos

[dearshrewdwit]

Task https://github.com/boolean-uk/team-dev-server-template

• update the OpenAPI yml to match current behaviour
• Use redoc cli to create the html view -> in the docs dir
• set up GH pages to server from docs dir

[vherus]

This is taking a bit longer than anticipated, there are a lot of inconsistencies in the API spec

[vherus]

User, post, cohort and log are done and consistent now. The YAML isn't pretty.

What's left:

• note
• conversation
• exercise
• comment

Responses should follow the structure:

{
  "status": "string",
  "data": {
    "property1": "type",
    ...
  }
}

See the existing responses for the ones I've cleaned up as a reference for how to include nested entities.

Some of the endpoints may not make sense on those left to complete, please make sure they make sense.

E.g. "Create cohort exercise": Currently: /exercises/{id}/cohortExercises

That route can be removed with an optional cohortId property added to the "Create exercise" route's request body

[vherus]

Command for compiling the YAML: npx redoc-cli build docs/openapi.yml -o docs/index.html

[vherus]

Conversation, Exercise and Comment left to do

[vherus]

The spec is riddled with inconsistencies and bad choices. Current work frozen pending the below actions:

1. Verify the current spec as it exists matches how the client is ingesting the API
2. Remove anything that the client and server have not implemented
3. Refactor the spec and/or client when implementing the new client designs

[vherus]

• Continue with the archived changes, bring the spec to a smaller & consistent state
• Implement the client changes RE #166 to that spec

[vherus]

• Complete archived work, stripping out endpoints from spec