WardrikRest.Discovery (wardrik_rest v0.1.0-rc.1)

Copy Markdown

Reads Google Discovery documents, the format Google describes its APIs in.

{:ok, analytics} =
  WardrikRest.API.load(
    {WardrikRest.Discovery,
     url: "https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta"},
    name: "ga4",
    base_url: "https://analyticsdata.googleapis.com/"
  )

Options

  • :url - where the document is. :req_options are merged into its request.
  • :document - the document itself, decoded, as from a file.

Each method becomes an operation named by its resources, as properties_runReport. Its body's fields become arguments beside its path and query parameters; a body field named like a parameter is left out. A method with scopes signs in with "oauth2", or takes the API key as "key" where the document has one. Its schemas become the spec's types; see WardrikRest.Discovery.Schema.