{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cfd54cdf-cdbc-4e6d-b497-7e17ff2c8b6f","name":"Documentation Assistant","description":"The Documentation Assistant is like having an automatic code review to ensure well-documented collections, every time. \n\n## How do I use it?\nIt's pretty easy! Just follow the flow of the requests as they're listed, and fill in the environment variables as you need them:\n1. Plug in your Postman API key into the environment. Need an API Key? [Here's how to get one.](https://learning.postman.com/docs/developer/intro-api/#generating-a-postman-api-key) \n1. Under the `Reports` folder, run the `All workspaces` request - this will get all of the workspaces accessible from your account.\n3. Choose which workspace you'd like to work with, copy its id, and pasted that into the `workspace_id` environment variable.\n4. Run the `Workspace Report` request and toggle over to the Visualize response pane. This will give you an overview of how far along each of your collections are. To get the full report on a collection, copy the given UID and paste it into the `demo_collection_uid` environment variable. \n4. Run the `Collection Report` request and toggle over to the Visualizer response pane. This will take the JSON representation of your chosen collection, run it through our series of checks, and prepare a report on what you can do to improve.\n\n## Slack Integration\nWant to add improving your docs to your daily routine? You're in luck because we've got a Slack bot for that. \n\n1. First you'll need to set up your slack webhook. [Click here](https://api.slack.com/apps?new_app=1), choose your desired workspace if prompted, then click \"Create new app\". (Don't worry, its not as involved as it sounds.) \n2. You'll then want to scroll down and click the section titled **Incoming Webhooks**. \n3. On that new page, toggle the switch beside \"Activate incoming webhooks\" so that the toggle is set to \"on\". \n4. At the bottom of the page, click the button that says \"Add new webhook to workspace.\" Select the channel or private message recipient you'd like to send your gorgeous new reports to. \n5. Now, copy your new webhook url and paste it into the `slack_webhook` environment variable. \n6. To test that it works, try sending one of the requests under the Slack folder. Make sure you have sent the corresponding workspace or collection request under Reports so that all of the appropriate variables will be filled in. You should hear that sweet slack clack, and will immediately forget that you sent yourself a message. Still, success!\n7. If you want to take it a step further, you can add an icon to your app like is shown in the video. We’ve put together a couple options for you to choose from, which you can download [here](https://github.com/mtna/postman-utils/tree/master/assets/slack). Go to your app page, navigate to Basic Information and scroll down to Display Information, then you can upload an icon of your choosing\n\n## Monitors\nYou probably want these reports coming to you without having to press the button every day right? That's where monitors come in. From your collection-level settings, click the Monitors menu button, and fill out the appropriate information to have reports sent to you daily, weekly, whatever you want. Note that if you leave the collection as-is, you'll get both the collection and workspace report every day. You could break these out into separate collections with different monitor settings if you'd like just one or the other. ","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"6470514","team":242404,"collectionId":"cfd54cdf-cdbc-4e6d-b497-7e17ff2c8b6f","publishedId":"TW6tMAhq","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6470514/TW6tMAhq","privateUrl":"https://go.postman.co/documentation/6470514-cfd54cdf-cdbc-4e6d-b497-7e17ff2c8b6f","customColor":{"top-bar":"FFFFFF","right-sidebar":"666666","highlight":"448893"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-01-24T20:57:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Documentation Hacking","id":"01ae45d9-7c39-416c-b8c2-7a8937ff393f","owner":"2220438","values":[{"key":"collection_report_uid","value":"","enabled":true},{"key":"demo_collection_uid","value":"","enabled":true},{"key":"demo_collection_model_id","value":"","enabled":true},{"key":"workspace_id","value":"","enabled":true},{"key":"slack_webhook","value":"","enabled":true},{"key":"demo_collection_model_fork","value":"","enabled":true},{"key":"model_collection_json","value":"","enabled":true},{"key":"allCollections","value":"","enabled":true},{"key":"postman_api_key","value":"","enabled":true},{"key":"demo_collection_json","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Documentation Hacking","value":"2220438-01ae45d9-7c39-416c-b8c2-7a8937ff393f"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TW6tMAhq"}