Skip to content

Expose package SdkType in Apiview URI #12323

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

Closed
helen229 wants to merge 6 commits into from
Closed

Expose package SdkType in Apiview URI #12323

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fee6763
expose package Type in Apiview URI
helen229 Oct 2, 2025
047ec4b
Merge branch 'main' into gaoh/script
helen229 Oct 17, 2025
a6ac9f3
Merge branch 'main' of https://github.com/Azure/azure-sdk-tools into …
helen229 Oct 17, 2025
ab33c99
Merge branch 'gaoh/script' of https://github.com/Azure/azure-sdk-tool…
helen229 Oct 17, 2025
396cead
fix formatting
helen229 Oct 17, 2025
19d6b23
Remove packageType parameter from Submit-Request function
helen229 Oct 20, 2025
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
18 changes: 13 additions & 5 deletions eng/common/scripts/Create-APIReview.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Set-StrictMode -Version 3
. (Join-Path $PSScriptRoot Helpers ApiView-Helpers.ps1)

# Submit API review request and return status whether current revision is approved or pending or failed to create review
function Upload-SourceArtifact($filePath, $apiLabel, $releaseStatus, $packageVersion)
function Upload-SourceArtifact($filePath, $apiLabel, $releaseStatus, $packageVersion, $packageType)
{
Write-Host "File path: $filePath"
$fileName = Split-Path -Leaf $filePath
Expand Down Expand Up @@ -61,6 +61,13 @@ function Upload-SourceArtifact($filePath, $apiLabel, $releaseStatus, $packageVer
$multipartContent.Add($releaseTagParamContent)
Write-Host "Request param, setReleaseTag: $MarkPackageAsShipped"

$packageTypeParam = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$packageTypeParam.Name = "packageType"
$packageTypeParamContent = [System.Net.Http.StringContent]::new($packageType)
$packageTypeParamContent.Headers.ContentDisposition = $packageTypeParam
$multipartContent.Add($packageTypeParamContent)
Write-Host "Request param, packageType: $packageType"

if ($releaseStatus -and ($releaseStatus -ne "Unreleased"))
{
$compareAllParam = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
Expand Down Expand Up @@ -92,14 +99,14 @@ function Upload-SourceArtifact($filePath, $apiLabel, $releaseStatus, $packageVer
return $StatusCode
}

function Upload-ReviewTokenFile($packageName, $apiLabel, $releaseStatus, $reviewFileName, $packageVersion, $filePath)
function Upload-ReviewTokenFile($packageName, $apiLabel, $releaseStatus, $reviewFileName, $packageVersion, $filePath, $packageType)
{
Write-Host "Original File path: $filePath"
$fileName = Split-Path -Leaf $filePath
Write-Host "OriginalFile name: $fileName"

$params = "buildId=${BuildId}&artifactName=${ArtifactName}&originalFilePath=${fileName}&reviewFilePath=${reviewFileName}"
$params += "&label=${apiLabel}&repoName=${RepoName}&packageName=${packageName}&project=internal&packageVersion=${packageVersion}"
$params +="&label=${apiLabel}&repoName=${RepoName}&packageName=${packageName}&project=internal&packageVersion=${packageVersion}&packageType=${packageType}"
if($MarkPackageAsShipped) {
$params += "&setReleaseTag=true"
}
Expand Down Expand Up @@ -146,17 +153,18 @@ function Get-APITokenFileName($packageName)
function Submit-APIReview($packageInfo, $packagePath)
{
$apiLabel = "Source Branch:${SourceBranch}"
$packageType = $packageInfo.SdkType

# Get generated review token file if present
# APIView processes request using different API if token file is already generated
$reviewTokenFileName = Get-APITokenFileName $packageInfo.ArtifactName
if ($reviewTokenFileName) {
Write-Host "Uploading review token file $reviewTokenFileName to APIView."
return Upload-ReviewTokenFile $packageInfo.ArtifactName $apiLabel $packageInfo.ReleaseStatus $reviewTokenFileName $packageInfo.Version $packagePath
return Upload-ReviewTokenFile $packageInfo.ArtifactName $apiLabel $packageInfo.ReleaseStatus $reviewTokenFileName $packageInfo.Version $packagePath $packageType
}
else {
Write-Host "Uploading $packagePath to APIView."
return Upload-SourceArtifact $packagePath $apiLabel $packageInfo.ReleaseStatus $packageInfo.Version
return Upload-SourceArtifact $packagePath $apiLabel $packageInfo.ReleaseStatus $packageInfo.Version $packageType
}
}

Expand Down
Loading