Skip to content

feat(aca-sandboxes): use metadata URL for Swagger and operation discovery#128

Merged
prjhawar merged 1 commit into
mainfrom
fix/aca-sandbox-metadata-swagger
Jun 8, 2026
Merged

feat(aca-sandboxes): use metadata URL for Swagger and operation discovery#128
prjhawar merged 1 commit into
mainfrom
fix/aca-sandbox-metadata-swagger

Conversation

@prjhawar

@prjhawar prjhawar commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Closes #129

Replaces the legacy ARM managedApis apiOperations/export endpoints with the connection's runtime metadata URL (apim -> metadata + ?export=true) for all Swagger and operation discovery in the aca-sandboxes skill.

Auth model

This skill targets the design experience from outside the sandbox, so swagger discovery uses:

  • User-ACL on the connection (idempotent — GET first, PUT only if missing)
  • API Hub token (az rest --resource "https://apihub.azure.com")

Highlights

  • All apiOperations and ARM managedApis?export=true URLs replaced with the metadata URL pattern
  • New references/swagger-discovery.md as the single source of truth for fetch + auth + parsing + operation matching
  • Added idempotent user-ACL creation pattern (GET first, PUT only if missing) — scoped to user-ACL only
  • Added 'Narrate progress' rule so the agent announces each step with URL/objectId in chat (not just inside collapsed shell blocks)
  • Trimmed SKILL.md descriptions to stay under the 1024-char dev-time loader limit (--plugin-dir enforces this; marketplace install does not — but the trim keeps local dev unblocked)

Scoped to aca-sandboxes skill. connectors skill is unchanged except for the same description trim (also needed for --plugin-dir loading).

Copilot AI left a comment

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.

Pull request overview

