How to override post-response script content for the postman?

[hardiklakhalani]

Scribe version

4.35.0

Your question

How to override post-response script content for the postman?

Here is the script I want to add in my login request:

pm.collectionVariables.set("token", pm.response.json().data.token);

Following is the variables I've already overridden successfully:

But not sure how to add the post-response script to the login request.

'postman' => [
        'enabled' => true,
        'overrides' => [
            // 'info.version' => '2.0.0',
            'info.name' => 'Example API',
            'info.description' => 'API documentation for the Example API.',
            'variables' => [
                [
                    "key"=> "baseUrl",
                    "value"=>"http://xyz_site.test",
                    "type"=>"string"
                ],
                [

                    "key"=>"token",
                    "value"=> null,
                    "type"=>"string"
                ],
                [
                    "key"=>"password",
                    "value"=>"12345678",
                    "type"=>"string"
                ],
                [
                    "key"=>"email_user",
                    "value"=>"[email protected]",
                    "type"=>"string"
                ]
            ],
            "auth" => [
                "type" => "bearer",
                "bearer" => [
                    "key" => "token",
                    "value" => "{{token}}",
                    "type" => "string"
                ]
            ]
        ],
    ],

Following is the post-response script example snippet from the postman collection export:

{
	"item": [
		{
			"name": "Authentication",
			"item": [
				{
					"name": "Login User",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"pm.collectionVariables.set(\"token\", pm.response.json().data.token);"
								],
								"type": "text/javascript",
								"packages": {}
							}
						},
						{
							"listen": "prerequest",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript",
								"packages": {}
							}
						}
					],
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Accept",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\"email\":\"{{email_admin}}\",\"password\":\"12345678\"}"
						},
						"url": {
							"raw": "{{baseUrl}}/api/login",
							"host": [
								"{{baseUrl}}"
							],
							"path": [
								"api",
								"login"
							]
						}
					},
					"response": []
				}
			]
		},
	]
}

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

I have no idea. Where is the script meant to be specified in the Postman collection file format? Doesn't the overrides section work?

[ahmed-aliraqi]

This works with me :

// config/scribe.php
...
'postman' => [
        'enabled' => true,

        'overrides' => [
            // 'info.version' => '2.0.0',
            'auth' => [
                'type' => 'bearer',
                'bearer' => [
                    [
                        'key' => 'token',
                        'value' => '{{accessToken}}',
                        'type' => 'string',
                    ],
                ],
            ],
            "event" => [
                [
                    "listen" => "test",
                    "script" => [
                        "type" => "text/javascript",
                        "exec" => [
                            "const paths = [",
                            "    '/api/login',",
                            "    '/api/register'",
                            "];",
                            "",
                            "if (paths.includes(pm.request.url.getPath())) {",
                            "    var response = JSON.parse(responseBody);",
                            "",
                            "    if (response.token) {",
                            "        if(pm.environment.name) {",
                            "            pm.environment.set('accessToken', response.token);",
                            "        } else {",
                            "            pm.collectionVariables.set('accessToken', response.token);",
                            "        }",
                            "    }",
                            "}"
                        ]
                    ]
                ]
            ]
        ],
    ],
    ...