Skip to content

SLD-789: Add PowerShell Proxy OpenAPI spec #199

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

Open
Khalil O. (Kh4lil) wants to merge 5 commits into
base: main
Choose a base branch
from
Open

SLD-789: Add PowerShell Proxy OpenAPI spec #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3f6b3f
feat: add PowerShell Proxy OpenAPI SDK
Kh4lil Aug 19, 2026
17b595b
fix: declare Kiota HTTP dependency
Kh4lil Aug 19, 2026
7cc1d30
Update PowerShell Proxy OpenAPI contract
Kh4lil Sep 15, 2026
1b159f0
Fix Socket PR reachability scan
Kh4lil Sep 15, 2026
8554b19
Fix reachability workflow PR comment permissions
Copilot Sep 15, 2026
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
3 changes: 3 additions & 0 deletions .github/workflows/Build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ jobs:
- name: UrlShortener
sdkPath: 'src/urlShortener/TypeScript'
specPath: 'spec/Url-Shortener.json'
- name: PowerShellProxy
sdkPath: 'src/powershellProxy/TypeScript'
specPath: 'specs/PowerShell-Proxy.json'
Comment on lines +35 to +37

# Display name of the job
name: Generate NPM Packages
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/Publish-NPM.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ jobs:
- name: UrlShortener
sdkPath: 'src/urlShortener/TypeScript'
specPath: 'spec/Url-Shortener.json'
- name: PowerShellProxy
sdkPath: 'src/powershellProxy/TypeScript'
specPath: 'specs/PowerShell-Proxy.json'
Comment on lines +42 to +44

# Display name of the job
name: Publish - NPM Global Packages
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Publish-Specs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
run: |
DIST_FILE="swagger-ui/dist/swagger-initializer.js"
# Remove the 'url:' property and insert the 'urls:' array
sed -i '/url: /c\ urls: [\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/Data-Gateway.json",\n"name": "Data Gateway"\n},\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/SHIELD.json",\n"name": "SHIELD"\n},\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/Url-Shortener.json",\n"name": "SHI - URL Shortener"\n}\n],' "$DIST_FILE"
sed -i '/url: /c\ urls: [\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/Data-Gateway.json",\n"name": "Data Gateway"\n},\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/SHIELD.json",\n"name": "SHIELD"\n},\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/Url-Shortener.json",\n"name": "SHI - URL Shortener"\n},\n{\n"url": "https://raw.githubusercontent.com/Software-Hardware-Integration-Lab/OpenAPI/refs/heads/main/specs/PowerShell-Proxy.json",\n"name": "SHIELD PowerShell Proxy"\n}\n],' "$DIST_FILE"

# Uploads the built artifact to github pages
- name: Upload Artifact
Expand Down
13 changes: 10 additions & 3 deletions .github/workflows/Security-Reachability.yaml
View file
Open in desktop

@pasha-zayko Pasha Zayko (pasha-zayko) Sep 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not certain about the changes here as we have reachability working fine elsewhere without these. I would avoid the modification at the moment unless we have some supported documentation to reference.

Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ jobs:

# Sets the scopes available to the github_token injected to the GH Actions runner
permissions:
issues: read
issues: write
contents: read
pull-requests: read
pull-requests: write

# Set of commands to run to compute the reachability of CVEs in the codebase
steps:
Expand Down Expand Up @@ -68,4 +68,11 @@ jobs:
env:
SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_REACHABILITY }}
GH_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: socketcli --target-path $GITHUB_WORKSPACE --scm github --reach
run: |
# socketcli only auto-detects the PR number on some CI providers; on GitHub Actions
# it must be passed explicitly or PR-comment requests are sent with a null PR number.
if [ "${{ github.event_name }}" = "pull_request" ]; then
socketcli --target-path $GITHUB_WORKSPACE --scm github --reach --pr-number ${{ github.event.pull_request.number }}
else
socketcli --target-path $GITHUB_WORKSPACE --scm github --reach
fi
8 changes: 7 additions & 1 deletion apis.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,10 @@ apis:
baseUrl: https://api.shilab.com
properties:
- type: x-openapi
url: specs/Data-Gateway.json
url: specs/Data-Gateway.json
- name: SHIELD PowerShell Proxy
description: Authenticated proxy that executes a fixed, server-side allowlisted Security & Compliance (Purview) PowerShell command and returns its structured JSON result.
image: https://www.content.shi.com/SHIcom/images/Global/HeaderFooter/SHI_LOGO_2022_Positive.svg
properties:
- type: x-openapi
url: specs/PowerShell-Proxy.json
Loading