changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "additionalProperties": false,
+ "description": "The result payload. Present only when `ok` is true.",
+ "properties": {
+ "matches": {
+ "description": "One entry per recognised SDK call. Empty when the snippet used no known SDK pattern.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "notes": {
+ "description": "What changes in the move to REST: renamed fields, behavioural differences, extra steps.",
+ "type": "string"
+ },
+ "scenario": {
+ "additionalProperties": false,
+ "description": "The full REST scenario that replaces this SDK call.",
+ "properties": {
+ "api": {
+ "description": "Which API surface hosts this operation. Absent means \"partner-center\". GDAP and reconciliation-v2 operations are \"graph\" and need a different token audience.",
+ "enum": [
+ "partner-center",
+ "graph",
+ "pricing-and-referrals"
+ ],
+ "type": "string"
+ },
+ "area": {
+ "description": "Functional area of the Partner Center API this operation belongs to.",
+ "enum": [
+ "customers",
+ "subscriptions",
+ "orders",
+ "licenses",
+ "invoicing",
+ "profiles",
+ "auth",
+ "catalog",
+ "utilities",
+ "audit",
+ "support",
+ "security",
+ "analytics",
+ "devices",
+ "referrals"
+ ],
+ "type": "string"
+ },
+ "authType": {
+ "description": "Token flavour the operation requires. \"app+user\" needs the Secure Application Model refresh-token flow.",
+ "enum": [
+ "app-only",
+ "app+user"
+ ],
+ "type": "string"
+ },
+ "docUrl": {
+ "description": "Microsoft Learn page documenting this operation.",
+ "format": "uri",
+ "type": "string"
+ },
+ "examples": {
+ "additionalProperties": false,
+ "description": "Ready-to-adapt request examples per language.",
+ "properties": {
+ "csharp": {
+ "description": "C# HttpClient snippet.",
+ "type": "string"
+ },
+ "curl": {
+ "description": "Runnable curl invocation.",
+ "type": "string"
+ },
+ "typescript": {
+ "description": "TypeScript fetch snippet.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "curl",
+ "csharp",
+ "typescript"
+ ],
+ "type": "object"
+ },
+ "gotchas": {
+ "description": "Pitfalls that commonly break this call in practice, most consequential first.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "Request headers this operation expects.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "Header name.",
+ "type": "string"
+ },
+ "note": {
+ "description": "What to put in the header and why.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Whether the call fails without it.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name",
+ "required"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Stable kebab-case identifier, e.g. \"create-cart\". Pass this to pc_get_scenario, pc_generate_call, or pc_build_request.",
+ "type": "string"
+ },
+ "lastVerified": {
+ "description": "YYYY-MM-DD on which this entry was last checked against the live documentation.",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+ "type": "string"
+ },
+ "method": {
+ "description": "HTTP verb for the call.",
+ "enum": [
+ "GET",
+ "POST",
+ "PUT",
+ "PATCH",
+ "DELETE",
+ "HEAD"
+ ],
+ "type": "string"
+ },
+ "path": {
+ "description": "API-relative path with {placeholder} segments, e.g. \"/v1/customers/{customer-id}/subscriptions\". Resolve it against the base URL for `api`.",
+ "type": "string"
+ },
+ "requestFields": {
+ "description": "Per-field documentation for the request body, when the operation takes one.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "Field path within the request body; \"[]\" marks an array hop, e.g. \"lineItems[].catalogItemId\".",
+ "type": "string"
+ },
+ "note": {
+ "description": "Constraints, accepted values, or gotchas for this field.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Whether the request is rejected without it.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Declared type of the field.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "type",
+ "required"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "requestShape": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON body template, or null for operations that take no body."
+ },
+ "responseShape": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON response template, or null when the operation returns no body."
+ },
+ "title": {
+ "description": "Human-readable name of the operation.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "area",
+ "title",
+ "method",
+ "path",
+ "authType",
+ "headers",
+ "requestShape",
+ "responseShape",
+ "examples",
+ "gotchas",
+ "docUrl",
+ "lastVerified"
+ ],
+ "type": "object"
+ },
+ "sdkPattern": {
+ "description": "The archived SDK call chain that was recognised.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "sdkPattern",
+ "notes",
+ "scenario"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "unmatched": {
+ "description": "True when nothing was recognised — either the code does not use the archived SDK, or the call is not in the mapping table. Try pc_search_docs in that case.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "matches",
+ "unmatched"
+ ],
+ "type": "object"
+ },
+ "error": {
+ "description": "Human-readable reason the call failed. Present only when `ok` is false.",
+ "type": "string"
+ },
+ "ok": {
+ "description": "True when the call succeeded and `data` is populated; false when `error` explains why not.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "ok"
+ ],
+ "type": "object"
+}