PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "Push the candidate configuration"

Open
#279 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

https://pan.dev/access/api/prisma-access-config/post-sse-config-v-1-config-versions-candidate-push/

Describe the problem

  1. Return status code of 201 is incorrect
  2. Example response body is empty
  3. Code examples are for GET methods

Suggested fix

  1. Update status code to 200
  2. include an example response (listed below)
  3. Update to showcase a POST method (listed below)
Examples

Example response from the API:

{
    "success": true,
    "job_id": "32",
    "message": "CommitAndPush job enqueued with jobid 32"
}

Example POST method to the API:

curl --location 'https://api.sase.paloaltonetworks.com/sse/config/v1/config-versions/candidate:push' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer mysecrettoken' \
--data '{
  "folders": [
    "Remote Networks"
  ],
  "description": "Postman test"
}'

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Push the candidate configuration documentation page and compare its status code, response example, and code samples with the issue’s examples. Done means the page reports 200, includes the JSON response, and demonstrates the POST curl request rather than GET.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.