Uploaded image for project: 'PuppetDB'
  1. PuppetDB
  2. PDB-1292

puppetdb api docs should include concrete examples

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PDB 3.0.0
    • Component/s: DOCS
    • Labels:
      None
    • Template:
    • Story Points:
      2
    • Sprint:
      PuppetDB 2015-07-01

      Description

      In https://docs.puppetlabs.com/puppetdb/latest/api/commands.html, I'm having an extremely difficult time figuring out how to construct a curl command that would issue any of these commands. I'm not sure whether I'm just clueless, but these docs just don't give me enough to interact with the API.

      As an example, https://forgeapi.puppetlabs.com/ provides the kind of in-depth documentation I'm looking for. They use http://swagger.io/ to generate that documentation programmatically.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              daniel.dreier Daniel Dreier
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Zendesk Support