PaloAltoNetworks / PaloAltoNetworks/pan.dev
Allow Users to Customize IOT API Server URL
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the API documentation page for the alert list endpoint and locate the OpenAPI server definition that contains the customer-name placeholder. Check how the documentation’s OpenAPI plugin handles server variables, then verify that users can enter their customer name and that the generated server URL resolves correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100