This PR updates the aca-sandboxes skill to use the connection’s runtime metadata URL (/apim//metadata/ + ?export=true) for Swagger retrieval and operation/trigger discovery, replacing legacy ARM managedApis/* discovery endpoints. It also refreshes the skill documentation to describe both inside-sandbox (egress proxy) and outside-sandbox (user-ACL + API Hub token) auth paths and fixes the Swagger parsing expectations (top-level paths).

Changes:

  • Replaced legacy managedApis/.../apiOperations and managedApis?...&export=true patterns with metadata URL–based Swagger fetch for operation and trigger discovery.
  • Updated docs to include outside-sandbox exploration/testing guidance (user-ACL + az rest --resource https://apihub.azure.com) and an idempotent ACL creation pattern.
  • Updated the trigger getting-started script to discover trigger operations by filtering Swagger paths for x-ms-trigger.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
plugin/skills/connectors/SKILL.md Trims/reformats the connectors skill description/trigger keywords.
plugin/skills/aca-sandboxes/SKILL.md Updates core skill guidance to use metadata URL for Swagger/operation discovery; adds narration + ACL idempotency guidance; updates step flow text.
plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py Switches trigger operation discovery to metadata Swagger + x-ms-trigger filtering; extends az_rest to support --resource.
plugin/skills/aca-sandboxes/references/trigger-setup.md Replaces legacy trigger operation discovery with metadata Swagger filtering; adds outside-sandbox user-ACL + API Hub token flow.
plugin/skills/aca-sandboxes/references/trigger-flow.md Updates optional trigger discovery and troubleshooting notes to reference metadata Swagger instead of legacy endpoints.
plugin/skills/aca-sandboxes/references/runtime-url-examples.md Documents inside/outside sandbox auth contexts and updates operation discovery guidance to metadata Swagger.
plugin/skills/aca-sandboxes/references/quickstart.md Updates “discover operations” quickstart guidance to use metadata Swagger (inside/outside patterns).
plugin/skills/aca-sandboxes/references/handler-guide.md Adds an explicit “fetch Swagger first” step using metadata URL from inside sandbox.
plugin/skills/aca-sandboxes/references/gateway-connections.md Adds a note about operating from inside the sandbox once wired (but currently mischaracterizes dynamicInvoke).
plugin/skills/aca-sandboxes/references/dynamic-values.md Fixes Swagger parsing to use top-level paths and updates fetch instructions to metadata URL.
plugin/skills/aca-sandboxes/references/direct-api.md Reworks Swagger fetch and operation-finding guidance around metadata URL; adds outside-sandbox user-ACL + API Hub token flow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread plugin/skills/aca-sandboxes/references/gateway-connections.md Outdated
Comment thread plugin/skills/aca-sandboxes/SKILL.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/direct-api.md Outdated
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
Comment thread plugin/skills/aca-sandboxes/references/direct-api.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/direct-api.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/dynamic-values.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/runtime-url-examples.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/runtime-url-examples.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/trigger-flow.md Outdated
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
Comment thread plugin/skills/aca-sandboxes/SKILL.md
Comment thread plugin/skills/connectors/SKILL.md
Comment thread plugin/skills/connectors/SKILL.md Outdated
Copilot AI review requested due to automatic review settings June 3, 2026 21:32

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py Outdated
Comment thread plugin/skills/aca-sandboxes/SKILL.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/trigger-setup.md Outdated
Comment thread plugin/skills/aca-sandboxes/SKILL.md
Comment thread plugin/skills/aca-sandboxes/SKILL.md Outdated
Comment thread plugin/skills/connectors/SKILL.md Outdated
@apranaseth apranaseth self-requested a review June 3, 2026 23:38

@apranaseth apranaseth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you address comments

@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from a5ec412 to 2d18691 Compare June 4, 2026 01:45
Copilot AI review requested due to automatic review settings June 4, 2026 01:50
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from 2d18691 to ec7f68c Compare June 4, 2026 01:50

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/SKILL.md Outdated
Comment thread plugin/skills/aca-sandboxes/SKILL.md Outdated
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from ec7f68c to dd4e867 Compare June 4, 2026 02:06
Copilot AI review requested due to automatic review settings June 4, 2026 22:52
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from dd4e867 to 00229b4 Compare June 4, 2026 22:52

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py Outdated
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from 00229b4 to 97f25b5 Compare June 4, 2026 23:40
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
Copilot AI review requested due to automatic review settings June 5, 2026 00:28
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from 97f25b5 to 0916ea1 Compare June 5, 2026 00:28

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/references/swagger-discovery.md Outdated
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py
Comment thread plugin/skills/aca-sandboxes/scripts/trigger-getting-started.py Outdated
apranaseth
apranaseth previously approved these changes Jun 8, 2026
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from 0916ea1 to a8ffa77 Compare June 8, 2026 19:57
…very

Replaces the legacy ARM managedApis apiOperations/export endpoints with the
connection's runtime metadata URL (apim -> metadata + ?export=true) for all
Swagger and operation discovery in the aca-sandboxes skill.

This skill targets the design experience from outside the sandbox, so swagger
discovery uses:
- User-ACL on the connection (idempotent — GET first, PUT only if missing)
- API Hub token (az rest --resource https://apihub.azure.com)

Highlights:
- All apiOperations and ARM managedApis?export=true URLs replaced with the
  metadata URL pattern
- New references/swagger-discovery.md as the single source of truth for
  fetch + auth + parsing + operation matching (jq-based examples)
- Idempotent user-ACL creation (GET first, PUT only if missing) — scoped to
  user-ACL only
- Narrate progress rule so the agent announces each step with URL/objectId
  in chat (not just inside collapsed shell blocks)
- Trimmed SKILL.md descriptions to stay under the 1024-char dev-time loader
  limit (--plugin-dir enforces this; marketplace install does not — but the
  trim keeps local dev unblocked)

Scoped to aca-sandboxes skill. connectors skill is unchanged except for the
same description trim.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@prjhawar prjhawar force-pushed the fix/aca-sandbox-metadata-swagger branch from a8ffa77 to 886248f Compare June 8, 2026 20:05
@prjhawar prjhawar merged commit 4050769 into main Jun 8, 2026
3 checks passed
@prjhawar prjhawar deleted the fix/aca-sandbox-metadata-swagger branch June 8, 2026 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

aca-sandboxes skill uses legacy ARM endpoints for connector Swagger and operation discovery

3 participants