Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add openApiDocument to module-loader Context #968 #1144

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mgrigoriev8109
Copy link

I think this change passes the openApiDocument over from the app.ts file to the module-loader.ts. Wasn't 100% sure how to test this change locally though, so I'd love to do that if someone can help me wrap my head around it.

Copy link

changeset-bot bot commented Dec 27, 2024

⚠️ No Changeset found

Latest commit: 48366b7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dethell
Copy link
Collaborator

dethell commented Dec 27, 2024

I think this change passes the openApiDocument over from the app.ts file to the module-loader.ts. Wasn't 100% sure how to test this change locally though, so I'd love to do that if someone can help me wrap my head around it.

I'll pull this on Monday (or today if at all possible) and see how your changes look. I'll circle back on what tests need to be updated.

Copy link
Owner

@pmcelhaney pmcelhaney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you and nice work! This looks right as far as I can tell.

To test, reference the new argument in your _.context.ts file. If you just want to test that it worked, console.log it.

We'll want a unit test too. I'm not sure how to approach that off the top of my head. Will look this week. 😅

new endpoint.Context({
loadContext,
}),
openApi
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this up one line so it's part of the object including loadContext.

The idea to pass a single parameter object to the constructor for a Context class. We can use destructing to make the constructor's signature look like it takes a list of named arguments.

Here's what a context class might look like.

export class Context {
   constructor({ loadContext, openApi }) {

     // grab the context object from some other path
     const otherContext = loadContext("/some/path");
    
     // read the OpenAPI document 
     const paths = openApi.paths;

     // ...
  } 
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants