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.

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

for each JSON service, the documentation of the service should note that inputs should be "json-able" julia objects, not raw json #674

Open
ericphanson opened this issue May 28, 2024 · 0 comments

Comments

@ericphanson
Copy link
Member

xref #673 (comment)

For DynamoDB, the docs start with

This page documents function available when using the Dynamodb module, created with [@service Dynamodb](https://juliacloud.github.io/AWS.jl/stable/aws.html#AWS.@service-Tuple{Symbol,%20Vararg{Any}}).

I think it should say:

This page documents function available when using the Dynamodb module, created with [@service Dynamodb](https://juliacloud.github.io/AWS.jl/stable/aws.html#AWS.@service-Tuple{Symbol,%20Vararg{Any}}).

## Inputs

All inputs to Dynamodb functions should be passed as Julia objects, such as nested `Dict`s, rather than raw JSON.

## Table of contents

Ideally it would have an example also, but those we would have to manually write per-service, whereas this sentence we could autogenerate and stick in for all JSON services. (Or all services? not sure)

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

No branches or pull requests

1 participant