Skip to content

Commit 4fcc155

Browse files
authored
Update README.md
1 parent eb1108d commit 4fcc155

File tree

1 file changed

+8
-45
lines changed

1 file changed

+8
-45
lines changed

README.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# php-openapi
22

3-
Read and write [OpenAPI](https://www.openapis.org/) 3.0.x YAML and JSON files and make the content accessible in PHP objects.
3+
Read and write [OpenAPI](https://www.openapis.org/) 3.x YAML and JSON files and make the content accessible in PHP objects.
44

5-
It also provides a CLI tool for validating and converting OpenAPI 3.0.x Description files.
5+
It also provides a CLI tool for validating and converting OpenAPI 3.x Description files.
6+
7+
Supported OpenAPI versions:
8+
9+
- 3.0.x
10+
- 3.1.x
611

712
[![Latest Stable Version](https://poser.pugx.org/cebe/php-openapi/v/stable)](https://packagist.org/packages/cebe/php-openapi)
813
[![Total Downloads](https://poser.pugx.org/cebe/php-openapi/downloads)](https://packagist.org/packages/cebe/php-openapi)
@@ -212,7 +217,7 @@ $openapi->resolveReferences(
212217

213218
The library provides simple validation operations, that check basic OpenAPI spec requirements.
214219
This is the same as "structural errors found while reading the API Description file" from the CLI tool.
215-
This validation does not include checking against the OpenAPI v3.0 JSON schema, this is only implemented in the CLI.
220+
This validation does not include checking against the OpenAPI v3.0/v3.1 JSON schemas, this is only implemented in the CLI.
216221

217222
```
218223
// return `true` in case no errors have been found, `false` in case of errors.
@@ -225,48 +230,6 @@ $errors = $openapi->getErrors();
225230
> but the list of errors given may not be complete. Also a passing validation does not necessarily indicate a completely
226231
> valid spec.
227232
228-
229-
## Completeness
230-
231-
This library is currently work in progress, the following list tracks completeness:
232-
233-
- [x] read OpenAPI 3.0 JSON
234-
- [x] read OpenAPI 3.0 YAML
235-
- [ ] OpenAPI 3.0 Schema
236-
- [x] OpenAPI Object
237-
- [x] Info Object
238-
- [x] Contact Object
239-
- [x] License Object
240-
- [x] Server Object
241-
- [x] Server Variable Object
242-
- [x] Components Object
243-
- [x] Paths Object
244-
- [x] Path Item Object
245-
- [x] Operation Object
246-
- [x] External Documentation Object
247-
- [x] Parameter Object
248-
- [x] Request Body Object
249-
- [x] Media Type Object
250-
- [x] Encoding Object
251-
- [x] Responses Object
252-
- [x] Response Object
253-
- [x] Callback Object
254-
- [x] Example Object
255-
- [x] Link Object
256-
- [ ] [Runtime Expressions](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#runtime-expressions)
257-
- [x] Header Object
258-
- [x] Tag Object
259-
- [x] Reference Object
260-
- [x] Schema Object
261-
- [x] load/read
262-
- [ ] validation
263-
- [x] Discriminator Object
264-
- [x] XML Object
265-
- [x] Security Scheme Object
266-
- [x] OAuth Flows Object
267-
- [x] OAuth Flow Object
268-
- [x] Security Requirement Object
269-
270233
# Support
271234

272235
**Need help with your API project?**

0 commit comments

Comments
 (0)