Docs: Switch entity Update API pages to PUT so Try it works (#164)

[kiran1287]

What

The entity Update API pages showed PATCH /v1/<entity>/{id} with a plain JSON body. The Try it button sent Content-Type: application/json, but the server requires application/json-patch+json with an RFC 6902 array, so it returned 415 Unsupported Media Type.

This switches every entity Update page that used PATCH with a plain body (data assets, data contracts, data quality, governance, teams, users, alerts) in v1.13.x, v2.0.x, and v2.1.x-SNAPSHOT to PUT /v1/<entity> (create or update), the recommended Option 1 in the issue.

• Header is now api: PUT <collection path>
• Body parameters match the entity's create request
• New PUT curl example; existing SDK and PATCH (JSON Patch) examples are kept
• Removed "JSON Merge Patch" wording and the 404 error row
• Note explains partial updates with PATCH and application/json-patch+json

Verified against source

Each entity has a root createOrUpdate* PUT endpoint in OpenMetadata, and PATCH uses APPLICATION_JSON_PATCH_JSON. The Python SDK update() sends a PATCH.

Not tested: the Try it button in a Mintlify preview.

Closes #164

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
openmetadata	🟢 Ready	View Preview	Oct 16, 2026, 8:14 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

[github-actions]

Review Report

Content type: Documentation
Overall verdict: NEEDS WORK
Reason: Major=1, Minor=4 (no Critical issues)
Reviewed revision: b2415ed
Findings: Critical=0 Major=1 Minor=4

Issues Found

#	Guideline	Severity	Original text	Suggested change
1	Usable language (grammar) and official names are exact	Major	"Create or update a api collection with a full request body" (api-collections/update.mdx:3). Also "Create a api collection" (line 11), "a api endpoint" (api-endpoints/update.mdx:3,10), and "a ml model service" / "a ml model" (mlmodel-services/update.mdx:3,10, mlmodels/update.mdx:3,10). All are in the v1.13.x, v2.0.x, and v2.1.x-SNAPSHOT copies.	Use "an" before a vowel sound. Use the official capitalization "ML Model". Write "Create or update an API collection…", "Create an API collection or update it…", "an API endpoint", "an ML model service", and "an ML model".
2	Sentence punctuation / code formatting	Minor	"for example 256 for VARCHAR(256)." (tables/update.mdx, dataLength parameter, all three versions)	The backtick closes before the parenthesis, which breaks the code span. Write "for example 256 for VARCHAR(256)."
3	Consistent terminology (formatting of field names)	Minor	"for example hostPort, username, password for Superset." (dashboard-services/update.mdx). Also the account, warehouse, database Snowflake example (database-services/update.mdx), bootstrapServers, securityProtocol (messaging-services/update.mdx), and host, port, authentication (pipeline-services/update.mdx). All are in the three versions.	The ML model service page puts these field names in code formatting (`trackingUri`, `registryUri`). Format identifiers as code on all pages.
4	Meaning is unambiguous (page-level consistency)	Minor	"Invalid patch operations" (data-contracts/update.mdx, error table, v1.13.x, v2.0.x, v2.1.x-SNAPSHOT)	The page now leads with PUT with a full body, and every other updated page changed this row to "Invalid or malformed request body". Align the wording so it covers both PUT and PATCH requests.
5	Heading introductions / formatting	Minor	Extra blank line before ## Body Parameters (v2.0.x/api-reference/teams-and-users/users/update.mdx, after the Permissions paragraph; also in v2.1.x-SNAPSHOT)	Remove the duplicated blank line.

_{View job · claude-sonnet-5-5 (high) · full}