Skip to content

Commit

Permalink
fix: documentation generation bug for connector actions with Aisle En…
Browse files Browse the repository at this point in the history
…dpoints configured
  • Loading branch information
itsnedhir committed Dec 2, 2024
1 parent 3f951d0 commit d6bd087
Show file tree
Hide file tree
Showing 53 changed files with 172 additions and 76 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **archived** 'job(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ AD-MEN
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **archived** 'profile(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **created** 'job(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ AD-MEN
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **created** 'profile(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **updated** 'job(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ AD-MEN
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Send **updated** 'profile(s)' _from_ AD-MEN _to_ HrFlow
| `db_user` :red_circle: | `string` | None | The username to connect to the database |
| `db_password` :red_circle: | `string` | None | The password to connect to the database |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **archived** 'job(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **archived** 'profile(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **created** 'job(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **created** 'profile(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **updated** 'job(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Send **updated** 'profile(s)' _from_ Bullhorn _to_ HrFlow
| `password` :red_circle: | `string` | None | Password for Bullhorn login |
| `username` :red_circle: | `string` | None | Username for Bullhorn login |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **archived** 'profile(s)' _from_ Hubspot _to_ HrFlow
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ Hubspot
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **created** 'profile(s)' _from_ Hubspot _to_ HrFlow
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ Hubspot
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **updated** 'profile(s)' _from_ Hubspot _to_ HrFlow
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ Hubspot
| ----- | ---- | ------- | ----------- |
| `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **archived** 'job(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **archived** 'profile(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ Recruitee
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **created** 'job(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **created** 'profile(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ Recruitee
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **updated** 'job(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **updated** 'profile(s)' _from_ Recruitee _to_ HrFlow
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ Recruitee
| `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. |
| `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
23 changes: 12 additions & 11 deletions src/hrflow_connectors/v2/connectors/smartrecruiters/aisles.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
SmartRecruitersProfile,
)
from hrflow_connectors.v2.core.common import Entity
from hrflow_connectors.v2.core.warehouse import ( # Endpoints,
from hrflow_connectors.v2.core.warehouse import (
Aisle,
Criterias,
Endpoint,
Endpoints,
ReadOperation,
WriteOperation,
merge,
Expand Down Expand Up @@ -460,11 +461,11 @@ def delete_profiles(
update=read_profiles,
archive=read_profiles,
),
# endpoints=Endpoints(
# create=GET_CANDIDATE_ENDPOINT,
# update=GET_CANDIDATE_ENDPOINT,
# archive=GET_CANDIDATE_ENDPOINT,
# ),
endpoints=Endpoints(
create=GET_CANDIDATE_ENDPOINT,
update=GET_CANDIDATE_ENDPOINT,
archive=GET_CANDIDATE_ENDPOINT,
),
),
write=WriteOperation(
criterias=Criterias(
Expand All @@ -477,10 +478,10 @@ def delete_profiles(
update=update_profiles,
archive=delete_profiles,
),
# endpoints=Endpoints(
# create=POST_CANDIDATE_ENDPOINT,
# update=UPDATE_CANDIDATE_ENDPOINT,
# archive=DELETE_CANDIDATE_ENDPOINT,
# ),
endpoints=Endpoints(
create=POST_CANDIDATE_ENDPOINT,
update=UPDATE_CANDIDATE_ENDPOINT,
archive=DELETE_CANDIDATE_ENDPOINT,
),
),
)
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **archived** 'job(s)' _from_ SmartRecruiters _to_ HrFlow
| ----- | ---- | ------- | ----------- |
| `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
Send **archived** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow


**SmartRecruiters endpoint used :**
| Endpoint | Description |
| --------- | ----------- |
| [**Get candidate**](https://developers.smartrecruiters.com/reference/candidatesget-1) | Endpoint to get the content of a candidate with a given id, a candidateId parameter is required, the request method is `GET` |



## SmartRecruiters Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ SmartRecruiters



**SmartRecruiters endpoint used :**
| Endpoint | Description |
| --------- | ----------- |
| [**Delete Candidate**](https://developers.smartrecruiters.com/reference/candidatesdelete-1) | Endpoint to delete a candidate with a given id, a candidateId parameter is required, the request method is `DELETE` |


## SmartRecruiters Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Send **created** 'job(s)' _from_ SmartRecruiters _to_ HrFlow
| ----- | ---- | ------- | ----------- |
| `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
Send **created** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow


**SmartRecruiters endpoint used :**
| Endpoint | Description |
| --------- | ----------- |
| [**Get candidate**](https://developers.smartrecruiters.com/reference/candidatesget-1) | Endpoint to get the content of a candidate with a given id, a candidateId parameter is required, the request method is `GET` |



## SmartRecruiters Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API |

## HrFlow Auth Parameters
## HrFlow.ai Auth Parameters

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
Expand Down
Loading

0 comments on commit d6bd087

Please sign in to comment.