Skip to content

Describe the "id" parameter of model's sharedCtor#223

Merged
bajtos merged 1 commit into
masterfrom
feature/improve-sharedctor-description
Apr 4, 2014
Merged

Describe the "id" parameter of model's sharedCtor#223
bajtos merged 1 commit into
masterfrom
feature/improve-sharedctor-description

Conversation

@bajtos

@bajtos bajtos commented Apr 3, 2014

Copy link
Copy Markdown
Member

Extend remoting metadata to describe the "id" parameter accepted
by the sharedCtor of all models.

The description is used by client SDK code generators like loopback-angular.

/to @raymondfeng or @ritch please review.

Extend remoting metadata to describe the "id" parameter accepted
by the sharedCtor of all models.
@bajtos

bajtos commented Apr 3, 2014

Copy link
Copy Markdown
Member Author

Note: it's important to include model name in the description.

AngularJS converts prototype scope methods to static methods, i.e. /products/:id/categories is called by Product.categories({ id: "product-id" }). If the description of the "id" parameter was generic or missing, it would be unclear whether the id parameter is product id or category id.

@slnode

slnode commented Apr 3, 2014

Copy link
Copy Markdown

All is well
Refer to this link for build results: http://ci.strongloop.com/job/loopback/1053/

@raymondfeng

Copy link
Copy Markdown
Member

LGTM

bajtos added a commit that referenced this pull request Apr 4, 2014
…scription

Describe the "id" parameter of model's sharedCtor
@bajtos
bajtos merged commit e8971fd into master Apr 4, 2014
@bajtos
bajtos deleted the feature/improve-sharedctor-description branch April 4, 2014 14:36
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