Skip to content

Commit

Permalink
chore(docs): document client generation
Browse files Browse the repository at this point in the history
Signed-off-by: Misha M.-Kupriyanov <[email protected]>
  • Loading branch information
printminion-co committed Dec 11, 2024
1 parent 823999e commit b135d5f
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,27 @@ This is the API client for the Mail Notification API

### Requirements

PHP 7.4 and later.
Should also work with PHP 8.0.
* PHP 7.4 and later (should also work with PHP 8.0)
* Java 11 or later

### Regenerate the API client

Regenerate the API client with the latest changes in the API specification

1. Pull last openapi definition from server
```shell
./pull_api_definition.sh api.example.lan:10443
```

2. Install openapi generator
```shell
npm install
```

3. Generate api for pulled openapi version
```shell
make php
```

### Composer

Expand Down

0 comments on commit b135d5f

Please sign in to comment.