openapi-v3-types module: add basic tests

[bajtos]

Add basic tests to verify that example OpenAPI v3 documents and Swagger documents (via converter) can be compiled against the type definition. Create test infrastructure that makes it easy to add focused tests in the future.

This is a follow-up issue for #177.

Acceptance Criteria

• Add validation test for OpenAPI v3 document
• Add validation test for Swagger document (converted from v3 document)
• Add scaffolding to allow unit tests in future

BLOCKED BY

• Drop our openapi-spec packages, use openapi3-ts instead #301
• [OpenAPI] Switch to OpenAPI v3 for spec and routing #753

[shimks]

I'm not sure if this issue is valid anymore. We've dropped v3 to v2 conversion from MVP (as far as I know) and we have validation for v3 in @loopback/testlab. We also have some scaffolding in @loopback/openapi-spec-builder.

I think we should repurpose this issue to add in what we discussed here #754 (comment) and then re-estimate it.

@strongloop/lb-next-dev thoughts?

[shimks]

@jannyHou Could you cross off the tasks here that have been done as part of your work on #753?

[jannyHou]

@shimks I don't think this is done in #753, we don't have tests for package loopback-next/openapi-v3-types and loopback-next/openapi-spec-builder. I see a bunch of discussion linked to this issue, and am confused by the description

Add basic tests to verify that example OpenAPI v3 documents and Swagger documents (via converter) can be compiled against the type definition

Could you summarize a little bit what are we adding in this issue? tests for openapi-v3-types or openapi-spec-builder or both?

[shimks]

Could you summarize a little bit what are we adding in this issue? tests for openapi-v3-types or openapi-spec-builder or both?

I think the fact that we need to ask this question is an indication that this story needs re-grooming.
@strongloop/lb-next-dev Can we get a discussion going to get the clarification we need for this topic?

[dhmlau]

I guess we need clarification from @bajtos who created this issue?

[dhmlau]

Looking at this issue again, I'm thinking maybe the acceptance criteria is clear enough? The title of this ticket is openapi-v3-types module: add basic tests. Doesn't it mean adding test for at least openapi-v3-types?

Should we leave adding tests for openapi-spec-builder as out-of-scope (thus create new issue to track it) or as part of the acceptance criteria (then we edit the criteria above)?

[shimks]

Now that I've taken a look at this issue again, I think it's fine as it is now :p (sorry for the confusion). I personally think adding in tests for openapi-spec-builder should be done as a part of the task and should have been inferred from the criteria, even if it hasn't been explicitly mentioned

[dhmlau]

ok. i'll remove needs clarification tag then. thanks.

[virkt25]

Add validation test for Swagger document (converted from v3 document) is no longer relevant as the we only support OAS 3 only now.