spectaql/examples/data/metadata.json

A powerful library for autogenerating static GraphQL API documentation

{
  "OBJECT": {
    "SecretType": {
      "documentation": { "undocumented": true }
    },
    "MyType": {
      "fields": {
        "nonRequiredField": {
          "documentation": { "example": "Metadata example of `nonRequiredField`"}
        }
      }
    },
    "Query": {
      "fields": {
        "myQuery": {
          "args": {
            "nonReqQueryArg": {
              "documentation": { "example": "Metadata example of `nonReqQueryArg`" }
            }
          }
        }
      }
    }
  },
  "SCALAR": {
    "DateTime": {
      "documentation": { "example": "2016-10-07T01:08:03.420Z" }
    }
  },
  "INPUT_OBJECT": {
    "FilterInput": {
      "inputFields": {
        "someField": {
          "documentation": { "example": true }
        },
        "anotherField": {
          "documentation": { "example": "Metadata example of `anotherField`" }
        },
        "episodeEnums": {
          "documentation": { "example": ["EMPIRE"] }
        }
      }
    }
  },
  "ENUM": {
    "EpisodeEnum": {
      "enumValues": {
        "EMPIRE": {
          "documentation": { "undocumented": true }
        }
      }
    }
  },
  "INTERFACE": {
    "MyInterface": {
      "fields": {
        "id": {
          "documentation": { "example": "exampleFromMetadataJson" }
        },
        "name": {
          "documentation": { "undocumented": true }
        }
      }
    }
  }
}