Skip to content

Commit

Permalink
Release
Browse files Browse the repository at this point in the history
- Update the changelog
- Content correct, documentation page
- Set release version and date
  • Loading branch information
deanblackborough committed Jan 27, 2021
1 parent 18217ff commit 6755c4c
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 10 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

The complete changelog for the Costs to Expect REST API, our changelog follows the format defined at https://keepachangelog.com/en/1.0.0/

## [v2.18.0] - 2021-01-27
### Added
- We have opened up registration on the API; you can register, login, and use all the expected authentication features.
- We have added notification emails for registration and forgot password requests.

### Changed
- We have switched to Laravel Sanctum and removed all references to Laravel Passport, Sanctum makes more sense for our API.
- We have updated to Laravel version 8.
- We have tweaked our Docker setup and removed composer and phpunit.
- Content updates

## [v2.17.1] - 2020-11-28
### Changed
- We have added the `X-Last-Updated` header to the `resource-types`, `resources`, `categories`, `subcategories`, `items` and `resource items` collection routes.
Expand Down
4 changes: 2 additions & 2 deletions config/api/app/version.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
declare(strict_types=1);

return [
'version'=> 'v2.17.1',
'version'=> 'v2.18.0',
'prefix' => 'v2',
'release_date' => '2020-11-28',
'release_date' => '2021-01-27',
'changelog' => [
'api' => '/v2/changelog',
'markdown' => 'https://github.com/costs-to-expect/api/blob/master/CHANGELOG.md'
Expand Down
4 changes: 2 additions & 2 deletions resources/views/documentation.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ function gtag(){dataLayer.push(arguments);}
<p>Our documentation is
available at <a href="https://postman.costs-to-expect.com">https://postman.costs-to-expect.com</a>.</p>

<p>We will ensure that all our docs are always be up to date;
the docs will always refer to the released live version
<p>We will ensure that our docs are always up to date;
the docs will always refer to the live version
of the API. </p>

<p>In addition to the published documentation, we include
Expand Down
13 changes: 7 additions & 6 deletions resources/views/welcome.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -225,16 +225,17 @@ function gtag(){dataLayer.push(arguments);}
<h3>Added</h3>

<ul>
<li>We have added the `X-Last-Updated` header to the `resource-types`, `resources`, `categories`, `subcategories`, `items` and `resource items` collection routes.</li>
<li>We have added the `X-Last-Updated` header to additional summary routes; the header was missing, and we are going to use it.</li>
<li>We have increased the coverage of our request test suite.</li>
<li>We have relocated our `Transformer` classes; we have moved them out of the `Models` namespace.</li>
<li>We have opened up registration on the API; you can register, login, and use all the expected authentication features.</li>
<li>We have added notification emails for registration and forgot password requests.</li>
</ul>

<h3>Fixed</h3>
<h3>Changed</h3>

<ul>
<li>We have updated the way we calculated the value for `X-Last-Updated`. We are using the max of the `created at` and `updated at`, not just looking at the `created at` time.</li>
<li>We have switched to Laravel Sanctum and removed all references to Laravel Passport, Sanctum makes more sense for our API.</li>
<li>We have updated to Laravel version 8.</li>
<li>We have tweaked our Docker setup and removed composer and phpunit.</li>
<li>Content updates.</li>
</ul>
</div>
</div>
Expand Down

0 comments on commit 6755c4c

Please sign in to comment.