GetShopTV/swagger2

AWS API Gateway compatability

Open

#113 opened on Aug 17, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (61 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (74 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

FYI: I've just found out from AWS technical support that the reason my generated (from servant-swagger) Swagger specification wasn't working was because they don't support the example field for objects/models.

It might be worth documenting this.

Contributor guide

Research direction
Identify where in the documentation to add a note about AWS API Gateway not supporting the `example` field for objects/models.
Tech stack
haskell
Domain
api
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwaggerAWS API Gateway
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90