Skip to content

Commit a75f7e3

Browse files
sivanel97sivanel97
committed
updated relevant paths
1 parent aa8df4b commit a75f7e3

File tree

3 files changed

+24
-7
lines changed

3 files changed

+24
-7
lines changed

‎docs/api-reference/change-an-action-automation.api.mdx‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/api-reference/get-an-integrations-metrics-and-sync-status.api.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "This route allows you to get a specific integration's metrics and
55
sidebar_label: "Get an integration's metrics and sync status"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJztWd1r40YQ/1cWvfQC/khK+2JKIXBtMKUQ7tJCCSa3lsb2nle7ut2RHdf4f7+ZlWzLthwlD6n7oIc4aOdj5+M3IzGzjhLwsVMZKmuiQfQwU144myMIqbVderGyuUArpoBCCp9BrCYqFsogTJ1kqR+8SAGdir2QJhF+ZWLhUWLuBSicgRP0I7RE8CisAWGdmNBfRZsDlur9Mnb9X8PPEOkMc2d8EGYqXQPPEOd85VY/35cASqUh2RmR0Y1zRRS+BGQ8E9lMerp2stNV3CR+Z4ZnmWYaOoFm8nRM0sQ5AYxnpNSOv0KMnvytGhKohdpORWjLjDOJYgkORCqzjLSU0vykzHQrSEoqLj9YoUE6I1JLgnJMOahG2XcEGRTPBZ+zssfExnkKBgN59GGGmPlBv0/HvpdZhz1l++Nc6aRLKXRdbye4lA66sUSp7bTPvnQTeuii3R1e9aJOhHLqo8FjNKxcH406USadpCiDY+o68mRQKqPBOsJVBgQeTwkw02jTiRRj6VsObkXqDAnRY5HkYUInDr7lykESDSZSUyhOQAhi+JEjeooRMeQ0EkgnCjRF1lPUJiggzXDVqSKt4BfsoFgqrcUYSkxB0iMbm+3PJM725ldywXFxRuojX9DlL7jCplV0hLpaSoNcXJYwS1ZTdbzOshnIBNzettscZ9apf4Pm5vj+Q3gQt/dDunoOpiceivJW2BFTy/YwYMTjPYFIyDi2ucE9vgjDO3hdESi1IlCyc196vd4XMc4RrQmZMFXiHZjCx929W95QxbHNVoFxWvIlpXHRZsT++IwwCJ5D8uP1Nf87dOkjTGSuUXwqOSkIsaVoG2RespksCdHpf/UsUBPjonpJMHOcD1TFdXZe4RlbS0VqOBEhLBVS0QaYwpCrEKRzkstAIaS++b4KRh4CYy0I9lhMyEcqELq6gfNvqltV+H7CZmPy6iUGbqgNVzHLeVmTwHNttGBBWof1klzBn6nB1UdhrHPI6AFrqeXroDngoRs3sxX9pJkvyYtwP3kgBCa+1mmfxzH4OhoRZZIo1iD1fUVzqGSiaiuTV6A2HD8FkD7hIY7OiPi54pfV23TXe7DvP4+H3KMm7ybhXX5ZGzjCl7bByeUTPKOTMV7aFDLCePqWSi9tyERpeu9C8kSfQJe1JAENF85LQ594QXPRDhp9LNHXtpq21bStpm0179lqdmlvm03bbNpm0zab92w2hY9tp2k7Tdtp2k7zfp3mbeqLIVRj2GIHPBu9rRl5UXYJYZIoPICELqoUeNSUZ8nbRI4sO55Hnps+1s4ajyaLJ3PEcmq4nwJWZ377GV7V8apHTSk4zuE82s5tyyltowLS8NP1TZjrXXjeDM7Z+sFrCt7Lad2MtM7/Qs9rHP/5/zFo/68dL2bHM0uS0RSCnbwIGkT9xU2/gvH+unYltAmLtT93yPXgFtuNWe40b292mxS13aSErc8pNfd7hhGrinOncPWZI1oEbQzSHczjSewPqGzdjldD1f3RJiwIJjaIK9TMH5Y+t/dDYl1s9wHRTe+a451Zj6kMSS213/FW2LxuGxwdraHWe+C0a+d27dzZIhjpq62faalC9YeiWJcl+Bgtbg5fNPQ0OLeZrdYhVc+M0Msq1usxxeEvpzcbPi621FydifJyrM9tTQ/h+u4L6jPhmFNtH6zSF1LnzBYaxEI6xS680Z0Pn8peeSXevq8+Y+i2HZlV1citA/Up24xIsOxN7EHBexvHkGFFy8lLhl3ftey73x6osX0Hb2JyLg==
8+
api: eJztWW1r40YQ/iuLvvQCfklK+sWUQuDaYEoh3KWFEkJuLY2sPa+0ut2RHdf4v9/Myi9rW46TD8GF04eYSPOyM7PPPCt2FtEvl5fRYBEl4GKrSlSmiAbRR0hlpVF8AleawkHUiWJTIBTIurIstYol6/a/OjZYRC7OIJf8H85LIBdm9BViJMPSmhIsKnAsNZNAZ2SMBllEy04E1hobiBxaVYxZkoNzcgwNMhJa+FYpC0k0eGDXaz+PnUgmieIIpb4LAkildrBcsuluxveZcsKaCkFIrc3MibmpBBoxBhRSuBJilapYKKrC2Prcf3IiBwoldkIWiXDzIhYOJVZOgMIMrKAfoSWCQ2EKEMaKlP4CbxbYqvfryPZ/8z9DpHdY2cJ5Y5bSMvAMccVLrv3zegmgVBqSTRCUpJgokvAiIONMlJl0tGy68VWvJP5ghWeZlxo6XlZU+YisSTMFpJ1MRL19jvINA/HS2m0nMForYyZRzMCCyAkj5GVlzU+0Y2tDchKkfG8EgcAWIjdkKEe0B2GVXUdQQPFE8Ht29pCYuMoJil78+CFDLN2g36fXrlcaiz1l+qNK6aRLW2i7zqQ4kxa6hFipzbjPuXQTeuii2by86BF4UI4dI2kYLM9YKqWVVGWwLG3A+hasirH0rQI7J3cFGdFjvcnDJArh6oF4CEIQw49c0UOMiCFvI4E0VaCpso6qlqKAvMR5J0RarS84QTFTWosRrDAFSY9iPB1/KTHbhh/sBdfFUkft5YK2eiEVDi3w4ftqJgvk5uLGpKipO14XWQYyAbuN7abCzFj1n/d8ur7/Eh7Ezd2Qlp5A0RP3dXsr7Iix4XgYMOLhjkAkZBybqsAtvgjDG3hdECiJAic+uS+9Xu+LGFWIpvA7UYTCWyjqHDfrrnV9F8emnHvF8UovWQUXLR85n5p/PXX+/P9gal+WQFTTAEsYcoFAWiu5DRRC7k6vF2Dk3is2gmCLxYRypAaB5lMj0PyH+lbVuR+omZiyekmBCfXEUqxy3LZI4LmxWjAlr8NmS+7gz0RwzVUY6QpKesAj56U/Dk4X3LPxabWaT07rJVVd7icHhMDENSbtqjim87xBtnz5yO5E2sjkFaj1r588SJ9wF0dHTNxE8WH1Nt/NGex8joTaJz5IOlHqz/LzxsAVPncMVs6e4BmtjPHcoVAQhaNvqfzcgaRK07kLyRN9Ap03kgQ0nHlfTvDEC55rOjiZ4wp9LdW0VNNSTUs170k1m21vyaYlm5ZsWrJ5T7Kpc2yZpmWalmlapnk/pnmb+/oS6mTZYgt8N3rTcOVFu0sIkyThC0joosqBr5qqMnmbyV5k+/eRx24fG+8a924WD+4RV7eG21vA8M5ve4cXJh5mdHK+1TAZq7GxuqV9zYDs+vLK3+v9cJPB68vraFBUWu/PD36E5Al6mSHDaAw+TJ4FDaL+9KofwLy/aJwKLf1s7a8NeB3Y6XpoVlnNA5zNMEWthyl+8HMordxW4ZFdxZVVOP/MBa1rNgJpd67kyexPCAZv+9OhcIS09DOC1HhzhZr1/dzn5m5IqtP1SCC66l1yuUvjMJd+T1feb3kwXLxuIBztIWmxxU07eW4nz501gpE+3Pqllso3v2+KxaoFH6Lp1e5ZQ0+DY8PZsA+pezJCL7tYLEZUh7+tXi75dT2o5u5MlJMjfWxwugvXd59RHynHhHp7Z5o+lbpiNU8QU2kVp/DGdD58WlHlhXj7yPpIoGs6KuZhkOsEmrds+UiGK27iDGrdmziGEgMvB2cMp76h7Nvf74nYvgObtcoF
99
sidebar_class_name: "get api-method"
1010
info_path: api-reference/port-api
1111
custom_edit_url: null
@@ -62,7 +62,7 @@ This route allows you to get a specific integration's metrics and sync status ei
6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"count":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"integrationType":{"type":"string"},"integrationIdentifier":{"type":"string"},"integrationVersion":{"type":"string"},"oceanVersion":{"type":"string"},"kindIdentifier":{"type":"string"},"kind":{"type":"string"},"kindIndex":{"type":"number"},"eventId":{"type":"string"},"syncState":{"type":"string"},"blueprint":{"type":"string"},"metrics":{"type":"object","properties":{"phase":{"type":"object","properties":{"resync":{"type":"object","properties":{"duration_seconds":{"type":"number"},"success":{"type":"number"}},"additionalProperties":false},"load":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"extract":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"transform":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"delete":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false}},"additionalProperties":false}},"required":["phase"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["integrationType","integrationIdentifier","integrationVersion","oceanVersion","kindIdentifier","kind","eventId","syncState","metrics","createdAt","updatedAt"],"additionalProperties":false}}},"required":["ok","count","data"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false}}}}}}
65+
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"count":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"integrationType":{"type":"string"},"integrationIdentifier":{"type":"string"},"integrationVersion":{"type":"string"},"oceanVersion":{"type":"string"},"kindIdentifier":{"type":"string"},"kind":{"type":"string"},"kindIndex":{"type":"number"},"eventId":{"type":"string"},"syncState":{"type":"string"},"blueprint":{"type":"string"},"metrics":{"type":"object","properties":{"phase":{"type":"object","properties":{"resync":{"type":"object","properties":{"duration_seconds":{"type":"number"},"success":{"type":"number"}},"additionalProperties":false},"load":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"extract":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"transform":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false},"delete":{"type":"object","properties":{"object_count_type":{"type":"object","properties":{"skipped":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"failed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"loaded":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"raw_extracted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"transformed":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"filtered_out":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false},"deleted":{"type":"object","properties":{"object_count":{"type":"number"}},"required":["object_count"],"additionalProperties":false}},"additionalProperties":false}},"required":["object_count_type"],"additionalProperties":false}},"additionalProperties":false}},"required":["phase"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["integrationType","integrationIdentifier","integrationVersion","oceanVersion","kindIdentifier","kind","eventId","syncState","metrics","createdAt","updatedAt"],"additionalProperties":false}}},"required":["ok","count","data"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false}}}},"404":null,"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"}},"required":["ok","error"],"additionalProperties":false}}}}}
6666
>
6767

