Skip to content
This repository has been archived by the owner on Mar 2, 2022. It is now read-only.

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
cblanc committed Feb 7, 2019
1 parent 61ad268 commit 9ad5e2a
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 107 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

# Ideal Postcodes HTTP API Fixtures

This javascript library provides HTTP API response data for api.ideal-postcodes.co.uk. This data is exported as `Fixture` objects, containing a JSON response body (`body`) and HTTP Status Code (`httpStatus`).
This javascript library provides HTTP API response data for api.ideal-postcodes.co.uk. Canned API response responses are exported as [Fixture](https://ideal-postcodes.github.io/api-fixtures/interfaces/fixture.html) objects, containing a JSON response body (`body`) and HTTP Status Code (`httpStatus`).

These test objects may be readily imported into a test suite to stub out test methods or API requests.

Automatically generated documentation which outlines available fixtures can be found at: [https://ideal-postcodes.github.io/api-fixtures/](https://ideal-postcodes.github.io/api-fixtures/)

Fixture object defition can be found [here](https://ideal-postcodes.github.io/api-fixtures/interfaces/fixture.html)
Automatically generated documentation which outlines available fixtures can be found at [ideal-postcodes.github.io/api-fixtures](https://ideal-postcodes.github.io/api-fixtures/)

## Example Usage

Expand Down
Loading

0 comments on commit 9ad5e2a

Please sign in to comment.