Skip to content

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 4 commits into from
Feb 25, 2025
Merged
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Custom Types**: Define inline `customType`.
- **Reference Types**: Use `a.ref()` to reference enums and custom types.
- **Custom Types**: Define inline `customType`
- **Reference Types**: Use `a.ref()` to reference enums and custom types

nit, we can omit the periods in unordered lists when we are not writing complete sentences or paragraphs


```ts title="amplify/data/resource.ts"
const schema = a.schema({
Status: a.enum({
values: ['ACCEPTED', 'REJECTED']
}),

echo: a
Copy link
Contributor

Choose a reason for hiding this comment

The 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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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

Expand Down
Loading