868 add school email domain api by PetarSimonovic · Pull Request #878 · RaspberryPiFoundation/editor-api

PetarSimonovic · 2026-06-17T08:25:48Z

Status

Closes Add school email domain API #868

Description

A REST API that allows school owners and teachers to create and list SchoolEmailDomains.

Owners and teachers can list/create; students and users from other schools cannot
Domains are validated (FQDN format, URI, registrable public suffix) with translated error messages
New domains are synced to Profile; the DB transaction rolls back if Profile sync fails
Delete is out of scope for this PR

What's changed?

GET /api/schools/:school_id/school_email_domains — list domains
POST /api/schools/:school_id/school_email_domains — create a domain
Added concept with Profile sync + rollback on failure
Validation with translated error messages
Specs at validator, model, concept, and feature levels

github-actions · 2026-06-17T08:29:07Z

Test coverage

91.92% line coverage reported by SimpleCov.
Run: https://github.com/RaspberryPiFoundation/editor-api/actions/runs/28037470271

Copilot

Pull request overview

Adds a REST API for managing a school’s allowed student email domains, intended for use by authorised school owners/teachers and kept in sync with the Profile service.

Changes:

Introduces GET /api/schools/:school_id/school_email_domains (list) and POST /api/schools/:school_id/school_email_domains (create) endpoints.
Adds a SchoolEmailDomain::Create concept that persists the domain and syncs the school’s full domain list to Profile (rolling back on sync failure).
Extends authorisation and i18n error messages, plus adds factories and request/unit specs.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
spec/support/profile_api_mock.rb	Adds a stub helper for Profile “update school email domains” calls in specs.
spec/features/school_email_domain/listing_school_email_domains_spec.rb	Request specs for listing domains with auth/unauth coverage.
spec/features/school_email_domain/creating_school_email_domains_spec.rb	Request specs for creating domains, validation errors, and Profile failure handling.
spec/factories/school_email_domain.rb	Factory for `SchoolEmailDomain`.
spec/concepts/school_email_domain/create_spec.rb	Unit coverage for the `SchoolEmailDomain::Create` concept.
lib/concepts/school_email_domain/operations/create.rb	Implements the create + Profile sync operation with rollback on failure.
config/routes.rb	Wires nested school email domain routes under schools.
config/locales/en.yml	Adds translated validation messages for domain validation error codes.
app/models/ability.rb	Grants school owners/teachers ability to read/create school email domains.
app/controllers/api/school_email_domains_controller.rb	Adds the API controller for index/create with CanCan authorisation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mwtrew · 2026-06-23T12:53:24Z

+        end
+        response
+      rescue ActiveRecord::RecordInvalid => e
+        record = response[:school_email_domain] || e.record


Might be worth fixing this after all - I don't expect it to be a problem but it's a trivial change. It's similar to what's been done here.

I've made this changed and initialised with nil since response[:school_email_domain] should be a single record

cursor

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

Want fixes drafted automatically? Bugbot Autofix can create code changes for findings. A team admin can enable Autofix in the Cursor dashboard.

^{Reviewed by Cursor Bugbot for commit e24d6af. Configure here.}

Add SchoolEmailDomainsController and school_email_domains route. Return a list of domain strings. Update CanCan ability to allow access only for teachers and owners. Co-authored-by: Cursor <cursoragent@cursor.com>

Add POST create to SchoolEmailDomainsController and route. Add SchoolEmailDomain::Create concept to persist domains and sync the full list with Profile.

mwtrew

Looking good overall, but I think we'll need to do something about the problem in this thread.

mwtrew

Looks good, thanks for those changes.

If you'd like to look into using an advisory lock that would be great, but I think what you have will work for now.

PetarSimonovic linked an issue Jun 17, 2026 that may be closed by this pull request

Add school email domain API #868

Open

cla-bot Bot added the cla-signed label Jun 17, 2026

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from b46e372 to 4ea2fbf Compare June 17, 2026 08:26

PetarSimonovic requested a review from Copilot June 17, 2026 08:26

Copilot started reviewing on behalf of PetarSimonovic June 17, 2026 08:26 View session

github-code-quality Bot found potential problems Jun 17, 2026

View reviewed changes

Comment thread lib/concepts/school_email_domain/operations/create.rb Fixed

Comment thread lib/concepts/school_email_domain/operations/create.rb Fixed

Comment thread lib/concepts/school_email_domain/operations/create.rb Fixed

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from 4ea2fbf to 3159b2a Compare June 17, 2026 08:29

Copilot AI reviewed Jun 17, 2026

View reviewed changes

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from 3159b2a to 1ef1f88 Compare June 17, 2026 09:54

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-u3xxpf June 17, 2026 09:54 Inactive

github-code-quality Bot found potential problems Jun 17, 2026

View reviewed changes

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from 1ef1f88 to 511affb Compare June 17, 2026 10:54

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-u3xxpf June 17, 2026 10:54 Inactive

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-zp9tgf June 22, 2026 07:49 Inactive

github-code-quality Bot found potential problems Jun 22, 2026

View reviewed changes

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from 86c56f1 to e24d6af Compare June 22, 2026 07:54

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-n5eyni June 22, 2026 07:54 Inactive

PetarSimonovic marked this pull request as ready for review June 22, 2026 14:00

cursor Bot reviewed Jun 22, 2026

View reviewed changes

Comment thread lib/concepts/school_email_domain/operations/create.rb

mwtrew self-requested a review June 23, 2026 10:15

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-ppivrb June 23, 2026 13:18 Inactive

PetarSimonovic and others added 5 commits June 23, 2026 14:20

Allow teachers and owners to list SchoolEmailDomains

f5a8796

Add SchoolEmailDomainsController and school_email_domains route. Return a list of domain strings. Update CanCan ability to allow access only for teachers and owners. Co-authored-by: Cursor <cursoragent@cursor.com>

Allow school owners and teachers to create school email domains

2cf9498

Add POST create to SchoolEmailDomainsController and route. Add SchoolEmailDomain::Create concept to persist domains and sync the full list with Profile.

Return error_codes in SchoolEmailDomain response

337551c

Seed school with student_sso feature flag

b51fcfb

Initialise response[:school_email_domain] before assignment

27cc95f

PetarSimonovic force-pushed the 868-add-school-email-domain-api branch from a1bc812 to 27cc95f Compare June 23, 2026 13:20

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-ppivrb June 23, 2026 13:21 Inactive

PetarSimonovic commented Jun 23, 2026

View reviewed changes

Comment thread lib/tasks/test_seeds.rake

Lock school while creating domains and syncing with Profile

dddfb10

PetarSimonovic temporarily deployed to editor-api-p-868-add-sc-6dkc3a June 23, 2026 15:35 Inactive

mwtrew requested changes Jun 23, 2026

View reviewed changes

mwtrew approved these changes Jun 24, 2026

View reviewed changes

Conversation

PetarSimonovic commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Status

Description

What's changed?

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test coverage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mwtrew Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

PetarSimonovic Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mwtrew left a comment

Choose a reason for hiding this comment

Uh oh!

mwtrew left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

PetarSimonovic commented Jun 17, 2026 •

edited

Loading

github-actions Bot commented Jun 17, 2026 •

edited

Loading

PetarSimonovic Jun 23, 2026 •

edited

Loading