Skip to content

Commit 98141f2

Browse files
authored
Merge pull request #587 from microsoft/update-readme
Update readme
2 parents bed8902 + d050395 commit 98141f2

1 file changed

Lines changed: 69 additions & 2 deletions

File tree

README.md

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,72 @@
11
# Microsoft JSON schema publishing repository
22

3-
This repository contains schemas which are published at https://developer.microsoft.com/json-schemas/. Maintenance and publishing is performed by Microsoft employees from different organizations.
3+
This repository contains schemas which are published at https://developer.microsoft.com/json-schemas/. Maintenance and publishing is performed by Microsoft employees from different organizations.
44

5-
Notice. You cannot access the schemas directly from above URL, they are simply hosted there based on the folder structure in this repository. Tools are pointing automatically to the exact schema files as needed.
5+
> [!IMPORTANT]
6+
> You cannot access the schemas directly from https://developer.microsoft.com/json-schemas/. They are simply hosted there based on the folder structure in this repository. Tools are pointing automatically to the exact schema files as needed.
7+
8+
Last updated: 27 May 2026
9+
10+
## Publish Microsoft JSON schemas to the centralized json-schemas repo
11+
12+
Microsoft launched a centralized GitHub repo for publishing Microsoft-owned JSON schemas. Previously, JSON schema files were published to a public site (http://json-schema.org) for universally hosting json-schema files and to other Microsoft sites such as dev.office.com. However, there's an inherent risk in using the public site and much benefit to customers to provide a single, supported location for all Microsoft JSON schemas.
13+
14+
- Repo: https://github.com/Microsoft/json-schemas
15+
- Admins: https://github.com/orgs/Microsoft/teams/json-schemas-admins
16+
- Public site: https://developer.microsoft.com/json-schemas
17+
- Owner: @VesaJuvonen (Eastern European Time (EET))
18+
- Publishing: Self-publish via an admin from your team/organization.
19+
- For publishing support or if you don't have an admin who can publish:
20+
- M365 Developer program engineering team: DevAppPortalEng@microsoft.com (Indian Standard Time (IST))
21+
- Office Developer documentation team: opcontent@microsoft.com or tag @OfficeDev/opcontent in GitHub (Pacific Daylight Time (PDT))
22+
- Check the json-schemas-admins repo for someone in your organization with Administrator permissions!
23+
24+
## Get Admin perms REQUIRED
25+
26+
All Microsoft teams are welcome to publish schemas to this repo. Pick two FTE team members and request Admin permission. Submit your request to @Microsoft/json-schemas-admins for approval and tag @VesaJuvonen. This may take some time, so please be sure to do this part in advance.
27+
28+
After you're approved as an Admin, you have the power to create your own folder, add your schemas, manage your pull requests, etc. We suggest you contact your documentation team or several reliable PMs/EMs on your team and request Admin perms for them as well. There is no central person to publish and assist you.
29+
30+
## Publish a new schema
31+
32+
1. Create one folder per team in the repo. Keep your folder structure as flat as reasonable. Each folder will become an element of the JSON URL (e.g. https://developer.microsoft.com/json-schemas/folder/schema_name.json) Use examples in the repo for guidance. Stay consistent.
33+
34+
2. Create a working branch in GitHub and add your new schema file. Then open a PR to merge to the **Main** branch. You'll need your other team member to approve, or you can ask any Admin. Changes should appear on the staging servers 2-15 minutes after merging to Main branch.
35+
36+
3. After review, open a pull request and merge to Live branch. After approval, the new schema goes live in about 2-15 minutes.
37+
38+
### Troubleshooting
39+
40+
If your new schema doesn't appear, or to be extra safe, you'll need to "manually" publish your new schema by copying it directly to the Azure storage repo. Find your team folder, drill down, and create a new version folder. Follow the example of previous schemas and be consistent. Once you create the new version folder, copy your new schema. As of May 2026, the links to the Azure blob storage location for each folder are:
41+
42+
- api-extractor https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/api-extractor/
43+
- copilot https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/copilot/
44+
- core-build https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/core-build/
45+
- dotnet https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/dotnet/
46+
- fabric https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/fabric/
47+
- heft https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/heft/
48+
- lockfile-explorer https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/lockfile-explorer/
49+
- office-js https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/office-js/
50+
- pnp https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/pnp/
51+
- rig-package https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/rig-package/
52+
- rush https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/rush/
53+
- sp https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/sp/
54+
- spfx-build https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/spfx-build/
55+
- spfx https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/spfx/
56+
- teams-toolkit https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/teams-toolkit/
57+
- teams https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/teams/
58+
- tsdoc https://graphprodblobstorage.blob.core.windows.net/content/json-schemas/en-us/html/tsdoc/
59+
60+
> [!IMPORTANT]
61+
> If you add a new root level folder then you need to send an email to devappportaleng@microsoft.com (developer app portal engineering team) and request they "allowlist" your folder for removing the locale from the full URL. You don't need to do this for sub-folders. As mentioned, this is the team that hosts the Azure blob so reach out to them for support if needed. You'll find they're very responsive if you catch them on India time!
62+
63+
## Update existing schemas
64+
65+
For minor changes, i.e. schema changes that are just a few lines, you can elimintate churn and skip these steps and make your changes directly in the **Main** branch. As an Admin, you are responsible for your own changes so be extra careful when doing this.
66+
67+
1. Create a branch in GitHub and make changes to **existing** schema file.
68+
2. Open a PR and tag your other team Admin as reviewer.
69+
3. Once approved, merge your PR to **Main**.
70+
4. After you verify your update was merged to **Main**, open a new PR and merge **Main** to **Live**. You may note other schema commits; it's up to you how to handle this but my theory is that if they're in **Main**, then they're ready to go live.
71+
72+
Generally, updates occur within 30 minutes but it can take up to 24 hours. To see your updated or new file, you may need to clear your cache.

0 commit comments

Comments
 (0)