-
Notifications
You must be signed in to change notification settings - Fork 120
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
Reference Specification for API first approach #93
Conversation
Co-authored-by: IgorTodorovskiIBM <39890068+IgorTodorovskiIBM@users.noreply.github.com>
Co-authored-by: IgorTodorovskiIBM <39890068+IgorTodorovskiIBM@users.noreply.github.com>
@wtrocki I pushed a commit with a substantial edit (I could not easily figure out how to do a PR against your PR). We can discard if the edit does not make sense to you. |
Provided changes looks good, but I'm not 100% sure if we want to rebrand this as My only concern is that many developers can look into this chapter as "Building your API with express" and it will find very opiniated and unfamiliar concept for them to look at. |
@wtrocki maybe we can add some additional words. The sections we have are "the team has had success with X". If our main success is with API first using express then it makes sense that this is what is in this section. Instead of narrowing the title I think it would be better to expand the content if there are other approaches/tools that we have used regularly and have had success with. I do think we want a topic with our guideance/experience with how to build a REST API. |
The other thing I should have mentioned is that we should add the referenced modules to the npcheck.json file. |
Co-authored-by: Wojciech Trocki <wtrocki@redhat.com>
npmcheck.json seems to be non functional right now and failing on build. Can I get help with adding those packages and fixing build? See #94 |
Getting npcheck working again on the repo is a priority. There is some ongoing discussion here: https://github.com/nodeshift/npcheck/pu](https://github.com/nodeshift/npcheck/pull/88. @richardlau has been out the last week though and I've had lots of other things so have had time to look. We should try to make sure we resolve in some way next week. |
Done npmcheck.json Can we get this merged? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some minor typos found 👍
Co-authored-by: Helio Frota <00hf11@gmail.com>
Co-authored-by: Richard Lau <rlau@redhat.com> Co-authored-by: Helio Frota <00hf11@gmail.com>
Need help with npmcheck |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with change of name to REST API Development as agreed in meeting today.
probably need to add these 2 packages in npcheck.json? "tslib@2.3.1" ---- package which is under the non-acceptable license "0BSD". |
@helio-frota can you help me with those. I did not added those packages myself. |
@wtrocki I think you just need to update npcheck.json with
|
@wtrocki looked at the remaining 2 licence failure reports and the overall addition to the rules. 0BSD seems fine to me as it is less restrictive than the BSD ones we allow by default and the other 2 (Python-2.0 and CC-BY-4.0) we've already allowed exceptions for other components since they don't look like they'd be an issue. I went ahead and update to allow thosteand the "due dilligence" is now green. |
@mhdawson thank you so much! Let's merge that. I will
|
Pushed a commit on main branch to rename to "REST API Development" based on what we agreed in ref arch meeting this week. |
Landing as first version/draft for discussion.
Some styles/links will be improved further.
I have also draft blog post to accompany this spec.