Skip to content
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

feat: expose description field in component entities #62

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Mar 4, 2024

Because

  • Component page includes a short description of the component.
  • operator and connector descriptions were added / updated to use the imperative tense

This commit

  • Includes the latest version of protogen-go, which exposes the description field. This will be automatically loaded from definitions.json
  • Adds a minor optimization that sets the capacity component list slices, avoiding potential reallocations as the list grows.
  • Updates the compogen readme template to use the descriptions in imperative tense.

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

linear bot commented Mar 4, 2024

Copy link

codecov bot commented Mar 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.25%. Comparing base (a2a319d) to head (2241070).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #62      +/-   ##
==========================================
+ Coverage   46.15%   46.25%   +0.09%     
==========================================
  Files           6        6              
  Lines        1118     1120       +2     
==========================================
+ Hits          516      518       +2     
  Misses        513      513              
  Partials       89       89              
Flag Coverage Δ
unittests 46.25% <100.00%> (+0.09%) ⬆️

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 08:51
@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"
}

Copy link
Member

@donch1989 donch1989 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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


##
[0.13.0-beta](v0.12.0-beta...v0.13.0-beta)
(2024-03-07)


### Features

* expose description field in component entities
([#62](#62))
([85bbc22](85bbc22))
* simplify `openapi_specifications` to `data_specifications`
([#64](#64))
([7c27d15](7c27d15))


### Bug Fixes

* **vdp:** better casting errors
([#65](#65))
([81e34c4](81e34c4))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
namwoam pushed a commit to namwoam/component that referenced this pull request Jun 24, 2024
Because

- Component page includes a short description of the component.
- `operator` and `connector` descriptions were added / updated to use
the imperative tense

This commit

- Includes the latest version of `protogen-go`, which exposes the
`description` field. This will be automatically loaded from
`definitions.json`
- Adds a minor optimization that sets the capacity component list
slices, avoiding potential reallocations as the list grows.
- Updates the `compogen readme` template to use the descriptions in
imperative tense.
namwoam pushed a commit to namwoam/component that referenced this pull request Jun 24, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.13.0-beta](instill-ai/component@v0.12.0-beta...v0.13.0-beta)
(2024-03-07)


### Features

* expose description field in component entities
([instill-ai#62](instill-ai#62))
([85bbc22](instill-ai@85bbc22))
* simplify `openapi_specifications` to `data_specifications`
([instill-ai#64](instill-ai#64))
([7c27d15](instill-ai@7c27d15))


### Bug Fixes

* **vdp:** better casting errors
([instill-ai#65](instill-ai#65))
([81e34c4](instill-ai@81e34c4))

---
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 join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
3 participants