Skip to content
This repository was archived by the owner on Sep 29, 2022. It is now read-only.
This repository was archived by the owner on Sep 29, 2022. It is now read-only.

Required input / outputs #16

@r-shanahan

Description

@r-shanahan

Priority for post-parsing fix: How do we show if a sub-object of a request object is required? We only have annotations for the top object.
say we have:
// @Param type body input.MerchantStatement true "Request schema"

where the input.MerchantStatement object is required, and MerchantStatement looks like:

type MerchantStatement struct {
   Type     models.StatementType `json:"type"`
   FileType *StatementFileType    `json:"file_type,omitempty"`
}

How in API specs, do we intent to be able to mark sub fields of an object with mandatory or not (say Type was mandatory but FileType was not)? Will Speakeasy look at the json tags or object type?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions