@samchon/openapi - npm Package Compare versions

Comparing version 0.1.17-dev.20240418 to 0.1.17

package.json

		{
		"name": "@samchon/openapi",
		"version": "0.1.17-dev.20240418",
		"version": "0.1.17",
		"description": "OpenAPI definitions and converters for 'typia' and 'nestia'.",
		@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

		@@ -10,3 +10,3 @@ # `@samchon/openapi`

		OpenAPI definitions and converters for [typia](https://github.com/samchon/typia) and [nestia](https://github.com/samchon/nestia).
		OpenAPI definitions and converters (for [typia](https://github.com/samchon/typia) and [nestia](https://github.com/samchon/nestia)).

		@@ -19,3 +19,3 @@ `@samchon/openapi` is a collection of OpenAPI definitions of below versions. Those type definitions does not contain every properties of OpenAPI specification, but just have only some features essentially required for `typia` and `nestia` (especially [`@nestia/editor`](https://nestia.io/docs/editor/)).

		Also, `@samchon/openapi` provides emended OpenAPI v3.1 definition and its converter from above versions for convenient development. The keyword "emended" means that [`OpenApi`](https://github.com/samchon/openapi/blob/master/src/OpenApi.ts) is not a direct OpenAPI v3.1 specification (OpenApiV3_1), but a little bit shrinked to remove ambiguous and duplicated expressions of OpenAPI v3.1 for the convenience of typia and nestia
		Also, `@samchon/openapi` provides emended OpenAPI v3.1 definition and its converter/inverter from above versions for convenient development. The keyword "emended" means that [`OpenApi`](https://github.com/samchon/openapi/blob/master/src/OpenApi.ts) is not a direct OpenAPI v3.1 specification (OpenApiV3_1), but a little bit shrinked to remove ambiguous and duplicated expressions of OpenAPI v3.1 for the convenience of typia and nestia

		@@ -60,2 +60,10 @@ For example, when representing nullable type, OpenAPI v3.1 supports three ways. In that case, OpenApi remains only the third way, so that makes `typia` and `nestia` (especially [`@nestia/editor`](https://nestia.io/docs/editor/)) to be simple and easy to implement.
		const output: OpenApi.IDocument = OpenApi.convert(input);

		// it is possible to downgrade to Swagger v2 or OpenAPI v3
		const v2: SwaggerV2 = OpenApi.downgrade(output, "2.0");
		const v3: OpenApiV3 = OpenApi.downgrade(output, "3.0");

		// you can utilize it like below
		OpenApi.downgrade(OpenApi.convert(v2), "3.0");
		OpenApi.downgrade(OpenApi.convert(v3), "2.0");
		```
		@@ -62,0 +70,0 @@

@samchon/openapi - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics