Project

General

Profile

Bug #34729

repositories/import_uploads API endpoint do require two mandatory parameters

Added by Chris Roberts 3 months ago. Updated 3 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Repositories
Target version:
Difficulty:
trivial
Triaged:
Yes
Bugzilla link:
Fixed in Releases:
Found in Releases:
Red Hat JIRA:

Description

Description of problem:
Sat 6.10 APIdoc at https://your-sat610/apidoc/v2/repositories/import_uploads.html

say that

uploads[checksum]
uploads[name]

are optional. BUT both are mandatory.

Please either update the APIdoc or fix the product per APIdoc (fixing the product is imho better - why the API insists on filename or its checksum, if we uniquely identified it via upload_url? Well, checksum can be required for the sake of ensuring integrity/validity of uploaded content, but filename..?)

Version-Release number of selected component (if applicable):
Sat 6.10.3

How reproducible:
100%

Steps to Reproduce:
1. Use below script with customized Sat credentials to upload a package to a repository. It is a fixed procedure per https://access.redhat.com/documentation/en-us/red_hat_satellite/6.10/html-single/api_guide/index#sect-API_Guide-Uploading_Content_to_the_Satellite_Server (fixed: see relevant BZ)

Usage:

./upload_package_to_repo.sh REPOID /path/to/package.rpm

-----8<-----
if [ $# -lt 2 ]; then
echo "too few arguments"
exit
fi

repoid=${1}
package=${2}
pkgname=${package##*/}
creds=admin:redhat
saturl=$(hostname -f)
size=$(wc -c $package | awk '{ print $1}')
checksum=$(sha256sum $package | awk '{ print $1}')

upload_url=$(curl --header "Accept:application/json" \
--header "Content-Type:application/json" \
--request POST --insecure --user $creds \
--data "{\"size\": ${size}}" \
https://${saturl}/katello/api/repositories/${repoid}/content_uploads | cut -d\" -f4 )

curl --header "Accept:application/json" \
--header "Content-Type:multipart/form-data" \
--request PUT --insecure --user $creds \
--data-urlencode "content@${package}" \
--data-urlencode offset=0 \
--data-urlencode size=${size} \
https://${saturl}/katello/api/repositories/${repoid}/content_uploads/${upload_url}

curl --header "Accept:application/json" \
--header "Content-Type:application/json" \
--request PUT --insecure \
--user $creds \
--data "{\"uploads\":[{\"id\": \"${upload_url}\", \"checksum\": \"${checksum}\", \"name\": \"${pkgname}\"}]}" \
https://${saturl}/katello/api/repositories/${repoid}/import_uploads
-----8<-----

2. Use the script to upload a package
3. From the latest curl method, remove either

\"checksum\": \"${checksum}\"
or
\"name\": \"${pkgname}\"

attributes and retry.

Actual results:
2. Package upload succeeds.
3. Removing checksum, Sat raises

Katello::HttpErrors::BadRequest: no implicit conversion of nil into String

and removing name, Sat raises

ArgumentError: Missing the required parameter 'relative_path' when calling ContentPackagesApi.create

error and upload fails.

Expected results:
Align APIdoc mandatory parameters with reality.

Associated revisions

Revision 2d288ff1 (diff)
Added by Chris Roberts 3 months ago

Fixes #34729 - Update name/checksum to required on repo upload

History

#1 Updated by The Foreman Bot 3 months ago

  • Status changed from Assigned to Ready For Testing
  • Pull request https://github.com/Katello/katello/pull/10049 added

#2 Updated by Partha Aji 3 months ago

  • Triaged changed from No to Yes

#3 Updated by The Foreman Bot 3 months ago

  • Fixed in Releases Katello 4.5.0 added

#4 Updated by Chris Roberts 3 months ago

  • Status changed from Ready For Testing to Closed

Also available in: Atom PDF