Releases: costs-to-expect/api
Releases · costs-to-expect/api
Fix headers and other tweaks
Changed
- We have switched to a new font; the font is more legible at small screen sizes, and, it looks cool.
- We have reviewed our HTTP headers; Content-Language missing along with other expected headers.
- We log the id of the user that added a user to the 'permitted_user' table; this is to help later with permitted user management.
- We have updated the API to the most recent version of Laravel 6.
Fixed
- The
description
field for thesimple-item
type should be nullable. - Card data missing from head.
- Google analytics missing.
Item type refactoring
Changed
- We have renamed the existing Interfaces, more straightforward names.
- We have added additional Interfaces interfaces for the summary models.
- We have refactored several model classes to again, simplify the naming.
- We have corrected multiple summary config files, unnecessary structure.
- We have unified the parameters for related item methods.
Range filtering
Added
- We have added range filtering to the
items
collection; initially, we have added support for filtering for theeffective_date
ofallocated expense
items. - We have added range filtering to the resource type
items
collection; as above, we have addedeffective_date
filtering. - We have added support for range filtering to the
items
andresource type item
summary routes. - We have added an X-Filter header to show the valid filters applied to a collection.
- We have added a link to Costs to Expect blog; the blog is a central repository for all product updates and somewhere to talk about our products.
- We have added a
FilterParameters
class to fetch any filter parameters from the URI and validate the format and values.
Changed
- We have refreshed the landing page, we have added updated text for each of the products within the service.
- We have tweaked the stying for the landing page.
- We have renamed the data methods in the
Option
subclasses, the conditional prefix is confusing. - We have added an
interface
for the item model classes. - We have added an
interface
for the resource type item model classes.
Fixed
- We have updated the
Option/Get
class, thesort
,search
andfilter
parameters will only display if there are viable parameters.
Removed
- We have removed the layout file, not used as there is only one view file for the API.
Bugs (validation and link)
Fixed
- Select the correct year when validating the min and max year for year validation.
- The logo on the welcome page will redirect you to the API, not the app dashboard.
Simple Items type
Added
- We have added a new item type,
simple item
. We intend that the 'simple item' type is useful for managing collections. The API will now allow you to list, add, edit and delete them. - We have updated the summary routes to calculate the correct summaries for the
simple item
type.
Changed
- We have removed the effective date from simple expenses. Our intention is simple expenses are bucket based, not time-based.
- We have updated the copyright for the API.
- We have moved additional methods in the base
item
classes to reduce configuration code duplication. - We have simplified the validation classes for
item
create and update requests. - We have renamed some of the methods on the
item
class to make the intent of the method names more clear. - We have renamed the item interface class.
- We have moved the
resource type item
classes; they are below theitem
class; there is no need for them to be so low in the structure. - We have moved the factory class for
resource type
items. - We have moved the validation classes.
- We have moved the
item
model classes; we have grouped all classes of the same type.
Auth and middleware tweaks
Auth
- We have added a GET 'auth/check' endpoint; faster check for the Costs to Expect App.
Changed
- We have updated the dependencies for the API.
- We have enabled URL compression.
- We now return the user id on sign-in, saves a second request for the Costs to Expect App.
- We have updated the README, adding links to the App
readme
andchangelog
. - We have tweaked two middleware classes to improve performance slightly.
Fixed
- The HTTP verb was incorrect for the 'auth/user' endpoint.
Registration configuration and bug fixes
Added
- We have added a configuration option to control API registrations.
Changed
- We have made adjustments to the registration process; we return status code 204. Please sign-in to get your Bearer.
- We have updated the maintenance message to include a link to the status page for the Costs to Expect service.
- Dependencies updated.
- We have added a new landing page; the design matches the rest of the service.
Fixed
- Correction to a migration,
updated_by
field nullable. - Correction to a migration file, a data type was incorrect.
Summary collection metadata
Added
- We have added an X-Last-Updated header to the item summaries. It is only relevant and applied to the summaries which return a single item. Summaries that return a collection do not include the header.
Changed
- We have updated the X-Total-Count header for summaries which return a single item; the header is now the total number of 'items' in the result.
- We have tweaked the server config and no longer return some default server headers.
Added link to our app
Changed
- We have added links to the Costs to Expect app.
- We have added 'app' as a source for the request log and error log.
- We have removed three traits from the base controller.
- We have removed the exception code for the failed request entry.
Switch to database caching
- We have switched to database caching.
- We have updated the parameters helper, it now throws away more invalid requests.
- Dependencies updated.
- We have updated the landing page content.