Skip to content

Commit

Permalink
Review README, what has been emended
Browse files Browse the repository at this point in the history
  • Loading branch information
samchon committed Apr 22, 2024
1 parent 2ec44d8 commit 0a7e87d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,16 @@ For example, when representing nullable type, OpenAPI v3.1 supports three ways.
Here is the entire list of differences between OpenAPI v3.1 and emended OpenApi.

- Operation
- Merged `OpenApiV3_1.IPathItem.parameters` to `OpenApi.IOperation.parameters`
- Merge `OpenApiV3_1.IPathItem.parameters` to `OpenApi.IOperation.parameters`
- Resolved references of `OpenApiV3_1.IOperation` mebers
- JSON Schema
- Decomposed mixed type: `OpenApiV3_1.IJsonSchema.IMixed`
- Decompose mixed type: `OpenApiV3_1.IJsonSchema.IMixed`
- Resolved nullable property: `OpenApiV3_1.IJsonSchema.__ISignificant.nullable`
- Array type utilizes only single `OpenAPI.IJsonSchema.IArray.items`
- Tuple type utilizes only `OpenApi.IJsonSchema.ITuple.prefixItems`
- Merged `OpenApiV3_1.IJsonSchema.IAnyOf` to `OpenApi.IJsonSchema.IOneOf`
- Merged `OpenApiV3_1.IJsonSchema.IRecursiveReference` to `OpenApi.IJsonSchema.IReference`
- Merge `OpenApiV3_1.IJsonSchema.IAnyOf` to `OpenApi.IJsonSchema.IOneOf`
- Merge `OpenApiV3_1.IJsonSchema.IRecursiveReference` to `OpenApi.IJsonSchema.IReference`
- Merge `OpenApiV3_1.IJsonSchema.IAllOf` to `OpenApi.IJsonSchema.IObject`



Expand Down
9 changes: 5 additions & 4 deletions src/OpenApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ import { SwaggerV2Downgrader } from "./internal/SwaggerV2Downgrader";
* - Merged {@link OpenApiV3_1.IPath.parameters} to {@link OpenApi.IOperation.parameters}
* - Resolved {@link OpenApi.IJsonSchema.IReference references} of {@link OpenApiV3_1.IOperation} mebers
* - JSON Schema
* - Decomposed mixed type: {@link OpenApiV3_1.IJsonSchema.IMixed}
* - Resolved nullable property: {@link OpenApiV3_1.IJsonSchema.__ISignificant.nullable}
* - Decompose mixed type: {@link OpenApiV3_1.IJsonSchema.IMixed}
* - Resolve nullable property: {@link OpenApiV3_1.IJsonSchema.__ISignificant.nullable}
* - Array type utilizes only single {@link OpenAPI.IJsonSchema.IArray.items}
* - Tuple type utilizes only {@link OpenApi.IJsonSchema.ITuple.prefixItems}
* - Merged {@link OpenApiV3_1.IJsonSchema.IAnyOf} to {@link OpenApi.IJsonSchema.IOneOf}
* - Merged {@link OpenApiV3_1.IJsonSchema.IRecursiveReference} to {@link OpenApi.IJsonSchema.IReference}
* - Merge {@link OpenApiV3_1.IJsonSchema.IAnyOf} to {@link OpenApi.IJsonSchema.IOneOf}
* - Merge {@link OpenApiV3_1.IJsonSchema.IRecursiveReference} to {@link OpenApi.IJsonSchema.IReference}
* - Merge {@link OpenApiV3_1.IJsonSchema.IAllOf} to {@link OpenApi.IJsonSchema.IObject}
*
* @author Jeongho Nam - https://github.com/samchon
*/
Expand Down

0 comments on commit 0a7e87d

Please sign in to comment.