docman icon indicating copy to clipboard operation
docman copied to clipboard

Need to document JSON inputs

Open wgosse opened this issue 9 years ago • 2 comments

docman doesn't seem to document json inputs being posted like: { "apiKey": "oz91xbptCZsC9tlGpTeMcggNqbDll4Y", "requestId": "testgenkey002", "userId": 10664, "emailAddress": "[email protected]"
} image

wgosse avatar Jun 03 '15 18:06 wgosse

Could you post the whole request? In my examples it documents JSON inputs, but only if they are passed as raw data:

        {
            "collectionId": "79544af9-6e5f-7b72-5559-2434ddd30c9f",
            "id": "9a2ac490-0049-4b72-9710-5da16abda4f8",
            "name": "POST bar",
            "description": "",
            "url": "http://192.168.56.101/yii_restful_api/index.php/bar/",
            "method": "POST",
            "headers": "Authorization: hmac johndoe:386c5ff8231507f8087463a4dbdf7a9831c6e440\nTimestamp: 1429562482\n",
            "data": [],
            "dataMode": "raw",
            "timestamp": 0,
            "responses": [],
            "version": 2,
            "owner": 0,
            "preRequestScript": "",
            "tests": "",
            "synced": false,
            "rawModeData": "{\"name\":\"aw, also raw data here\"}"
        }

Does your data is in the rawModeData field?

davidevernizzi avatar Jun 13 '15 16:06 davidevernizzi

Any update for documenting "urlencoded" dataMode ?

harshreddy avatar Dec 17 '15 14:12 harshreddy