From e4ae949b34e3c5ea3a56c2284d7133b5e9ef7353 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADt=20Baisa?= <xbaisa@fi.muni.cz> Date: Thu, 13 Jun 2024 09:50:11 +0200 Subject: [PATCH] * commit --- docs/tech/api/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tech/api/overview.md b/docs/tech/api/overview.md index e08e420..ed7db03 100644 --- a/docs/tech/api/overview.md +++ b/docs/tech/api/overview.md @@ -1,13 +1,13 @@ The INJECT API is designed to facilitate communication between the frontend and backend components of the INJECT Exercise Platform (IXP). It enables clients to perform various operations, including data retrieval, manipulation, and real-time updates. -### GraphQL API +## GraphQL API The GraphQL API provides a flexible and efficient way to interact with the IXP. It allows clients to query specific data fields, reducing over-fetching. The GraphQL documentation will provide detailed information about the available queries, mutations, and subscriptions, along with examples and usage guidelines. -### REST API +## REST API The REST API complements the GraphQL API by providing additional functionality and support for file transfers and other operations not supported by GraphQL. The [REST documentation](swagger-docs.md) covers endpoints, request methods, parameters, and response formats, offering comprehensive guidance for integrating with the IXP. -- GitLab