Skip to content

Add Managed Apps app config JSON Schemas (v0.0) - #635

Open
Chamu Rajasekera (Chamu-Rajasekera) wants to merge 1 commit into
mainfrom
users/chrajase/managed-apps-config-schemas
Open

Add Managed Apps app config JSON Schemas (v0.0)#635
Chamu Rajasekera (Chamu-Rajasekera) wants to merge 1 commit into
mainfrom
users/chrajase/managed-apps-config-schemas

Conversation

@Chamu-Rajasekera

Copy link
Copy Markdown

Publishes the two app configuration JSON Schemas used by the Microsoft Apps CLI (ms) so that editors can resolve them from a stable, Microsoft-hosted URL.

New files

File Public URL
managed-apps/ms-config/v0.0/schema.json https://developer.microsoft.com/json-schemas/managed-apps/ms-config/v0.0/schema.json
managed-apps/stage-overlay/v0.0/schema.json https://developer.microsoft.com/json-schemas/managed-apps/stage-overlay/v0.0/schema.json
  • ms-config describes ms.config.json, the base configuration file for a Microsoft App project (app identity, connection references, data sources, packaged schemas).
  • stage-overlay describes ms.<deployment>.config.json, a per-deployment overlay that overrides a subset of the base configuration when an app is promoted between environments.

Both are JSON Schema draft-07. The version folder (v0.0) matches the version field the schemas themselves pin, so future contract revisions land in a sibling folder and existing files keep resolving.

Provenance

These files are generated, not hand-written. The source of truth is a set of Zod contracts in @microsoft/managed-apps-common, rendered by a script in that package. A snapshot test in the owning repo fails if the generated output drifts from the reviewed contract, so the schemas here always match what the CLI actually enforces at runtime.

Updates will follow the same path: regenerate from the contract, then open a PR here.

Why

The CLI currently emits a $schema pointer at a raw GitHub URL. That is not in the default json.schemas allowlist that VS Code trusts for automatic download, so users get no validation or completion in the editor without changing their settings. developer.microsoft.com/json-schemas is allowlisted, which is what this PR is for.

Follow-up required before these URLs work

managed-apps is a new root-level folder. Per the repository README, a new root folder must be allowlisted by the developer app portal engineering team (devappportaleng@microsoft.com) so the locale segment is dropped from the public URL. Until that request is processed, the files will resolve at https://developer.microsoft.com/json-schemas/en-us/managed-apps/... rather than the locale-free URLs listed above. I will send that request.

Validation

  • Both files parse as valid JSON.
  • Both were produced by the generator script from the current contract, and verified against the reviewed schema snapshot test in the owning repository.

Publish the ms.config.json and stage-overlay schemas for the Microsoft Apps CLI so editors can resolve them from an allowlisted developer.microsoft.com URL.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 45ea3c0d-f36b-42f3-9c07-fcb1f6657175
@Chamu-Rajasekera
Chamu Rajasekera (Chamu-Rajasekera) marked this pull request as ready for review August 29, 2026 01:24
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.

2 participants