Skip to content

Commit

Permalink
openapi.json update
Browse files Browse the repository at this point in the history
  • Loading branch information
DoKu88 committed Nov 19, 2024
1 parent c3b9e01 commit 440a4de
Showing 1 changed file with 4 additions and 128 deletions.
132 changes: 4 additions & 128 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,109 +12,16 @@
}
],
"paths": {
"/upload/validate_json": {
"/upload/upload": {
"post": {
"tags": [
"upload"
],
"summary": "validate_json",
"description": "Validate that a dictionary contains only JSON-serializable values.\n\nArgs:\n data: Dictionary to validate for JSON serialization\n\nRaises:\n ValueError: If the dictionary contains non-serializable values\n\n**Function Signature:** `validate_json(data)`\n\n**Return Type:** `None`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L15)",
"summary": "upload",
"description": "Upload all system traces and dataset to the server.\nReturns a tuple of (response, payload, dataset, traces)\n\nResponse is the response from the server.\nPayload is the payload that was sent to the server.\nDataset is the dataset that was uploaded.\nTraces is the list of traces that were tracked by the trace_system() decorators and SynthTracker.\n\n**Function Signature:** `upload(dataset, traces, verbose, show_payload)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L178)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L15"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/upload/send_system_traces": {
"post": {
"tags": [
"upload"
],
"summary": "send_system_traces",
"description": "Send all system traces and dataset metadata to the server.\n\n**Function Signature:** `send_system_traces(dataset, traces, base_url, api_key)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L39)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L39"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/upload/validate_upload": {
"post": {
"tags": [
"upload"
],
"summary": "validate_upload",
"description": "Validate the upload format before sending to server.\nRaises ValueError if validation fails.\n\n**Function Signature:** `validate_upload(traces, dataset)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L160)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L160"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/upload/upload_helper": {
"post": {
"tags": [
"upload"
],
"summary": "upload_helper",
"description": "Upload all system traces and dataset to the server.\n\n**Function Signature:** `upload_helper(dataset, traces, verbose, show_payload)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L197)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L197"
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/upload.py#L178"
},
"responses": {
"200": {
Expand Down Expand Up @@ -229,37 +136,6 @@
"deprecated": false
}
},
"/decorators/track_result": {
"post": {
"tags": [
"decorators"
],
"summary": "track_result",
"description": "Helper function to track results, including tuple unpacking\n\n**Function Signature:** `track_result(result, tracker, origin)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L492)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L492"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/trackers/SynthTrackerSync": {
"get": {
"tags": [
Expand Down

0 comments on commit 440a4de

Please sign in to comment.