Issue/Help with "Push the candidate configuration"
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Open the linked Push the candidate configuration documentation page and inspect the devices parameter schema and examples. Change the parameter from number[] to string[] and update the examples; done when the page reflects the accepted string values and preserves leading zeroes.
Written by the indexing model from the issue text.
Description
Documentation link
https://pan.dev/scm/api/config/cloudngfw/operations/push-candidate-config-versions/
Describe the problem
Devices parameter is actually not a list of numbers, but a list of strings.
I had to do some tests because all my Palo Alto devices start with 00, thus giving some errors when typecasting/truncating from str to int.
One test that passed was actually sending a string of numbers, which I also believe is the correct decision, to avoid the problem i had.
Test: int
Input:
{ "devices": [1234567890], "description": "test" }Response:
{ "_errors": [ { "code": "API_I00035", "message": "...", "details": ["\"devices[0]\" must be a string", "\"devices\" >does not contain 1 required value(s)"] } ] }
Test: str
Input:
{ "devices": ["001234567890"], "description": "test" }Response:
{ "success": true, "job_id": "41", "message": "CommitAndPush job enqueued with jobid 41" }
Suggested fix
Just change the documentation from number[] to string[] and update the examples.
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
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.
More from PaloAltoNetworks/pan.dev
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PaloAltoNetworks/pan.dev#1327 · 4 comments ·
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 90/100
PaloAltoNetworks/pan.dev#1317 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PaloAltoNetworks/pan.dev#1304 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
PaloAltoNetworks/pan.dev#1268 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PaloAltoNetworks/pan.dev#1258 · 1 comment ·
All issues in PaloAltoNetworks/pan.dev
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100