package awsm-codegen

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Awsm_codegen.Query_paramSource

Sourcetype t

An abstract representation of a URL query parameter.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Constructors

Sourceval create : name:string -> field_name:string -> shape:string -> is_required:bool -> t

Build from fields.

  • parameter name

    The (http) name of the parameter.

  • parameter shape

    The boto shape name in the operation.

  • parameter is_required

    Is this required or optional?

Sourceval of_botodata : Botodata.operation -> shapes:(string, Botodata.shape) Core.List.Assoc.t -> t list

Build from a parsed Botodata.operation.

Accessors

Sourceval is_required : t -> bool

Helpers

Sourceval param_name : t -> string

The HTTP parameter name (the locationName).

Sourceval field_name : t -> string

The field name in the name in the ocaml record type.

Code generation

Emit a converter.

If the corresponding shape is Mod, emit Mod.to_header.