Skip to content
This repository was archived by the owner on Jan 9, 2025. It is now read-only.

feat: add description field to connectors #133

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Mar 4, 2024

Because

  • Component page includes a short description of the component.

This commit

  • Updates protogen-go to use the new description field in the connector
    entity in protobufs.
  • Adds a description field in the connector definitions.

@jvallesm jvallesm self-assigned this Mar 4, 2024
Copy link

linear bot commented Mar 4, 2024

@jvallesm jvallesm force-pushed the jvalles/ins-3809-fix-update-readme-template-for-a-consistent-description branch from 28a2c46 to 4058cc5 Compare March 4, 2024 08:27
Copy link

codecov bot commented Mar 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.18%. Comparing base (46c16b3) to head (043fcf6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #133   +/-   ##
=======================================
  Coverage   62.18%   62.18%           
=======================================
  Files          18       18           
  Lines        1489     1489           
=======================================
  Hits          926      926           
  Misses        440      440           
  Partials      123      123           
Flag Coverage Δ
unittests 62.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jvallesm jvallesm marked this pull request as ready for review March 4, 2024 09:48
@jvallesm
Copy link
Collaborator Author

jvallesm commented Mar 4, 2024

✅ QA

$ curl --request GET \
  --url "localhost:8080/vdp/v1beta/component-definitions?page_size=25" \
  --header 'accept: application/json' | jq '.component_definitions[] | if .type == "COMPONENT_TYPE_OPERATOR" then .operator_definition  else .connector_definition end | {name: .name, description: .description}'
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 21212    0 21212    0     0   548k      0 --:--:-- --:--:-- --:--:--  559k
{
  "name": "connector-definitions/stability-ai",
  "description": "Connect the AI models served on the Stability AI Platform"
}
{
  "name": "connector-definitions/instill-model",
  "description": "Connect the AI models served on the Instill Model Platform"
}
{
  "name": "connector-definitions/hugging-face",
  "description": "Connect the AI models served on the Hugging Face Platform"
}
{
  "name": "connector-definitions/openai",
  "description": "Connect the AI models served on the OpenAI Platform"
}
{
  "name": "connector-definitions/archetype-ai",
  "description": "Connect the AI models served on the Archetype AI Platform"
}
{
  "name": "connector-definitions/numbers",
  "description": "Seamlessly integrate third-party blockchain services through the Numbers Protocol, providing security, verifiability and traceability to data management"
}
{
  "name": "connector-definitions/airbyte-destination",
  "description": "Leverage the power of Airbyte and its 30+ destination connectors to facilitate data movement and transformation"
}
{
  "name": "connector-definitions/bigquery",
  "description": "Insert data to BigQuery tables"
}
{
  "name": "connector-definitions/gcs",
  "description": "Upload data to Google's Cloud Storage"
}
{
  "name": "connector-definitions/google-search",
  "description": "Leverage the Google Search engine"
}
{
  "name": "connector-definitions/pinecone",
  "description": "Build and search vector datasets"
}
{
  "name": "connector-definitions/redis",
  "description": "Manage data in NoSQL Redis databases"
}
{
  "name": "connector-definitions/restapi",
  "description": "Make requests to external REST APIs"
}
{
  "name": "connector-definitions/website",
  "description": "Scrape websites"
}
{
  "name": "operator-definitions/base64",
  "description": "Encode or decode a string in Base64 format"
}
{
  "name": "operator-definitions/start",
  "description": "Define data formats customized for their AI-first applications"
}
{
  "name": "operator-definitions/end",
  "description": "Create an output interface in a pipeline when triggered synchronously"
}
{
  "name": "operator-definitions/json",
  "description": "Manipulate and convert JSON objects"
}
{
  "name": "operator-definitions/image",
  "description": "Manipulate image files"
}
{
  "name": "operator-definitions/text",
  "description": "Extract and manipulate text from different sources"
}

@jvallesm jvallesm merged commit 00178f4 into main Mar 4, 2024
@jvallesm jvallesm deleted the jvalles/ins-3809-fix-update-readme-template-for-a-consistent-description branch March 4, 2024 11:20
donch1989 pushed a commit that referenced this pull request Mar 12, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.14.0-beta](v0.13.0-beta...v0.14.0-beta)
(2024-03-12)


### Features

* add description field to connectors
([#133](#133))
([00178f4](00178f4))
* adopt the new GetConnectorDefinition function interface
([#135](#135))
([140fe8f](140fe8f))
* **huggingface:** mark "model" field as required
([#136](#136))
([f6c0087](f6c0087))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants