Remove usages of "@loopback/openapi-v3-types" and deprecate the package#3220
Merged
Remove usages of "@loopback/openapi-v3-types" and deprecate the package#3220
Conversation
3 tasks
raymondfeng
reviewed
Jun 24, 2019
docs/site/Defining-the-API-using-design-first-approach.shelved.md
Outdated
Show resolved
Hide resolved
raymondfeng
approved these changes
Jun 24, 2019
nabdelgadir
approved these changes
Jun 24, 2019
Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Move the definition of the type alias `OpenApiSpec` to a new file `types.ts`. Rework all imports from `@loopback/openapi-v3-types` to import from `types.ts` instead, remove the openapi-v3-types package from the dependencies too. Add the helper `createEmptyApiSpec()` to preserve backwards compatibility for code importing the helper from this package or its dependants like `@loopback/rest`. Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Rework all imports from `@loopback/openapi-v3-types` to import from `types.ts` instead, remove the openapi-v3-types package from the dependencies too. Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Rework all imports from `@loopback/openapi-v3-types` to import from `@loopback/openapi-v3` instead, remove the openapi-v3-types package from the dependencies too. Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
52b06c9 to
2c5b83f
Compare
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove remaining usage of
@loopback/openapi-v3-typesand deprecate the package.See #301
I decided against upstreaming this helper. The builder in openapi3-ts is adding more empty objects to the spec, I am concerned that by reworking
createEmptyApiSpecto leverate their builder, we could break existing tests depending on less fields being set in an empty spec.See https://github.com/metadevpro/openapi3-ts/blob/e55fef88e6b9188678528bdf33fee0072033a720/src/dsl/OpenApiBuilder.ts#L14-L35
I decided to move
createEmptyApiSpectoopenapi-v3to preserve backwards compatibility for users of ouropenapi-v3andrestpackages.Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