deprecate: Uploading JSON in API v2 #394
Conversation
✅ Deploy Preview for luxury-shortbread-acee05 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| In addition, the [upload endpoint](/docs/api-reference/indexing-apis/file-upload/file-upload) supports | ||
| sending semi-structured documents through this endpoint that reflect a | ||
| `Document` proto message. Those can be sent in the following formats: | ||
| In API v1, the upload endpoint supports sending semi-structured documents through |
There was a problem hiding this comment.
Generally I think we should limit our references to prior versions to the context of migrating or otherwise dealing with a breaking change. It's not clear to me if that's the context in this case. What is the context of this reference to v1?
There was a problem hiding this comment.
It's gRPC-specific so I'll make it more clear! I'll also add a note about using the Indexing API for v2.
| desired. However, if you aren't certain as to the section numbers and/or if | ||
| you uploaded documents using the | ||
| [file upload API](/docs/api-reference/indexing-apis/file-upload/format-for-upload), then you might need | ||
| desired. However, if you aren't certain as to the section numbers and/or if |
There was a problem hiding this comment.
I think it makes sense to treat API names as proper nouns to make them easier to identify, e.g. "File Upload API". WDYT?
www/docs/migration-guide-api-v2.md
Outdated
| @@ -171,6 +171,16 @@ changes carefully and the action items to use the V2 endpoints. | |||
| **Action items:** Update your indexing requests to use the new unified endpoint, | |||
| specifying the document `type` in the request body. | |||
|
|
|||
| ### File upload changes | |||
|
|
|||
| * API v1 has a file upload endpoint that lets you upload JSON files. | |||
There was a problem hiding this comment.
I think it would be clearer to name the API directly like this:
- File Upload API v1 supports uploading JSON files.
- File Upload API v2 removes support for uploading JSON files. Use the Indexing API v2 instead, if you need to index JSON files.
Updated the migration guide