-
Notifications
You must be signed in to change notification settings - Fork 106
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Description
To improve the documentation of each API method, we should add a corresponding documentation URL. This will help clients better understand the APIs when using them in projects.
Reference: https://www.meilisearch.com/docs/reference/api/overview
Important note: Only add API references to interface methods.
Example
// CreateIndex creates a new index.
//
// docs: https://www.meilisearch.com/docs/reference/api/indexes#create-an-index
CreateIndex(config *IndexConfig) (*TaskInfo, error)
// CreateIndexWithContext creates a new index with a context for cancellation.
//
// docs: https://www.meilisearch.com/docs/reference/api/indexes#create-an-index
CreateIndexWithContext(ctx context.Context, config *IndexConfig) (*TaskInfo, error)Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed