pan.dev icon indicating copy to clipboard operation
pan.dev copied to clipboard

Allow Users to Customize IOT API Server URL

Open sserrata opened this issue 3 years ago • 3 comments

Documentation link

Location: https://pan.dev/iot/api/alert-list/

Describe the problem

Server URL doesn't resolve since it includes a variable/placeholder: https://{customer-name}.iot.paloaltonetworks.com

Suggested fix

Provide a way for users to enter the value for {customer-name}. One solution would be to use the OpenAPI plugins ability to define variables for parts of the server URL:

servers:
  - url: https://{customer_name}.iot.paloaltonetworks.com
    variables:
      customer_name:
        default: "{customer_name}"

Please note that - is not allowed in variable names, which is why an _ is used in the example above.

Example usage:

https://user-images.githubusercontent.com/9343811/210891508-37a10648-a225-49c3-8171-7fe805ff6ee0.mov

sserrata avatar Jan 05 '23 22:01 sserrata

FYI @shuailiu-zingbox @Zhepu-zingbox

sserrata avatar Jan 10 '23 13:01 sserrata

@csestito Do you know who else might be able to help?

sserrata avatar Jan 17 '23 18:01 sserrata

@sserrata : I've reached out to the writer who covers IoT for TechDocs. He doesn't have any pan.dev accessibility, but hopefully he can come up with the name of the IoT engineer who can help with this.

sarette avatar Jan 18 '23 00:01 sarette