Skip to content

Commit

Permalink
Release
Browse files Browse the repository at this point in the history 
- Updated changelog for new release
  • Loading branch information
@deanblackborough
deanblackborough committed Jun 23, 2020
1 parent ac52cb3 commit 3e676de
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 46 deletions.
13 changes: 12 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,20 @@

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.12.0] - 2020-xx-xx
## [v2.11.5] - 2020-06-24
### Added
- We have added a documentation page; the documentation page links to the API documentation and includes a couple of examples.

### Changed
- We have updated the example ENV file.
- We have renamed a couple of our helper conversion/validation classes and moved them to a new namespace.
- We have made a minor content tweak on the landing page; the documentation button is in another section.
- We have updated and relocated our validation classes; the validation classes are now part of the `App\Request\Validate` namespace.
- We have reworked our summary controllers; we have removed some code duplication and added additional error checking.

### Fixed
- Incorrectly assuming the result will be an array with at least one value.
- We have fixed an error in the changelog; we jump a couple of minor versions.

## [v2.11.4] - 2020-06-19
### Changed
Expand Down
4 changes: 2 additions & 2 deletions config/api/app/version.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
declare(strict_types=1);

return [
'version'=> '2.11.4',
'version'=> 'v2.11.5',
'prefix' => 'v2',
'release_date' => '2020-06-19',
'release_date' => '2020-06-24',
'changelog' => [
'api' => '/v2/changelog',
'markdown' => 'https://github.com/costs-to-expect/api/blob/master/CHANGELOG.md'
Expand Down
55 changes: 12 additions & 43 deletions resources/views/welcome.blade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,67 +211,36 @@ function gtag(){dataLayer.push(arguments);}

<hr />

<h2>Latest feature release [v2.11.0]</h2>
<h2>Latest release {{ $version }}</h2>

<p>The latest release of the Costs to Expect API is
{{ $version }}; we released it on the {{ date('jS M Y', strtotime($date)) }}.</p>

<p>The combined changelog below shows all the fixes and improvements we have made to the
API since the last feature release.</p>
<p>The changelog below shows all the fixes and improvements we have made, to view
the entire changelog please check <a href="https://github.com/costs-to-expect/api/releases">here</a>.</p>

<h3>Added</h3>

<ul>
<li>We have added search to the categories summary endpoint.</li>
<li>We have added search to the subcategories summary endpoint.</li>
<li>We have added search to the resources summary endpoint.</li>
<li>We have added search to the resource-types summary endpoint.</li>
<li>We have updated the transfers collection; you can filter the results by an `item` ID.</li>
<li>We have updated the partial transfers collection; you can filter the results by an `item` ID.</li>
<li>We have added additional filtering options for collections. We have added `total` and `actualised_total` range filtering for the `allocated-expense` item type and `total` range filtering for the `simple-expense` item type.</li>
<li>We have added an application cache for collections; we include the ETag header however we are not yet returning a 304.</li>
<li>We have added an application cache for summaries; we include the ETag header however we are not yet returning a 304.</li>
<li>We have added a documentation page; the documentation page links to the API documentation and includes a couple of examples.
Changed</li>
</ul>

<h3>Changed</h3>

<ul>
<li>We have added the documentation URI to the README and API; the documentation for the API is work in progress; it is almost complete.</li>
<li>We have added a version query parameter to the CSS include.</li>
<li>We have removed a unique index on the `item_transfer` table; the index was limiting the ability to transfer an item multiple times.</li>
<li>We have altered the format of the category and subcategory object for item relationships; the returned object is now a closer match to a category object.</li>
<li>We have updated the URIs for item category and subcategory assignments; the URI was singular for a collection.</li>
<li>We have updated the item delete endpoint; we did not return a conflict error before removing relationships.</li>
<li>We have tweaked the `type` for expense fields; we highlight that the supplied value should be a decimal string.</li>
<li>We have moved our route validators; the route validators sit inside the `App\Request` namespace.</li>
<li>We have moved our `Header` utility class; the `Header` class sits inside the `App\Response` namespace.</li>
<li>We have moved our `RoutePermission` utility class; the `Permission` class sits inside the `App\Request` namespace.</li>
<li>We have moved and simplified our `Parameter` classes; the `Parameter` classes sit inside the `App\Request` namespace.</li>
<li>We have moved and renamed the `RequestUtility` class; the `BodyValidation` class sits in the `App\Request` namespace.</li>
<li>We have split calls to clear public and private cache keys.</li>
<li>We only clear public cache keys when modifying a public resource type.</li>
<li>We have updated the web.config; the web.config file was referring to PHP7.3.</li>
<li>Added removed class type hints now that we are running PHP7.4.</li>
<li>We have updated the caching system to respect the `cache` config setting.</li>
<li>We have updated the example ENV file.</li>
<li>We have renamed a couple of our helper conversion/validation classes and moved them to a new namespace.</li>
<li>We have made a minor content tweak on the landing page; the documentation button is in another section.</li>
<li>We have updated and relocated our validation classes; the validation classes are now part of the `App\Request\Validate` namespace.</li>
<li>We have reworked our summary controllers; we have removed some code duplication and added additional error checking.</li>
</ul>

<h3>Fixed</h3>

<ul>
<li>The `name` field now displays as a required field in the items collection OPTIONS request.</li>
<li>The `filterable` array shows in the OPTIONS response for resource type items.</li>
<li>We have updated the namespace in a model.</li>
<li>We have corrected the case of a model name.</li>
<li>We have added the migrations for the original item-types, missing from the import.</li>
<li>We have added a database migration to update the `friendly_name` and `examples` data for `item-types`.</li>
<li>We have updated the delete item request; we delete the transfer log entries for the item.</li>
<li>We have updated two `item-type` summary endpoints to show they are sortable by `name`.</li>
</ul>

<h3>Removed</h3>

<ul>
<li>We have removed the category and subcategory item assigned URIs and replaced them with correctly named URIs for collections.</li>
<li>Incorrectly assuming the result will be an array with at least one value.</li>
<li>We have fixed an error in the changelog; we jump a couple of minor versions.</li>
</ul>
</div>
</div>
Expand Down

0 comments on commit 3e676de

Please sign in to comment.