Skip to content

Commit

Permalink
Added missing Article documentation + small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
michalsalon-mall committed Nov 25, 2021
1 parent db68c00 commit f56b0fb
Show file tree
Hide file tree
Showing 8 changed files with 591 additions and 75 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 4.0.0-beta.2 - 2021-11-22

### Added

- rest of missing `Article` documentation
- requirements to Readme

### Changed

- fixed small issues with documentation
- used array concat instead of `array_merge`

### Fixed

- `Product` entity would not return all fields in `jsonEncode` result

## 4.0.0-beta.1 - 2021-08-25

### Added
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

MPAPI client is a tool created to help Internet Mall, a. s. partners easily manage article catalogue, deliveries, orders etc. using Mall Marketplace API.

## Requirements
- `64bit` version of `PHP 7.4` or `PHP 8`
- Guzzle 7

## Installation

To install the client using [Composer](https://getcomposer.org/doc/00-intro.md) run following command in your repository
Expand Down Expand Up @@ -127,9 +131,9 @@ List of custom Exceptions thrown in this client can be found [here](doc/Exceptio

## ⚠ Warning

- client does not include support for deprecated endpoints (i.e., deliveries or gifts), that will be changed, replaced or removed in the future
- client does not include support for deprecated endpoints (i.e., `/v1/deliveries` or `/v1/gifts`), that will be changed, replaced or removed in the future

### This is still a Beta release, and some documentation and examples are missing or incomplete
### This is still a Beta release, and some features are missing or incomplete

- [ ] Article client documentation
- [ ] Order client documentation and examples
- [ ] Transports v2 support
Loading

0 comments on commit f56b0fb

Please sign in to comment.