update /v1/ root page api docs
closes
@@ -125,13 +125,32 @@ func setupMiscHandlers(api *operations.WeaviateAPI, serverConfig *config.Weaviat
DocumentationHref: "https://www.semi.technology/documentation/weaviate/current/features/contextual-classification.html,https://www.semi.technology/documentation/weaviate/current/features/knn-classification.html",
},
&models.Link{
- Name: "search contextionary for concepts",
- Href: fmt.Sprintf("%s/v1/c11y/concepts/:concept", origin),
+ Name: "check if Weaviate is live (returns 200 on GET when live)",
+ Href: fmt.Sprintf("%s/v1/.well-known/live", origin),
+ DocumentationHref: "https://www.semi.technology/developers/weaviate/current/restful-api-references/well-known.html",
+ },
+ &models.Link{
+ Name: "check if Weaviate is ready (returns 200 on GET when ready)",
+ Href: fmt.Sprintf("%s/v1/.well-known/ready", origin),
+ DocumentationHref: "https://www.semi.technology/developers/weaviate/current/restful-api-references/well-known.html",
+ },
+ &models.Link{
+ Name: "view link to openid configuration (returns 404 on GET if no openid is configured)",
+ Href: fmt.Sprintf("%s/v1/.well-known/openid-configuration", origin),
+ DocumentationHref: "https://www.semi.technology/developers/weaviate/current/restful-api-references/well-known.html",
+ },
+
+ // TODO: part of the text2vec-contextionary module
+ &models.Link{
+ Name: "search contextionary for concepts (part of the text2vec-contextionary module)",
+ Href: fmt.Sprintf("%s/v1/modules/text2vec-contextionary/concepts/:concept", origin),
DocumentationHref: "https://www.semi.technology/documentation/weaviate/current/features/adding-synonyms.html",
},
+
+ // TODO: part of the text2vec-contextionary module
&models.Link{
- Name: "extend contextionary with custom extensions",
- Href: fmt.Sprintf("%s/v1/c11y/extensions", origin),
+ Name: "extend contextionary with custom extensions (part of the text2vec-contextionary module)",
+ Href: fmt.Sprintf("%s/v1/modules/text2vec-contextionary/extensions", origin),
DocumentationHref: "https://www.semi.technology/documentation/weaviate/current/features/adding-synonyms.html",
},
},
