Skip to content

Commit

Permalink
Update experimental.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz authored Oct 19, 2022
1 parent 21d70dc commit fa40ce4
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ Majority of methods on an entity will follow a standard method signature.

- `*ResourceContainer` determines the "level" of the resource and where it will
operate at. Operated using `UserIdentifier`, `ZoneIdentifier`, and
`AccountIdentifier` respectively
- `$entityID` is the resource identifier
`AccountIdentifier` respectively.
- `$entityID` is the resource identifier.
- `params` is a complex structure that allows filtering/finding resources
matching the struct fields
- `$entity` the resource being operated on
matching the struct fields. By providing a structure as the third argument
in all the methods that require it, we can add/remove fields without the
need for a breaking change and instead can issue deprecation notices when
specific fields are used.
- `$entity` the resource being operated on.

Exceptions to this convention will be:

Expand Down

0 comments on commit fa40ce4

Please sign in to comment.