Skip to content

Update apispec to latest production version #2555

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.

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

Merged
merged 6 commits into from
Jul 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/updateApiSpec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Check for differences
id: diff_check
run: |
if cmp -s newSpec.yaml static/rawApiSpec.yaml; then
if cmp -s newSpec.yaml static/apispec.yaml; then
echo "diff_found=false" >> $GITHUB_OUTPUT
echo "No changes detected."
else
Expand All @@ -46,7 +46,7 @@ jobs:
# Step 5: Update the YAML file in the repository if differences are found
- name: Update YAML file
if: steps.diff_check.outputs.diff_found == 'true'
run: mv newSpec.yaml static/rawApiSpec.yaml
run: mv newSpec.yaml static/apispec.yaml

# Step 6: Create a pull request with the changes using the hash as the branch name
- name: Create Pull Request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ When using a `Webhook` as the action backend, a [`Request type` option](/actions

#### Run details

By sending a [`PATCH` request](/api-reference/patch-an-action-run) to Port's API, you can do the following:
By sending a [`PATCH` request](/api-reference/update-an-action-run) to Port's API, you can do the following:

1. Update the run's status, by using the `status` key with one of these values: `SUCCESS`, `FAILURE`.
This will mark the run as completed and show a visual indicator, for example:
Expand Down Expand Up @@ -190,7 +190,7 @@ A log message with the `terminationStatus` key can only be sent once for an acti

## Tying Entities to an action run

You can also add additional context and metadata to an action run by attaching a `run_id` query parameter to every API route that creates or changes an entity (i.e. [`POST`](/api-reference/create-an-entity), [`PUT`](/api-reference/change-an-entity), [`PATCH`](/api-reference/patch-an-entity) and [`DELETE`](/api-reference/delete-an-entity) entity requests).
You can also add additional context and metadata to an action run by attaching a `run_id` query parameter to every API route that creates or changes an entity (i.e. [`POST`](/api-reference/create-an-entity), [`PUT`](/api-reference/change-an-entity), [`PATCH`](/api-reference/update-an-entity) and [`DELETE`](/api-reference/delete-an-entity) entity requests).

By adding the `run_id` parameter, you reflect the change made to the Entity as part of the set of steps the action run performed during its runtime.

Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/add-a-log-to-an-action-run.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This route allows you to send a log message back to Port, which wi
sidebar_label: "Add a log to an action run"
hide_title: true
hide_table_of_contents: true
api: eJztV0tv2zgQ/ivEXLYFZCspuhfDMOBms0DRAg2S9LBIjYASxxZrilT5sOM19N8XI0qW7DhtL4vtYS82TXKG8/jmm/EeBLrcyspLo2EC94V0zJrgkXGlzNaxnQnMG+ZQC8aZMitWonN8hSzj+ZqOboz1CdsWMi/YVirFMmRCukrxHQomNfMFMp7TC8wG/ZtjFV/hmP1lAsu5Zlw5w4JD5vvHvWGhEpxWBbZSHm0pNW/0OM99cOzV3eerq+u7u/TP+fuPn2+vXzOuBVM8Q8WiY5nUq0ZHlBhPM5vOmo97wxRyq1lpLDKemeAHVrqE5QXma0bbJP8gTB5K1L4xYPGq8L5ykzQVJnfjylg/libNLXKPI4dqOXJoNzLHET5VaCXqHF1qcakw96P4zqiyZmXRufT1GBLwfOVg8gDzaMRt0A4WCVj8FtD5d0bsYLKH3GiP2tOSV5WSeWNP+tVR/vbg8gJLTiu/qxAmYLKvmHtIoLKmQusluua0D+ZdE5mBiPNW6hUkz7CB53JglicJHrMrrgkECpeeZYrrNZPLBkhGqx3bcu3PQypmBxJAHUoKRZteSKBNMCzqBOLDHynLP7Z63sLBmw4ROMDDv2B9nUC78XMhHZZUp3dYWp3aOgEuhCRJrm4GyVxy5TDiRFoUFLfOgEVNYv2JtwHrBCpueYkeLeHtDGZaa+sEJFlZcV9AApqXdGiDfpQCnqldJOAwD1b6XaM1Q27RwuRhUTcodpXRLoLvzcUlfZ0kSggUzIU8R+eWQakdFcVPw/0Y3mY9cIfrXY8pspVAZIP+aFY/LhQpzgbGBv3+/MmLya8TiPwg3u2+dzr354CzNLbkHiZArDjyskQ4zu0DxKw0hvVmDB8dPrE4lTZrYpvvQuw4YZ8+QN3g6+3F2+fp/KSxK66loVZCRIzWGuuYyfNgLYrJF/1FTz3PFM5oYWdfNGNTX8yu6eI09cVh549ee7s/TRuBXkzMptlMG/+4NEGLaZrNpqkXh8P7ozpnW+mLxrzKmo0k7EmB2sulRMu23DFtPGs1NVq699LOYMrZ2zdvfh3fpd5wJcVj2zLORkBwz3uXhcHoaMl9HsMRG3AsrBPPj18jIsCnggfn8Xm0532kubLIxY4tpZauQMHwCfPQevNiZH+/uPiVIuvRaq4eMao4dVaz7ka05mDMyx42VOELI4hhjWuYh4h2AunmMo1AdSmNIuk+cm6dKrNyQDxrNx15B6tgAt00wivZDSNQJ+dOg+svDCj7jvIdGa8j7p4/K/kBd30HmAdfGCv/bqgY2iZRIBdoG7eInG/7qeX6iZeVwhemjkGPP+rrPfMdCPWoLy1No1B60gzUKNn85j0kQJGJYLkcX9BdCm7Jm3bROSC61u0Nown0gNXTDj2Yt/6fjf/L2Tgi0eOTTyvFZcMQDbj3bdU8wOYSEmjrJjZC+poc5pWmeBYJFFRskwfY7zPu8LNVdU3b3wJamlwWCWy4lVSnTYEJ6WgtznfBIUBe3bbt9DV7yeSjiWTDVaBfkMAad/1oVdN80tYTWRAPr+I7o3tS0Qs/m4qo7KPEPM+x8t+9uxiQ0M2nu3tIIGv/aJRGNOMe31Iw+TYaaqoY38k+7u1Bcb0KsT6jzmZSDZSTIYOsGwZpF+TV2VCcUkt0hD7JrbMi+33kp7o+3I9HL0q0oe1uU2ZoUP4HBxs2Rg==
api: eJztV1Fv4zYM/iuCXtYCTXzp7ikYBqRdBxTX4YqkfRiKYJBtOtHVljxJTpoF+e8jJTtxEre9dgPWh704iiRS5MePIrXmTswsHz7wUeKkVmxcKcunZzwFmxhZ0hwf8ru5tMzoygETea6Xlq10xZxmFlTKBMv1jBVgrZgBi0XySEu32rgztpzLZM6WMs9ZDCyVtszFClImFXNz1BZONZX6wbISxfvsd9ScCIUHWc0qC7hveziqrcpU0AiFg5QDU0glvB7rhKssO5ncX15eTSbRr6Prm/vx1SkTaGYuYshZcCyWauZ1BIn+T7GJfvafO81yEEaxQhu0L8ZzW1baM5bMAR2kaZJ/SHVSFaCcN2B6MneutMMowmnbLxGCvtRRYgBt7lnIM/yYhUygB08lGAkqARsZyHJIXC+c0yuNnhlEMzrt8zNu4M8KrLvQ6YoP1zzRyuFxNBRlmcvEHxx9sxSoNbdoXiFo5FYlYOh0/A1Vox7Uiic6Cdav7lCbeAhaItYZhAdFQFUFcaOGE2dqQLsYAl2R0NlBmPvsEmOLVMghcyzOhXpkMvN00ipfsaVQrptYfb4540HtDUWyy+B9m0Z1yFFdHXVoxfxft60ev24XYdXOmEZlO3NQI6oUaSpJSOS3rehlmBoQiCENpBSh5uzphsR2K85UgBOlMKIAjA+legdJakNxpyQDS+HmaLVCGfyHyPwhU36otssrmSI1ZSbBdKDLN8gaC0llpFt5O2JMNDA4nNISUr7UygZ+nn8a0M/+EV+/oBXfnQD7hNeP9K0ZTfZPCahK3ejZ69mC7neBheLX3SvPcgHXwm2QXqxeWh25Lh5l2hQCVzjdgT0nMT778X7gIVLesJ0Z7UPbR0wPpRGl6Su0OwrJxnPuc1fAfoFMVLlj4zq0/zR8KGxdbQmeCcZo80b8jx1u9LzseOPl52MvRwypqyuTABY6N/e8R+sXmA1pOyWWwjKlHct0pdIPDcVO6m1seB8SNbSDH4+hHYfix2KsfgzbAKexPAuDl+ZJLgvpaG7wm7w4/dBwvg3E7/e5Bu78/Bg4uo3J8x38qYYAOt4gSQiNb6qwhaqh+cgQvpeR78FhE3DFgjnXKZVDbX1JoKo45NFiEIWqho0bdoTROhTITYQ13XIqcWbRVNrKYJ/Cm6ZQlLLpCRGHrtXK7ja0quWEDAtYNzVzix2KfYHVrlyPKjTbyL986Hhd0ecgUpQitwiN8a6nvHoSRZnDMz1hq/Xba712JWkbzL0mItNeoXSkmVNDw0a317idkAmRGfQ/0V4CtxCeXo0DadNdYS9ED4FtC3HYSbW64f+fKP/hE6VmooMnFyF4yDgMrCf3us6aB74Y4MY6b0KHQj/DbXPpkwcpP6dkw/3rdSws3Jt8s6Fp5KuhphGHC2GkiIlYmGAYLhqn3enfJsjJuL5ZTtnrreozPjUppyjfFiKv6B8OHzEBt43yhjrLOuHIxLB4GQzp3ZGKnfDRNUv3QpAYJQmU7sW909Ytdft1coeb4/qdWOjUN+9iSWjj1xuqyxAA3ODn1hxfObMqJHDQ6d8dFQWtfcU8+iumHpBXnVAc3j3BEfqSW50i63W4wDDMzf6w9KxEDW2zmyJDz56/AZbL16g=
sidebar_class_name: "post api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down Expand Up @@ -47,22 +47,22 @@ This route allows you to send a log message back to Port, which will be displaye
</Heading>

<ParamsDetails
parameters={[{"schema":{"type":"string"},"in":"path","name":"run_id","required":true}]}
parameters={[{"schema":{"type":"string"},"in":"path","name":"run_id","required":true,"description":"The identifier of the action run."}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"terminationStatus":{"type":"string","description":"The termination status of the action run. Can be left blank if you only want to send a log message.<br/>","enum":["SUCCESS","FAILURE"]},"statusLabel":{"type":"string","description":"A label to describe the status of the action run. Can be left blank if you only want to send a log message.<br/>"},"message":{"type":"string","description":"The log message to send back to Port.<br/>"}},"additionalProperties":false,"required":["message"]}}},"required":true}}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"terminationStatus":{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The termination status of the action run. Can be left blank if you only want to send a log message."},"statusLabel":{"type":"string","description":"A label to describe the status of the action run. Can be left blank if you only want to send a log message."},"message":{"type":"string","description":"The log message to send back to Port."}},"additionalProperties":false,"required":["message"]}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"Added successfully.","content":{"application/json":{"schema":{"properties":{"ok":{"type":"any","enum":[true]},"runLog":{"type":"object","properties":{"id":{"type":"string"},"runId":{"type":"string"},"message":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","runId","message","createdBy","createdAt"]}},"required":["ok"],"additionalProperties":false,"description":"OK"}}}},"404":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>not_found</b></td>\n <td>The action run with the provided identifier was not found</td>\n</tr>\n</table>\n"},"422":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>invalid_request</b></td>\n <td>The data provided does not match the route schema</td>\n</tr>\n<tr>\n <td><b>run_exhausted</b></td>\n <td>Action run already finished execution</td>\n</tr>\n</table>\n"},"500":{"description":"One of the following errors occurred:\n\n<table>\n<tr>\n <th>Error</th>\n <th>Description</th>\n</tr>\n<tr>\n <td><b>internal_error</b></td>\n <td>An internal error occurred</td>\n</tr>\n</table>\n"}}}
responses={{"201":{"description":"OK","content":{"application/json":{"schema":{"properties":{"ok":{"enum":[true]},"runLog":{"type":"object","properties":{"id":{"type":"string"},"runId":{"type":"string"},"message":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","runId","message","createdBy","createdAt"]}},"required":["ok"],"additionalProperties":false,"description":"OK"}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"ok":{"const":false},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false}}}},"404":{"description":"A resource with the provided identifier was not found","content":{"application/json":{"schema":{"properties":{"ok":{"const":false},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error","message"],"additionalProperties":false,"description":"A resource with the provided identifier was not found"}}}},"413":{"description":"Request body is too large (limit is 1MiB)","content":{"application/json":{"schema":{"properties":{"ok":{"const":false},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false,"description":"Request body is too large (limit is 1MiB)"}}}},"422":{"description":"The json provided does not match the route's schema","content":{"application/json":{"schema":{"properties":{"ok":{"const":false},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error","message"],"additionalProperties":false,"description":"The json provided does not match the route's schema"}}}}}}
>

</StatusCodes>
Expand Down
10 changes: 5 additions & 5 deletions docs/api-reference/aggregate-entities-over-time.api.mdx

Large diffs are not rendered by default.

Loading