Create SmartDocs pages on your portal for the Edge Management API

Google Cloud Apigee Knowledge Hub
1

This article contains a SmartDocs JSON file, sdapigee.rev1.json, that you can use to create a SmartDocs model on your portal for the Edge management API.

By default, the Edge management APIs in sdapigee.rev1.json use a baseUrl of https://api.enterprise.apigee.com/v1, which means all requests go to the Cloud version of Edge. If you want to make requests to a different URL, edit the bastURL property of the sdapigee.rev1.json file, line 4, to set it.

The Edge management APIs all require basic auth. When you create the model, you add a security scheme to the model to support basic auth.

To create a model on your portal to use the Edge management APIs:

  1. Download the attached file, sdapigee.rev1.json.zip, and unzip it to create the file sdapigee.rev1.json.
  2. Select Content > SmartDocs in the portal.
  3. Select New Model and enter the name of the model. For example, sdapigee.
  4. Select Create Model. The model details page opens.
  5. On the model details page, select Import under Operations.
  6. On the import page:
    1. Select SmartDocs - JSON as the Format.
    2. Set Upload Type as File.
    3. Select the Choose File button and select the sdapigee.rev1.json file.
    4. Select Import to create Revision 1 of the model. You should see all Edge management APIs in the model as unpublished.
  7. In the dropdown at the top of the page, select Security Settings.
  8. On the Security Settings page, select Add Security Scheme.
  9. On the Add Security Scheme page:
    1. Set the Name to basic-auth.
    2. Set the Type to Basic.
    3. Select Submit to create the security scheme.
  10. At the top of the page, select Revision #1 in the breadcrumbs above the page title to return to the list of APIs.
  11. Select an API and publish it. For example:
    1. Select the Get Organization API.
    2. Make sure the dropdown at the top of the page says Render and publish nodes.
    3. Select the Update button to publish the API page.
    4. Scroll down to the Get Organization API. You now see a Node ID (NID) for the API under the Node Association column.
  12. Select the Node ID to open the API page in the portal. You can now make API requests from that page.
2

This is brilliant, @sgilson. Thanks for posting this!

Also wanted to note that this is the current snapshot of our publicly available SmartDocs at http://docs.apigee.com/management/apis. While the resource URIs stay the same between this snapshot and the public docs (99.9% of the time), we often modify and improve the documentation itself. So our public doc content will continue to evolve from the snapshot that Stephen has provided here.

We have no plans to provide regular updates to the attached file. However, if you’re interested in a copy of the latest snapshot, please send a note to docs@apigee.com.