6868
</StatusCodes>

‎static/apispec.yaml‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20050,7 +20050,7 @@ paths:
2005020050
properties:
2005120051
identifier:
2005220052
type: string
20053-
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/=-]+$
20053+
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:=-]+$
2005420054
description: The identifier of the action.
2005520055
title:
2005620056
type: string
@@ -33230,7 +33230,7 @@ paths:
3323033230
- message
3323133231
additionalProperties: false
3323233232
description: The json provided does not match the route's schema
33233-
"/v1/integration/{integrationInternalId}/syncMetrics":
33233+
/v1/integration/{integrationInternalId}/syncMetrics:
3323433234
get:
3323533235
summary: Get an integration's metrics and sync status
3323633236
description: This route allows you to get a specific integration's metrics and sync status either the latest one or for a specific resync.<br/><br/>It returns the sync's execution status and detailed metrics per kind for each phase of the sync.<br/> For example, the number of fetched objects in the sync's fetch phase, number of objects that were mapped in the mapping phase, etc.<br/><br/>To learn more about integrations, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/).
@@ -33615,7 +33615,24 @@ paths:
3361533615
- ok
3361633616
- error
3361733617
additionalProperties: false
33618-
"500":
33618+
"404":
33619+
description: Default Response
33620+
content:
33621+
application/json:
33622+
schema:
33623+
type: object
33624+
properties:
33625+
ok:
33626+
type: boolean
33627+
error:
33628+
type: string
33629+
message:
33630+
type: string
33631+
required:
33632+
- ok
33633+
- error
33634+
additionalProperties: false
33635+
"500":
3361933636
description: Default Response
3362033637
content:
3362133638
application/json:

0 commit comments

Comments
 (0)