Update Teacher Training API to return selectable_school

[inulty-dfe]

Context

We have added a property to Provider, selectable_school. We want to provider this property via the API.

This property must be documented in the API docs.

Changes proposed in this pull request

• Add selectable_school to the ProviderAttributes API response.
• Update documentation on how to develop the API docs

Guidance to review

https://publish-review-4465.test.teacherservices.cloud/docs/#about

API response

curl -H 'content-type: application/json' http://publish.localhost:3001/api/public/v1/recruitment_cycles/2024/providers/2AT | jq '.data.attributes.selectable_school'

API docs

http://publish.localhost:3001/api_docs`

Trello Ticket

Update Publish API to return selectable school as part of the Providers API

Things to check

• This code does not rely on migrations in the same Pull Request
• If this code includes a migration adding or changing columns, it also backfills existing records for consistency
• If this code adds a column to the DB, decide whether it needs to be in analytics yml file or analytics blocklist
• API release notes have been updated if necessary
• Required environment variables have been updated added to the Azure KeyVault
• Inform data insights team due to database changes
• Make sure all information from the Trello card is in here
• Rebased main
• Cleaned commit history
• Tested by running locally
• Attach PR to Trello card

[inulty-dfe]

Update Publish API to return selectable school as part of the Providers API

[tomas-stefano]

The command is duplicated below. Both lines execute the same command.

[tomas-stefano]

After removing the duplication in the document, looks good 🚀