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

Platform API ref follow-on updates, part 1 #404

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

Paul-Cornell
Copy link
Collaborator

@Paul-Cornell Paul-Cornell commented Dec 18, 2024

There were several errors in the Platform API reference docs that I just published, now that I'm able to actually fully test the production endpoints. The biggest ones in this first follow-on PR are:

  • The URL to call the API is slightly off: https:// instead of http://. Switching from HTTP to HTTPS was a relatively last-minute back-end update. In the meantime, our more tech-savvy customers should be able to figure this out.
  • Instructions for changing (not creating) source and destination connectors are wrong, as name and type should not be specified. In the meantime, customers might be able to figure this out by cross-referencing the Swagger UI, but this is certainly not intuitive.
  • Some of the query parameters for listing workflows are wrong. In the meantime, customers might be able to figure this out by cross-referencing the Swagger UI, but this is certainly not intuitive.
  • Instructions for creating workflows are wrong, specifically around setting repeating workflow run schedules. In the meantime, customers might be able to figure this out by cross-referencing the Swagger UI, but this is certainly not intuitive.

(The second follow-on PR, of a slightly lower priority, is to backfill instructions for creating some of the source and destination connectors that are missing, as these connectors were brought online just a few days ago. The field names for these connectors do not match 1:1 with the related labels in the UI, and they are not exposed in the Swagger UI either, so without these docs it will be almost impossible to figure them out. These are; sources: Couchbase, Dropbox, Elasticsearch, Google Drive, and Salesforce; and destinations: Destinations: Couchbase, PostgreSQL, and Qdrant.)

@Paul-Cornell Paul-Cornell merged commit 19f9547 into main Dec 18, 2024
1 check passed
@Paul-Cornell Paul-Cornell deleted the platform-api-2024-12-18 branch December 18, 2024 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants