Skip to content

Update links to Unstructured docs in Postman collections #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewmay-design wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update links to Unstructured docs in Postman collections #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions postman/Unstructured-REST-API-Workflow-Endpoint.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the settings for the source connector here.\n // See https://docs.unstructured.io/api-reference/workflow/sources/overview\n // For example:\n \"name\": \"<name>\",\n \"type\": \"<type>\",\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"raw": "{\n // Specify the settings for the source connector here.\n // See https://docs.unstructured.io/api-reference/workflow/sources/overview\n // API reference: https://docs.unstructured.io/api-reference/api/source/create-source\n // For example:\n \"name\": \"<name>\",\n \"type\": \"<type>\",\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -151,7 +151,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the updated settings for the source connector here.\n // Note that the \"name\" and \"type\" settings cannot be updated after the source connector is intially created.\n // See https://docs.unstructured.io/api-reference/workflow/sources/overview\n // For example:\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"raw": "{\n // Specify the updated settings for the source connector here.\n // Note that the \"name\" and \"type\" settings cannot be updated after the source connector is intially created.\n // See https://docs.unstructured.io/api-reference/workflow/sources/overview\n // API reference: https://docs.unstructured.io/api-reference/api/source/update-source\n // For example:\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -326,7 +326,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the settings for the destination connector here.\n // See https://docs.unstructured.io/api-reference/workflow/destinations/overview\n // For example:\n \"name\": \"<name>\",\n \"type\": \"<type>\",\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"raw": "{\n // Specify the settings for the destination connector here.\n // See https://docs.unstructured.io/api-reference/workflow/destinations/overview\n // API reference: https://docs.unstructured.io/api-reference/api/destination/create-destination\n // For example:\n \"name\": \"<name>\",\n \"type\": \"<type>\",\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -368,7 +368,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the updated settings for the destination connector here.\n // Note that the \"name\" and \"type\" settings cannot be updated after the destination connector is intially created.\n // See https://docs.unstructured.io/api-reference/workflow/destinations/overview\n // For example:\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"raw": "{\n // Specify the updated settings for the destination connector here.\n // Note that the \"name\" and \"type\" settings cannot be updated after the destination connector is intially created.\n // See https://docs.unstructured.io/api-reference/workflow/destinations/overview\n // API reference: https://docs.unstructured.io/api-reference/api/destination/update-destination\n // For example:\n \"config\": {\n \"<key>\": \"<value>\"\n }\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -549,7 +549,7 @@
}
]
},
"description": "For a list of available strings for `status`, such as `active` and `inactive`, see [https://docs.unstructured.io/api-reference/workflow/overview#list-workflows](https://docs.unstructured.io/api-reference/workflow/overview#list-workflowsFor)"
"description": "For a list of available strings for `status`, such as `active` and `inactive`, see [https://docs.unstructured.io/api-reference/workflow/overview](https://docs.unstructured.io/api-reference/workflow/overviewFor)"
},
"response": []
},
Expand Down Expand Up @@ -603,7 +603,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the settings for the workflow here.\n // See https://docs.unstructured.io/api-reference/workflow/workflows#create-a-workflow\n // For example:\n \"name\": \"<name>\",\n \"source_id\": \"<source-connector-id>\", // To use a local source, omit \"source_id\".\n \"destination_id\": \"<destination-connector-id>\", // To use a local destination, omit \"destination_id\".\n \"workflow_type\": \"<type>\", // To use a workflow template: \"template\". To specify nodes manually: \"custom\".\n \"template_id\": \"<workflow-template-id>\", // To specify nodes manually, omit \"template_id\". To use a workflow template, omit \"workflow_nodes\".\n \"workflow_nodes\": [\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n },\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n }\n // And so on for additional workflow DAG nodes.\n ],\n \"schedule\": \"<schedule-timeframe>\"\n}\n\n\n\n\n\n\n\n",
"raw": "{\n // Specify the settings for the workflow here.\n // See https://docs.unstructured.io/api-reference/workflow/workflows\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/create-workflow\n // For example:\n \"name\": \"<name>\",\n \"source_id\": \"<source-connector-id>\", // To use a local source, omit \"source_id\".\n \"destination_id\": \"<destination-connector-id>\", // To use a local destination, omit \"destination_id\".\n \"workflow_type\": \"<type>\", // To use a workflow template: \"template\". To specify nodes manually: \"custom\".\n \"template_id\": \"<workflow-template-id>\", // To specify nodes manually, omit \"template_id\". To use a workflow template, omit \"workflow_nodes\".\n \"workflow_nodes\": [\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n },\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n }\n // And so on for additional workflow DAG nodes.\n ],\n \"schedule\": \"<schedule-timeframe>\"\n}\n\n\n\n\n\n\n\n",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -648,7 +648,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n // Specify the updated settings for the workflow here.\n // See https://docs.unstructured.io/api-reference/workflow/workflows#create-a-workflow\n // For example:\n \"name\": \"<name>\",\n \"source_id\": \"<source-connector-id>\", // To use a local source, omit \"source_id\".\n \"destination_id\": \"<destination-connector-id>\", // To use a local destination, omit \"destination_id\".\n \"workflow_type\": \"<type>\",\n \"workflow_nodes\": [\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n },\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n }\n // And so on for additional workflow DAG nodes.\n ],\n \"schedule\": \"<schedule-timeframe>\"\n}\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",
"raw": "{\n // Specify the updated settings for the workflow here.\n // See https://docs.unstructured.io/api-reference/workflow/workflows\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/update-workflow\n // For example:\n \"name\": \"<name>\",\n \"source_id\": \"<source-connector-id>\", // To use a local source, omit \"source_id\".\n \"destination_id\": \"<destination-connector-id>\", // To use a local destination, omit \"destination_id\".\n \"workflow_type\": \"<type>\",\n \"workflow_nodes\": [\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n },\n {\n \"name\": \"<node-name>\",\n \"type\": \"<node-type>\",\n \"subtype\": \"<node-subtype>\",\n \"settings\": {\n \"<key>\": \"<value>\"\n }\n }\n // And so on for additional workflow DAG nodes.\n ],\n \"schedule\": \"<schedule-timeframe>\"\n}\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -772,7 +772,7 @@
"run"
]
},
"description": "To run the worfklow for multiple files, add an additional `input_files`, `filename`, and `type` entry for each additional file.\n\nSee also [https://docs.unstructured.io/api-reference/workflow/overview#run-a-workflow](https://docs.unstructured.io/api-reference/workflow/overview#run-a-workflow)"
"description": "To run the worfklow for multiple files, add an additional `input_files`, `filename`, and `type` entry for each additional file.\n\nSee also [https://docs.unstructured.io/api-reference/workflow/overview](https://docs.unstructured.io/api-reference/workflow/overview)"
},
"response": []
},
Expand Down Expand Up @@ -961,7 +961,7 @@
}
]
},
"description": "To get the values for `file_id` and `node_id`, run the \"GET Get a Job\" request.\n\nSee also [https://docs.unstructured.io/api-reference/workflow/overview#download-a-processed-local-file-from-a-job](https://docs.unstructured.io/api-reference/workflow/overview#download-a-processed-local-file-from-a-job)"
"description": "To get the values for `file_id` and `node_id`, run the \"GET Get a Job\" request.\n\nSee also [https://docs.unstructured.io/api-reference/workflow/overview](https://docs.unstructured.io/api-reference/workflow/overview)"
},
"response": []
},
Expand Down