From 2365a2341aa41c20fa41f16f4d87af1201d26993 Mon Sep 17 00:00:00 2001 From: Alex Thornton Date: Mon, 17 Jul 2017 13:00:17 -0700 Subject: [PATCH 1/4] add run in postman button --- source/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.md b/source/index.md index bf93f96..d7bdd87 100644 --- a/source/index.md +++ b/source/index.md @@ -7,6 +7,7 @@ language_tabs: toc_footers: - Documentation Powered by Slate + - includes: - overview/overview From c661011896ddec6a6c0767fa495e7d956792188f Mon Sep 17 00:00:00 2001 From: Alex Thornton Date: Mon, 17 Jul 2017 14:19:58 -0700 Subject: [PATCH 2/4] add postman section --- source/includes/overview/_postman.md | 5 +++++ source/index.md | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 source/includes/overview/_postman.md diff --git a/source/includes/overview/_postman.md b/source/includes/overview/_postman.md new file mode 100644 index 0000000..9660073 --- /dev/null +++ b/source/includes/overview/_postman.md @@ -0,0 +1,5 @@ +## Postman + +[Postman](https://www.getpostman.com/) is a tool for interacting with APIs. Click the button below to interact with the Locus Energy API using Postman. For everything to work properly, be sure to update the [Postman Environment](https://www.getpostman.com/docs/postman/environments_and_globals/manage_environments) with your own API credentials. + +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/74df59158f79ade720d0#?env%5BLocus%20Energy%20External%20API.template%5D=W3sia2V5IjoiY2xpZW50X2lkIiwidmFsdWUiOiIiLCJkZXNjcmlwdGlvbiI6IiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjbGllbnRfc2VjcmV0IiwidmFsdWUiOiIiLCJkZXNjcmlwdGlvbiI6IiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJ1c2VybmFtZSIsInZhbHVlIjoiIiwiZGVzY3JpcHRpb24iOiIiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicGFzc3dvcmQiLCJ2YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InJlZnJlc2hfdG9rZW4iLCJ2YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiIiwiZGVzY3JpcHRpb24iOiIiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9XQ==) \ No newline at end of file diff --git a/source/index.md b/source/index.md index d7bdd87..58b9cac 100644 --- a/source/index.md +++ b/source/index.md @@ -6,13 +6,14 @@ language_tabs: - shell toc_footers: - - Documentation Powered by Slate - + - Documentation Powered by Slate includes: - overview/overview - overview/introduction - overview/getting-started + - overview/postman - overview/errors - overview/rate-limiting - overview/versioning From ee8eea33431fd2108705460cd24c26593f0b23b4 Mon Sep 17 00:00:00 2001 From: Alex Thornton Date: Mon, 17 Jul 2017 17:53:38 -0700 Subject: [PATCH 3/4] update wording --- source/includes/overview/_postman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/overview/_postman.md b/source/includes/overview/_postman.md index 9660073..297d72d 100644 --- a/source/includes/overview/_postman.md +++ b/source/includes/overview/_postman.md @@ -1,5 +1,5 @@ ## Postman -[Postman](https://www.getpostman.com/) is a tool for interacting with APIs. Click the button below to interact with the Locus Energy API using Postman. For everything to work properly, be sure to update the [Postman Environment](https://www.getpostman.com/docs/postman/environments_and_globals/manage_environments) with your own API credentials. +[Postman](https://www.getpostman.com/) is a tool for interacting with APIs. Click the button below to interact with the Locus Energy API using Postman. For everything to work properly, be sure to update the `Locus Energy External API.template` [Postman Environment](https://www.getpostman.com/docs/postman/environments_and_globals/manage_environments) with your own API credentials. [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/74df59158f79ade720d0#?env%5BLocus%20Energy%20External%20API.template%5D=W3sia2V5IjoiY2xpZW50X2lkIiwidmFsdWUiOiIiLCJkZXNjcmlwdGlvbiI6IiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjbGllbnRfc2VjcmV0IiwidmFsdWUiOiIiLCJkZXNjcmlwdGlvbiI6IiIsInR5cGUiOiJ0ZXh0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJ1c2VybmFtZSIsInZhbHVlIjoiIiwiZGVzY3JpcHRpb24iOiIiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicGFzc3dvcmQiLCJ2YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InJlZnJlc2hfdG9rZW4iLCJ2YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwidHlwZSI6InRleHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiIiwiZGVzY3JpcHRpb24iOiIiLCJ0eXBlIjoidGV4dCIsImVuYWJsZWQiOnRydWV9XQ==) \ No newline at end of file From 2c8f72e17025e8567b43ea390c21d10471eb6ed5 Mon Sep 17 00:00:00 2001 From: Alex Thornton Date: Thu, 20 Jul 2017 13:12:56 -0700 Subject: [PATCH 4/4] updated changelog --- source/includes/overview/_changelog.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/includes/overview/_changelog.md b/source/includes/overview/_changelog.md index 0c90084..4cc2607 100644 --- a/source/includes/overview/_changelog.md +++ b/source/includes/overview/_changelog.md @@ -1,5 +1,9 @@ ## Changelog +### 2017-07-20 + +- Added documentation to [use Postman](#postman) + ### 2017-05-15 - Added the `latest` granularity to Component level Data Available and Data calls