Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

patch: Add Delta size API docs #2468

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

patch: Add Delta size API docs #2468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4587697
patch: Add Delta size API docs
vipulgupta2048 Dec 28, 2022
0e5e58f
Update Doxx to resolve errors
vipulgupta2048 Dec 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions config/dictionaries/resource.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,30 @@
}
]
},
{
"id": "delta",
"name": "Release/Image Deltas",
"fields": [
],
"examples": [
{
"id": "get-deltas-with-image-id",
"summary": "Query Size of Release Delta with Image ID",
"description": "A delta is unique between any combination of (delta version, source image ID, destination image ID), so you'll need to determine the appropriate values before testing. Important to know, for the current deltas version (v3), the size given by the API is the uncompressed delta size, but during a pull the data will be compressed. The number given by the API can be substantially larger than the amount of data that will be actually transmitted.",
"method": "GET",
"endpoint": "/delta",
"filters": "?\\$filter=((status%20eq%20'success')%20and%20(version%20eq%20'${DELTA_VERSION}')%20and%20(originates_from__image%20eq%20'${SRC_RELEASE_ID}')%20and%20(produces__image%20eq%20'${DST_RELEASE_ID}'))"
},
{
"id": "get-deltas-with-image-name",
"summary": "Query Size of Release Delta with Image Name",
"description": "A delta is unique between any combination of (delta version, source image ID, destination image ID), so you'll need to determine the appropriate values before testing. Here, SRC_RELEASE_NAME & DST_RELEASE_NAME would be the image name complete with the registry without a tag or SHA reference. Important to know, for the current deltas version (v3), the size given by the API is the uncompressed delta size, but during a pull the data will be compressed. The number given by the API can be substantially larger than the amount of data that will be actually transmitted.",
"method": "GET",
"endpoint": "/delta",
"filters": "?\\$filter=((status%20eq%20'success')%20and%20(version%20eq%20'${DELTA_VERSION}')%20and%20(originates_from__image/any(source:source/is_stored_at__image_location%20eq%20''${SRC_RELEASE_NAME}''))%2520and%2520(produces__image/any(destination:destination/is_stored_at__image_location%2520eq%2520%2527'${DST_RELEASE_NAME}'%2527)))"
}
]
},
{
"id": "device_config_variable",
"name": "Device config variable",
Expand Down
Loading