Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit 5091afa

Browse files
committed
docs: Add a status of implemented features
1 parent 06ae665 commit 5091afa

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# OpenAPI Support
2+
3+
The following document contains the list of OpenAPI features that are supported
4+
in the parser per object type.
5+
6+
Key:
7+
8+
| Status | |
9+
|:--|:--|
10+
| Full Support ||
11+
| Partial Support | ~ |
12+
| Unsupported ||
13+
14+
## OpenAPI Object
15+
16+
| Field Name | Support |
17+
|:--|:--|
18+
| openapi | [~](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/32) |
19+
| info | [~](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/30) |
20+
| servers | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/24) |
21+
| paths | ~ |
22+
| components ||
23+
| security | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/25) |
24+
| externalDocs | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/27) |
25+
26+
## Info Object
27+
28+
| Field Name | Support |
29+
|:--|:--|
30+
| title ||
31+
| description ||
32+
| termsOfService | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/29) |
33+
| contact | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/30) |
34+
| license | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/31) |
35+
| version ||
36+
37+
## Paths Object
38+
39+
## Path Item Object
40+
41+
| Field Name | Support |
42+
|:--|:--|
43+
| $ref ||
44+
| summary ||
45+
| description ||
46+
| get | ~ |
47+
| put | ~ |
48+
| post | ~ |
49+
| delete | ~ |
50+
| options | ~ |
51+
| head | ~ |
52+
| patch | ~ |
53+
| trace | ~ |
54+
| servers | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/24) |
55+
| parameters | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/33) |
56+
57+
## Operation Object
58+
59+
| Field Name | Support |
60+
|:--|:--|
61+
| tags ||
62+
| summary ||
63+
| description ||
64+
| externalDocs | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/28) |
65+
| operationId | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/34) |
66+
| parameters | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/33) |
67+
| requestBody ||
68+
| responses ||
69+
| callbacks | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/36) |
70+
| deprecated ||
71+
| security | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/25) |
72+
| servers | [](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/24) |
73+
74+
## Parameter Object
75+
76+
| Field Name | Support |
77+
|:--|:--|
78+
| name ||
79+
| in ||
80+
| description ||
81+
| required ||
82+
| deprecated ||
83+
| allowEmptyValue ||
84+
85+
### Serialisation Rules
86+
87+
| Field Name | Support |
88+
|:--|:--|
89+
| style ||
90+
| explode ||
91+
| allowReserved ||
92+
| schema ||
93+
| example ||
94+
| examples ||
95+
96+
### Location
97+
98+
| Location | Support |
99+
|:--|:--|
100+
| path ||
101+
| query ||
102+
| header ||
103+
| cookie ||

0 commit comments

Comments
 (0)