{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c357f411-8af7-4856-98dd-5f062a6a884c","name":"Model Creation","description":"## Overview\nThe model creation collection is meant to provide users with an example of how they may be able to incorporate the Docu-Mentor model generation functionality into their Postman collections. \n\n## Creating Models\nDocu-Mentor's model generation will evaluate your Postman collection and generate documentation for the models it finds. It looks for any request or responses that are written in JSON. It will read these objects and create model requests for each of them inside an \"API Models\" folder. Each of these requests will have the example response filled out as well as a generated description with a table that describes the properties in the model. This table has the property names, an empty column for a description of the property to be added, and the data type of the property. If the property is an object, a reference to the generated model will be there. The request description will also identify the requests that use this model, and where in the request (request or response) the model is located. \n\nIn addition to the model requests. The descriptions of the original requests will be modified to specify any models that are used in their request or response bodies. \n\nThis should help users be able to identify and locate the models that they need to know about for any particular request, as well as a way to learn about the models they are using.\n\n## Renaming Models\nThe models that Docu-Mentor generates are generically named, so the resulting list of models will be \"Model 1\", \"Model 2\", etc. Because we cannot infer the names of the models, Docu-Mentor has an additional method that allows users to rename these models. They can provide the updated collection, along with a map of old model names to new model names. The renaming capability will look for any and all references to that model in the descriptions included in the collection and make the appropriate changes to rename them. This should provide those working with the documentation some ability to speed up this otherwise tedious process. \n\n## Collection Workflow\nThis collection demonstrates how we would expect users to use Docu-Mentor to add Models to their Postman collection.\n\n1. Create a fork - When updating or adding to a collection we would suggest creating a fork first. This will allow users to add all the models to the collection and ensure that the documentation looks good to them before merging it back into the original collection. This will save the forked collections ID in an environment variable. \n2. Get the forked collection - Using the forked collection's ID, we will get the collection JSON from the Postman API. This will be saved to an environment variable to be passed along to the Docu-Mentor API. \n3. Generate the models - Pass the collection object to the Docu-Mentor model generation endpoint. This will return an updated collection object that includes the API Models folder. \n4. Rename the models - After looking through the models in the updated collection, those documenting the API should rename the models to the appropriate object names.\n5. Update the forked collection - Updating the forked collection will now add the models to the Postman collection. \n6. Merge the fork into the original - Once the forked collection has been filled out, reviewed, and verified to be correct, it can be merged back into the original collection. \n\n## Example Output\nThe **Model Creation - Demo Collection** and its forked version provide an example of what Docu-Mentor's model generation produces. The API Model folder in the fork contains a list of requests that describe each model used in the collection. The original requests also link to the models that they use. When published online these links will be able to help navigate users through the documentation to the different requests and the models they use. ","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"6470514","team":242404,"collectionId":"c357f411-8af7-4856-98dd-5f062a6a884c","publishedId":"TW6tMVep","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6470514/TW6tMVep","privateUrl":"https://go.postman.co/documentation/6470514-c357f411-8af7-4856-98dd-5f062a6a884c","customColor":{"top-bar":"FFFFFF","right-sidebar":"666666","highlight":"448893"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-01-24T23:15:03.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/TW6tMVep"}