-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update custom operations documentation with supported argument examples #8260
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ab1f330
Update custom operations documentation with newly supported examples
vaisshnavi7 a291631
Add supported argument types section for custom operations
vaisshnavi7 3fab5cd
Update query name and remove periods
vaisshnavi7 c0c7169
update enum syntax
vaisshnavi7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -510,6 +510,40 @@ safePrint(echoResponse.echo.content); | |
``` | ||
|
||
</InlineFilter> | ||
## Supported Argument Types in Custom Operations | ||
|
||
Custom operations can accept different types of arguments. Understanding these options helps define flexible and well-structured APIs. | ||
|
||
### Defining Arguments in Custom Operations | ||
|
||
When defining a custom operation, you can specify arguments using different types: | ||
|
||
- **Scalar Fields**: Basic types such as `string`, `integer`, `float`, etc. | ||
- **Custom Types**: Define inline `customType`. | ||
- **Reference Types**: Use `a.ref()` to reference enums and custom types. | ||
|
||
```ts title="amplify/data/resource.ts" | ||
const schema = a.schema({ | ||
Status: a.enum({ | ||
values: ['ACCEPTED', 'REJECTED'] | ||
}), | ||
atierian marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
echo: a | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit -- can we use a different operation name to differentiate it from the example used in Step 1-3 on this page? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure! I will use a different name |
||
.query() | ||
.arguments({ | ||
// scalar field | ||
content: a.string(), | ||
// inline custom type | ||
config: a.customType({ | ||
filter: a.string(), | ||
// reference to enum | ||
status: a.ref('Status') | ||
}), | ||
}) | ||
.returns(a.string()) | ||
.authorization(allow => [allow.authenticated()]) | ||
}); | ||
``` | ||
|
||
## Async function handlers | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
nit, we can omit the periods in unordered lists when we are not writing complete sentences or paragraphs