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.

Sign up for GitHub

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

Jump to bottom

Move OpenApiSpec to a standalone npm package #177

Merged
merged 1 commit into from
Apr 20, 2017
Merged

Move OpenApiSpec to a standalone npm package #177

merged 1 commit into from
Apr 20, 2017

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Apr 19, 2017

Connect to #135

Next steps (I'll create a follow-up issues):

  • add basic tests to verify that example Swagger documents can be compiled against this type definition
  • support the upcoming 3.0 flavour of OpenAPI Spec

cc @bajtos @raymondfeng @ritch @superkhau

@bajtos bajtos added this to the Sprint 34 - Asteroid milestone Apr 19, 2017
@bajtos bajtos self-assigned this Apr 19, 2017
@bajtos bajtos requested review from ritch and superkhau April 19, 2017 13:12
@bajtos bajtos added the review label Apr 19, 2017
@bajtos bajtos mentioned this pull request Apr 19, 2017
Closed
3 tasks
@bajtos
Copy link
Member Author

bajtos commented Apr 19, 2017

Few questions to consider: is it worth keeping this code inside loopback-next as a loopback-specific thing? I was pondering the idea of creating standalone repository/package called typed-swagger that could be used by any TS developer.

@raymondfeng @superkhau @ritch Thoughts?

@raymondfeng
Copy link
Contributor

@bajtos Can we rename it as openapi-spec since openapi the name of the org/spec?

@superkhau
Copy link
Contributor

@bajtos I think we can move it out anytime, here is good for now.

superkhau
superkhau approved these changes Apr 19, 2017
View reviewed changes
packages/open-api-spec/README.md Outdated
$ npm install --save @loopback/open-api-spec
```

## Basic use
Copy link
Contributor

Choose a reason for hiding this comment

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

Basic use -> Usage

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope, see http://loopback.io/doc/en/contrib/README-guidelines.html#basic-use

Basic use
Tip: This section is often titled “Usage,” but we prefer “Use” because it is a shorter and more common word, and means the same thing.

Copy link
Contributor

Choose a reason for hiding this comment

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

I stand corrected. ;)

packages/open-api-spec/README.md Outdated
}
```

IDEs like VisualStudio Code will offer auto-completion for spec properties
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Visual Studio

@bajtos bajtos force-pushed the refactor/typed-swagger branch from 485c3d2 to f4a18af Compare April 20, 2017 07:39
@bajtos bajtos merged commit f0439c9 into master Apr 20, 2017
@bajtos bajtos deleted the refactor/typed-swagger branch April 20, 2017 07:51
@bajtos bajtos removed the review label Apr 20, 2017
This was referenced Apr 20, 2017
Closed
Closed
@bajtos
Copy link
Member Author

bajtos commented Apr 20, 2017

Thank you for the review. Here are the two follow-up issues I created:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@superkhau superkhau superkhau approved these changes

@ritch ritch ritch approved these changes

Assignees

@bajtos bajtos

Labels
refactor
Projects
None yet
Milestone
Sprint 34 - Asteroid
Development

Successfully merging this pull request may close these issues.
4 participants
@bajtos @raymondfeng @superkhau @ritch