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": {
+ "candidatesByStatus": {
+ "description": "Fallback shortlist keyed off the HTTP status, populated only when no exact code match was found.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "description": "What that code means.",
+ "type": "string"
+ },
+ "errorCode": {
+ "description": "A code that shares the extracted HTTP status.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "errorCode",
+ "description"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "correlationGuidance": {
+ "description": "Ready-to-use sentence for a support request, or instructions for capturing the correlation id when it was missing.",
+ "type": "string"
+ },
+ "match": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "causes": {
+ "description": "Known conditions that trigger it.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "What the error means.",
+ "type": "string"
+ },
+ "docUrl": {
+ "description": "Microsoft Learn page covering this error.",
+ "format": "uri",
+ "type": "string"
+ },
+ "errorCode": {
+ "description": "Partner Center error code, e.g. \"900400\".",
+ "type": "string"
+ },
+ "httpStatus": {
+ "description": "HTTP status code the API returns with this error.",
+ "type": "number"
+ },
+ "relatedScenarios": {
+ "description": "Scenario ids where this error commonly surfaces.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "remediation": {
+ "description": "Concrete fix to apply.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "httpStatus",
+ "errorCode",
+ "description",
+ "causes",
+ "remediation",
+ "docUrl"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The documented error entry for the extracted code, or null when the code is unknown or absent."
+ },
+ "note": {
+ "description": "Present when decoding was incomplete, explaining what to do next.",
+ "type": "string"
+ },
+ "parsed": {
+ "additionalProperties": false,
+ "description": "What was extracted from the raw input.",
+ "properties": {
+ "code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Error code recovered from the input, or null if none could be found."
+ },
+ "correlationId": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "MS-CorrelationId GUID recovered from the input, or null. Microsoft support needs this to trace the request."
+ },
+ "httpStatus": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "HTTP status recovered from the input, or null."
+ }
+ },
+ "required": [
+ "code",
+ "httpStatus",
+ "correlationId"
+ ],
+ "type": "object"
+ },
+ "relatedScenarios": {
+ "description": "Operations where this error commonly appears. Empty when there was no match.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "docUrl": {
+ "description": "Microsoft Learn page documenting this operation.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Scenario id to pass to pc_get_scenario or pc_generate_call.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Human-readable name of the operation.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "title",
+ "docUrl"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "parsed",
+ "match",
+ "relatedScenarios",
+ "candidatesByStatus",
+ "correlationGuidance"
+ ],
+ "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"
+}