Skip to content

APIS-7548 - Update accept header wording #586

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.

Sign up for GitHub

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

Open
Tobias1087 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

APIS-7548 - Update accept header wording #586

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions app/uk/gov/hmrc/apidocumentation/views/ReferenceView.scala.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,17 +606,21 @@ <h2 class="govuk-heading-m">TLS standards</h2>
</section>

<section id="versioning">
<h2 class="govuk-heading-m">Versioning</h2>
<h2 class="govuk-heading-m">Using the Accept header for versioning</h2>

<p class="govuk-body">Request the version of the API you want to use by including an <code class="code--slim">Accept</code> header with a media type of:</p>
<p class="govuk-body">You choose the version of the API you want to use by sending an <code class="code--slim">Accept</code> header with a media type of:</p>

<pre class="code--block">application/vnd.hmrc.[version]+[content-type]</pre>
<br />
<p class="govuk-body">For example:</p>

<pre class="code--block">application/vnd.hmrc.1.0+json</pre>
<br />
<p class="govuk-body">We release backwards-compatible changes in the same version, so you don't need to change your <code class="code--slim">Accept</code> header. We release backwards-incompatible changes in a new version, and you must change your <code class="code--slim">Accept</code> header to use it.</p>
<h3>How version changes affect your Accept header</h3>
<ul class="govuk-list govuk-list--bullet">
<li>We make backwards‑compatible changes within the same version, so you do not need to update your Accept header.</li>
<li>When we release a backwards‑incompatible change, we create a new version of the API. You must update your Accept header or the API will still remain on the same version.</li>
</ul>

<p class="govuk-body"> Learn more about <a class="govuk-link govuk-link--no-visited-state" href="@controllers.routes.DocumentationController.apiStatusesPage().url">API version statuses</a>.

Expand Down