N1 Console. Explain how to download a collection, and use variables in Postman

[mjang]

Overview

As an API user, I want to download our N1 Console API. I also need to know how to set up variables in Postman

Description

Options:

• If the description is relatively short, add the doc to the top of https://docs.nginx.com/nginx-one/api/api-reference-guide/
  • With recent changes to our doc theme, this is now possible
• For a longer description, we should set up a separate page in https://docs.nginx.com/nginx-one/api/

I visualize the following sections:

• Prerequisites

  • NGINX tenant name
    • Explanation of how to use the tenant name
    • We might be able to use this section
  • Postman account (or equivalent)

• Instructions:

  • Navigate to the NGINX One API Reference
  • Select the Download button
  • You'll see a one.json file in your download directory
  • Open Postman (or equivalent)
  • Select File > Import
  • Import the one.json file
  • Set up the following variables as described in the Postman documentation
    • API key
    • Tenant
    • Anything else

Acceptance criteria

Make sure reviewers actually run the steps and are able to verify them on their own systems