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

Update EntityShape docs for clarity of use #874

Merged
merged 1 commit into from
Aug 2, 2021
Merged

Update EntityShape docs for clarity of use #874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion smithy-model/src/main/java/software/amazon/smithy/model/shapes/EntityShape.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@ public final Set<ShapeId> getResources() {
* Gets operations bound only through the "operations" property.
*
* <p>This will not include operations bound to resources using
* a lifecycle operation binding.
* a lifecycle operation binding. This will also not include
* operations bound to this entity through sub-resources.
*
* @return Get the "operations" directly bound to this shape.
* @see #getAllOperations()
* @see software.amazon.smithy.model.knowledge.TopDownIndex#getContainedOperations
*/
public final Set<ShapeId> getOperations() {
return operations;
Expand All @@ -57,7 +59,12 @@ public final Set<ShapeId> getOperations() {
/**
* Get all operations directly bound to this shape.
*
* <p>This will include operations bound directly to resources
* using a lifecycle operation binding. This will not include
* operations bound to this entity through sub-resources.
*
* @return Returns all operations bound to the shape.
* @see software.amazon.smithy.model.knowledge.TopDownIndex#getContainedOperations
*/
public Set<ShapeId> getAllOperations() {
return getOperations();
Expand Down