Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Update ConnectionSystemTypeMap Endpoint to return Human-Readable Version #1096

Closed
pattisdr opened this issue Aug 16, 2022 · 1 comment · Fixed by #1297
Closed

Update ConnectionSystemTypeMap Endpoint to return Human-Readable Version #1096

pattisdr opened this issue Aug 16, 2022 · 1 comment · Fixed by #1297
Assignees
Labels

Comments

@pattisdr
Copy link
Contributor

pattisdr commented Aug 16, 2022

Is your feature request related to a specific problem?

In our connection type endpoint (which returns the types of connectors we support out of the box), return a version of the connection with proper casing. We currently only return our internal identifier, not a version that has the proper casing of the service.

For example, we have "hubspot", but we also would like "HubSpot".

GET "/connection_type"

{
    "items": [
        {
            "identifier": "bigquery",
            "type": "database"
        },
        {
            "identifier": "mariadb",
            "type": "database"
        },
        {
            "identifier": "mongodb",
            "type": "database"
        },
        {
            "identifier": "mssql",
            "type": "database"
        },
        {
            "identifier": "mysql",
            "type": "database"
        },
        {
            "identifier": "postgres",
            "type": "database"
        },
        {
            "identifier": "redshift",
            "type": "database"
        },
        {
            "identifier": "snowflake",
            "type": "database"
        },
        {
            "identifier": "adobe_campaign",
            "type": "saas"
        },
        {
            "identifier": "auth0",
            "type": "saas"
        },
        {
            "identifier": "datadog",
            "type": "saas"
        },
        {
            "identifier": "hubspot",
            "type": "saas"
        },
        {
            "identifier": "mailchimp",
            "type": "saas"
        },
        {
            "identifier": "outreach",
            "type": "saas"
        },
        {
            "identifier": "salesforce",
            "type": "saas"
        },
        {
            "identifier": "segment",
            "type": "saas"
        },
        {
            "identifier": "sendgrid",
            "type": "saas"
        },
        {
            "identifier": "sentry",
            "type": "saas"
        },
        {
            "identifier": "stripe",
            "type": "saas"
        },
        {
            "identifier": "zendesk",
            "type": "saas"
        }
    ],
    "total": 21,
    "page": 1,
    "size": 50
}

Describe the solution you'd like

  • Start storing a human readable version of this, this could be an enum, it could be stored in the yaml, etc., for both database and saas connectors.
  • Start returning this information in the connection type endpoint

Describe alternatives you've considered, if any

A description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

@pattisdr pattisdr added the enhancement New feature or request label Aug 16, 2022
@pattisdr pattisdr self-assigned this Sep 7, 2022
@pattisdr
Copy link
Contributor Author

pattisdr commented Sep 7, 2022

@chriscalhoun1974 has asked for this a few times, adding it to the current sprint:

add an additional attribute to the api/v1/connection_type API endpoint payload called name or description? This new attribute would be a more friendly connector name (i.e. HubSpot). Currently, I am using the identifier which is the enum value and in lowercase.

sanders41 pushed a commit that referenced this issue Sep 13, 2022
* Expose a human readable name in the connection type endpoints.

Add a human_readable_name to the saas connector registry and a separate human readable mapping for ConnectionTypes.

* Update changelog and connection type endpoint docs.

* mypy

* Update ConnectorTemplate test.

* Mypy

* Update tests/ops/models/test_connectionconfig.py

Co-authored-by: Paul Sanders <paul@ethyca.com>

Co-authored-by: Paul Sanders <paul@ethyca.com>
sanders41 pushed a commit that referenced this issue Sep 22, 2022
* Expose a human readable name in the connection type endpoints.

Add a human_readable_name to the saas connector registry and a separate human readable mapping for ConnectionTypes.

* Update changelog and connection type endpoint docs.

* mypy

* Update ConnectorTemplate test.

* Mypy

* Update tests/ops/models/test_connectionconfig.py

Co-authored-by: Paul Sanders <paul@ethyca.com>

Co-authored-by: Paul Sanders <paul@ethyca.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants