GetShopTV/swagger2

JSON keys examples in a Schema of (Map UUID Something)?

Open

#136 opened on Dec 13, 2017

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

Repository metrics

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

Description

Sometimes it’s useful to return a Map k v from an API, e.g. when this k is some kind of a newtype over UUID, or similar.

Anyway, in such a case, the generated example value looks like:

    "accounts": {
      "additionalProp1": {
        "username": "string"
      },
      "additionalProp2": {
        "username": "string"
      },
      "additionalProp3": {
        "username": "string"
      }
    }

while the real response:

    "accounts": {
      "bff3d422-13be-48ad-b344-7e30d38c2c3f": {
        "username": "michalrus1"
      },
      "cbad52fd-96ae-4154-ad26-c8e8c8902a26": {
        "username": "michalrus2"
      }
    }

Perhaps it’d possible to have:

    "accounts": {
      "00000000-0000-0000-0000-000000000000": {
        "username": "string"
      },
      "00000000-0000-0000-0000-000000000000": {
        "username": "string"
      },
      "00000000-0000-0000-0000-000000000000": {
        "username": "string"
      }
    }

?

Now, the generated swagger.json contains:

        "accounts": {
          "additionalProperties": {
            "$ref": "#/definitions/Account"
          },
          "type": "object"
        }

Contributor guide

Research direction
Investigate how example values are generated for additionalProperties in the swagger2 library. The current implementation uses 'additionalProp1', 'additionalProp2', etc. as example keys. To generate UUID like keys, you need to modify the example generation logic to produce UUID strings (e.g., '00000000-0000-0000-0000-000000000000') when the key schema is a UUID type. Look at the Schema example generation code, possibly in the Data.Swagger.Schema module, and consider adding a mechanism to generate meaningful examples based on the key schema.
Tech stack
haskell
Domain
apidocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
HaskellSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60