Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CPDLP-3530] Add NPQ separation release note #1866

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/models/release_notes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def parse_release_notes(content)
content.scan(regexp).map do |match|
ReleaseNote.new(
date: match[0],
content: match[1].strip,
content: GovukMarkdown.render(match[1].strip),
)
end
end
Expand Down
4 changes: 1 addition & 3 deletions app/views/api/guidance/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
<p class="govuk-body">
<%= govuk_link_to(@latest_release_note.date, api_guidance_page_path(page: "release-notes", anchor: @latest_release_note.date.parameterize)) %>
</p>
<p class="govuk-body">
<%= @latest_release_note.content %>
</p>
<%= @latest_release_note.content.html_safe %>
<p class="govuk-body">
<%= govuk_link_to("Browse our latest release notes", api_guidance_page_path(page: "release-notes")) %>
</p>
Expand Down
29 changes: 29 additions & 0 deletions app/views/api/guidance/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,35 @@

If you have any questions or comments about these notes, please contact DfE via Slack or email.

## 27 November 2024
cwrw marked this conversation as resolved.
Show resolved Hide resolved

We've launched the live standalone National Professional Qualifications (NPQs) API following a 3-month test phase.

We’ve migrated NPQ data from the combined ECF/NPQs API to the new environment, so providers must now make all NPQ-related calls from this API.

To make requests in the new live environment, providers must use the bearer tokens that we’ve sent them via Galaxkey.

The base URL is:

- [https://register-national-professional-qualifications.education.gov.uk/](https://register-national-professional-qualifications.education.gov.uk/)

Providers can add the required API version and endpoint depending on what they want to do. For example, they’d add `/api/v3/npq-applications` to the base URL if they want to retrieve multiple applications.

We’ve also created documentation for the new live environment endpoints:

- [NPQ API v1 documentation](https://register-national-professional-qualifications.education.gov.uk/api/docs/v1)
- [NPQ API v2 documentation](https://register-national-professional-qualifications.education.gov.uk/api/docs/v2)
- [NPQ API v3 documentation](https://register-national-professional-qualifications.education.gov.uk/api/docs/v3)

To ensure everything runs smoothly, we recommend providers take the following post-separation actions:

- check their integration supports NPQ calls independently
- make sure all data flows and integrations continue to work as expected
- test internal processes to verify that data from the NPQ environment is being handled appropriately
- conduct full data syncs within their allocated window so that data is up to date and accurate

Providers can contact us via their dedicated DfE Slack channel if they’ve got any suggestions or concerns.

## 13 August 2024

We’ve released a minimum viable product (MVP) version of the standalone National Professional Qualifications (NPQ) API for providers to test ahead of its full launch at the end of November 2024. We plan to run this test phase until the end of October and will support providers via regular dedicated meetings to ensure testing is going smoothly.
Expand Down
6 changes: 3 additions & 3 deletions spec/models/release_notes_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 13 August 2024

First paragraph
First paragraph: [some link](https://example.com/)

Second paragraph

Expand All @@ -23,10 +23,10 @@

latest = release_notes.latest
expect(latest.date).to eq("13 August 2024")
expect(latest.content).to eq("First paragraph")
expect(latest.content).to eq("<p class=\"govuk-body-m\">First paragraph: <a href=\"https://example.com/\" class=\"govuk-link\">some link</a></p>")
end

it "parses release notes from a file" do
expect { ReleaseNotes.new.latest }.not_to raise_error
expect { described_class.new.latest }.not_to raise_error
end
end
Loading