@xyd-js/opensdk-python 0.0.0-build-f0c10f6-20260703195526

package/__fixtures__/-2.complex.openai/chat__completions__messages__list/input.json

@@ -0,0 +1,770 @@
+{
+  "opensdk": "1.0.0",
+  "info": {
+    "title": "openai",
+    "version": "2.3.0"
+  },
+  "servers": [
+    "https://api.openai.com/v1"
+  ],
+  "security": [
+    {
+      "type": "http",
+      "kind": "bearer",
+      "schemeName": "ApiKeyAuth",
+      "envVar": "OPENAI_API_KEY",
+      "scheme": "bearer"
+    },
+    {
+      "type": "http",
+      "kind": "bearer",
+      "schemeName": "AdminApiKeyAuth",
+      "envVar": "OPENAI_API_KEY",
+      "scheme": "bearer"
+    }
+  ],
+  "types": [
+    {
+      "name": "ChatCompletionsMessagesListOrder",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "asc"
+        },
+        {
+          "value": "desc"
+        }
+      ]
+    },
+    {
+      "name": "ChatCompletionMessageList",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "object",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "list"
+          },
+          "required": true,
+          "default": "list",
+          "description": "The type of this object. It is always set to \"list\".\n"
+        },
+        {
+          "name": "data",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionMessageListDataItem"
+            }
+          },
+          "required": true,
+          "description": "An array of chat completion message objects.\n"
+        },
+        {
+          "name": "first_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The identifier of the first chat message in the data array."
+        },
+        {
+          "name": "last_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The identifier of the last chat message in the data array."
+        },
+        {
+          "name": "has_more",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean"
+          },
+          "required": true,
+          "description": "Indicates whether there are more chat messages available."
+        }
+      ],
+      "description": "An object representing a list of chat completion messages.\n"
+    },
+    {
+      "name": "ChatCompletionMessageListDataItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "content",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "refusal",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "tool_calls",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageToolCalls"
+          },
+          "required": false
+        },
+        {
+          "name": "annotations",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionMessageListDataItemAnnotationsItem"
+            }
+          },
+          "required": false,
+          "description": "Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).\n"
+        },
+        {
+          "name": "role",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "assistant"
+          },
+          "required": true,
+          "description": "The role of the author of this message."
+        },
+        {
+          "name": "function_call",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageListDataItemFunctionCall"
+          },
+          "required": false,
+          "deprecated": true,
+          "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
+        },
+        {
+          "name": "audio",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageListDataItemAudio",
+            "nullable": true
+          },
+          "required": false
+        },
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The identifier of the chat message."
+        },
+        {
+          "name": "content_parts",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionMessageListDataItemContentPartsItem"
+            },
+            "nullable": true
+          },
+          "required": false
+        }
+      ]
+    },
+    {
+      "name": "ChatCompletionMessageToolCalls",
+      "kind": "alias",
+      "of": {
+        "kind": "array",
+        "items": {
+          "kind": "ref",
+          "name": "ChatCompletionMessageToolCallsItem"
+        }
+      }
+    },
+    {
+      "name": "ChatCompletionMessageToolCallsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "ChatCompletionMessageToolCall"
+        },
+        {
+          "kind": "ref",
+          "name": "ChatCompletionMessageCustomToolCall"
+        }
+      ],
+      "discriminator": {
+        "propertyName": "type",
+        "mapping": {
+          "function": "ChatCompletionMessageToolCall",
+          "custom": "ChatCompletionMessageCustomToolCall"
+        }
+      }
+    },
+    {
+      "name": "ChatCompletionMessageToolCall",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the tool call."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "function"
+          },
+          "required": true,
+          "description": "The type of the tool. Currently, only `function` is supported."
+        },
+        {
+          "name": "function",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageToolCallFunction"
+          },
+          "required": true,
+          "description": "The function that the model called."
+        }
+      ],
+      "description": "A call to a function tool created by the model.\n"
+    },
+    {
+      "name": "ChatCompletionMessageToolCallFunction",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function to call."
+        },
+        {
+          "name": "arguments",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
+        }
+      ],
+      "description": "The function that the model called."
+    },
+    {
+      "name": "ChatCompletionMessageCustomToolCall",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the tool call."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "custom"
+          },
+          "required": true,
+          "description": "The type of the tool. Always `custom`."
+        },
+        {
+          "name": "custom",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageCustomToolCallCustom"
+          },
+          "required": true,
+          "description": "The custom tool that the model called."
+        }
+      ],
+      "description": "A call to a custom tool created by the model.\n"
+    },
+    {
+      "name": "ChatCompletionMessageCustomToolCallCustom",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the custom tool to call."
+        },
+        {
+          "name": "input",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The input for the custom tool call generated by the model."
+        }
+      ],
+      "description": "The custom tool that the model called."
+    },
+    {
+      "name": "ChatCompletionMessageListDataItemAnnotationsItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "url_citation"
+          },
+          "required": true,
+          "description": "The type of the URL citation. Always `url_citation`."
+        },
+        {
+          "name": "url_citation",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageListDataItemAnnotationsItemUrlCitation"
+          },
+          "required": true,
+          "description": "A URL citation when using web search."
+        }
+      ],
+      "description": "A URL citation when using web search.\n"
+    },
+    {
+      "name": "ChatCompletionMessageListDataItemAnnotationsItemUrlCitation",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "end_index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "The index of the last character of the URL citation in the message."
+        },
+        {
+          "name": "start_index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "The index of the first character of the URL citation in the message."
+        },
+        {
+          "name": "url",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "format": "uri"
+          },
+          "required": true,
+          "description": "The URL of the web resource."
+        },
+        {
+          "name": "title",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The title of the web resource."
+        }
+      ],
+      "description": "A URL citation when using web search."
+    },
+    {
+      "name": "ChatCompletionMessageListDataItemFunctionCall",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "arguments",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
+        },
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function to call."
+        }
+      ],
+      "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
+    },
+    {
+      "name": "ChatCompletionMessageListDataItemAudio",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Unique identifier for this audio response."
+        },
+        {
+          "name": "expires_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.\n"
+        },
+        {
+          "name": "data",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.\n"
+        },
+        {
+          "name": "transcript",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Transcript of the audio generated by the model."
+        }
+      ],
+      "description": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).\n"
+    },
+    {
+      "name": "ChatCompletionMessageListDataItemContentPartsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "ChatCompletionRequestMessageContentPartText"
+        },
+        {
+          "kind": "ref",
+          "name": "ChatCompletionRequestMessageContentPartImage"
+        }
+      ]
+    },
+    {
+      "name": "ChatCompletionRequestMessageContentPartText",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "text"
+          },
+          "required": true,
+          "description": "The type of the content part."
+        },
+        {
+          "name": "text",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The text content."
+        }
+      ],
+      "description": "Learn about [text inputs](/docs/guides/text-generation).\n"
+    },
+    {
+      "name": "ChatCompletionRequestMessageContentPartImage",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "image_url"
+          },
+          "required": true,
+          "description": "The type of the content part."
+        },
+        {
+          "name": "image_url",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionRequestMessageContentPartImageImageUrl"
+          },
+          "required": true
+        }
+      ],
+      "description": "Learn about [image inputs](/docs/guides/vision).\n"
+    },
+    {
+      "name": "ChatCompletionRequestMessageContentPartImageImageUrl",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "url",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "format": "uri"
+          },
+          "required": true,
+          "description": "Either a URL of the image or the base64 encoded image data."
+        },
+        {
+          "name": "detail",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionRequestMessageContentPartImageImageUrlDetail"
+          },
+          "required": false,
+          "default": "auto",
+          "description": "Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding)."
+        }
+      ]
+    },
+    {
+      "name": "ChatCompletionRequestMessageContentPartImageImageUrlDetail",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "auto"
+        },
+        {
+          "value": "low"
+        },
+        {
+          "value": "high"
+        }
+      ],
+      "description": "Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding)."
+    }
+  ],
+  "resources": [
+    {
+      "name": "chat",
+      "resources": [
+        {
+          "name": "completions",
+          "resources": [
+            {
+              "name": "messages",
+              "methods": [
+                {
+                  "action": "list",
+                  "httpMethod": "get",
+                  "path": "/chat/completions/{completion_id}/messages",
+                  "operationId": "getChatCompletionMessages",
+                  "description": "Get the messages in a stored chat completion. Only Chat Completions that\nhave been created with the `store` parameter set to `true` will be\nreturned.\n",
+                  "pathParams": [
+                    {
+                      "name": "completion_id",
+                      "type": {
+                        "kind": "scalar",
+                        "scalar": "string"
+                      },
+                      "required": true,
+                      "description": "The ID of the chat completion to retrieve messages from."
+                    }
+                  ],
+                  "queryParams": [
+                    {
+                      "name": "after",
+                      "type": {
+                        "kind": "scalar",
+                        "scalar": "string"
+                      },
+                      "required": false,
+                      "description": "Identifier for the last message from the previous pagination request."
+                    },
+                    {
+                      "name": "limit",
+                      "type": {
+                        "kind": "scalar",
+                        "scalar": "integer"
+                      },
+                      "required": false,
+                      "description": "Number of messages to retrieve.",
+                      "default": 20
+                    },
+                    {
+                      "name": "order",
+                      "type": {
+                        "kind": "ref",
+                        "name": "ChatCompletionsMessagesListOrder"
+                      },
+                      "required": false,
+                      "description": "Sort order for messages by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.",
+                      "default": "asc"
+                    }
+                  ],
+                  "responses": [
+                    {
+                      "status": "200",
+                      "description": "A list of messages",
+                      "contentType": "application/json",
+                      "type": {
+                        "kind": "ref",
+                        "name": "ChatCompletionMessageList"
+                      }
+                    }
+                  ],
+                  "primaryResponse": {
+                    "kind": "ref",
+                    "name": "ChatCompletionMessageList"
+                  },
+                  "pagination": {
+                    "style": "cursor",
+                    "itemsField": "data",
+                    "nextField": "has_more",
+                    "itemType": {
+                      "kind": "ref",
+                      "name": "ChatCompletionMessageListDataItem"
+                    },
+                    "cursorParam": "after",
+                    "limitParam": "limit"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "sdk": {
+    "retry": {
+      "maxRetries": 2,
+      "retryableStatusCodes": [
+        408,
+        429,
+        500,
+        502,
+        503,
+        504
+      ],
+      "retryConnectionErrors": true,
+      "honorRetryAfterHeader": true,
+      "backoff": {
+        "initialDelayMs": 500,
+        "maxDelayMs": 8000,
+        "multiplier": 2,
+        "jitter": 0.25
+      }
+    },
+    "timeout": {
+      "defaultTimeoutMs": 60000
+    },
+    "errors": {
+      "statusCodeMap": {
+        "400": "BadRequest",
+        "401": "Unauthorized",
+        "403": "PermissionDenied",
+        "404": "NotFound",
+        "409": "Conflict",
+        "422": "UnprocessableEntity",
+        "429": "RateLimited"
+      },
+      "clientErrorKind": "API",
+      "serverErrorKind": "Internal"
+    },
+    "userAgent": {
+      "sdkIdentifierTemplate": "{package}-{language}/{version}",
+      "includeRuntimeVersion": false,
+      "aiAgentEnvVars": {
+        "CLAUDE_CODE": "claude-code",
+        "CURSOR_AGENT": "cursor",
+        "CLINE_ACTIVE": "cline",
+        "WINDSURF_ACTIVE": "windsurf",
+        "COPILOT_AGENT": "copilot"
+      }
+    },
+    "telemetry": {
+      "requestIdHeader": "X-Request-ID",
+      "headerName": "X-Client-Telemetry",
+      "enabledByDefault": false
+    },
+    "logging": {
+      "events": [
+        "request.start",
+        "request.success",
+        "request.retry",
+        "request.rate_limited",
+        "request.error",
+        "request.connection_error"
+      ]
+    },
+    "idempotency": {
+      "headerName": "Idempotency-Key",
+      "autoGenerateForPost": true
+    },
+    "pagination": {
+      "autoPageDelayMs": 0
+    },
+    "requestGuard": {
+      "optionKeys": [
+        "api_key",
+        "apiKey",
+        "idempotency_key",
+        "idempotencyKey",
+        "extra_headers",
+        "extraHeaders",
+        "max_retries",
+        "maxRetries",
+        "base_url",
+        "baseUrl",
+        "timeout"
+      ]
+    }
+  }
+}