api: adds CRUD operations for scans and scanLabels

[ashwiniag]

Introduces

• CRUD operations for Scans api: crud operation for Scans #59
• CRUD operations for ScanLabels api: crud operation for ScanLabels #60
• OpenAPI spec docs

As follows

ScanLabels

Action	Method	Endpoint	Description
Create	POST	/scans/{scan_id}/labels	Add a new label to a scan.
Read (List)	GET	/scans/{scan_id}/labels	List all labels for a specific scan
Read (Detail)	GET	/scans/{scan_id}/labels?key={key}&key=(key2}	Get a specific label by key.
Read (Detail)	GET	/scans/{scan_id}/labels/{key}	Get a specific label by key.
Update	PUT	/scans/{scan_id}/labels/{key}	Update a specific label by key.
Delete	DELETE	/scans/{scan_id}/labels/{key}	Delete a specific label by key.

cURL

curl -X POST \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
-d '{
  "key": "env",
  "value": "prod"
}' \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels

curl -X GET \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels

curl -X GET \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels/team

curl -X GET \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels\?key\=team\&key\=lts_version | jq '.'

curl -X PUT \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
-d '{
  "key": "env",
  "value": "updated_value"
}' \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels

curl -X PUT \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
-d '{
  "labels": [
    {"key": "lts_version", "value": "v1.0"},
    {"key": "team", "value": "gokakashi"}
  ]
}' \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels

curl -X DELETE \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/df37e432-44cf-46cb-b89d-5b503d59b84f/labels/lts_version

Scans

Action	Method	Endpoint	Description
Create	POST	/scans	Create a new scan.
Read (List)	GET	/scans	List all scans.
Read (Detail)	GET	/scans/{id}	Get details of a specific scan.
Update	PUT	/scans/{id}	Update a scan by ID.

cURL

curl -X POST \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
-d '{
  "policy_id": "5cd8cad8-2547-402a-9f22-1f0109d49be8",
  "image": "acme/image:v1.0",
  "check": {
    "condition": "sev.critical > 0",
    "notify": ["linear", "jira"]
  },
  "status": "scan_pending",
  "report": "http://reports.server.com/scan/123"
}' \
http://localhost:8000/api/v1/scans

curl -X GET \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans


curl -X GET \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/72f2f8b5-72c8-4df4-9980-40895efaa846

curl -X PUT \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
-d '{
  "status": "scan_in_progress"
}' \
http://localhost:8000/api/v1/scans/72f2f8b5-72c8-4df4-9980-40895efaa846

curl -X DELETE \
-H "Authorization: Bearer letsdoit" \
-H "Content-Type: application/json" \
http://localhost:8000/api/v1/scans/72f2f8b5-72c8-4df4-9980-40895efaa846