You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2022/08/24 11:10:12 UTC

[GitHub] [ignite-3] PakhomovAlexander commented on a diff in pull request #1028: IGNITE-16969 Add developer documentation to REST modules

PakhomovAlexander commented on code in PR #1028:
URL: https://github.com/apache/ignite-3/pull/1028#discussion_r953660418


##########
modules/rest-api/README.md:
##########
@@ -0,0 +1,30 @@
+# ignite-rest-api
+
+This module defines REST API's that might be provided by Ignite 3. Also, common
+DTOs and error handlers are defined.
+
+## API definition
+
+The API definition is a java interface annotated with micronaut `@Controller`  
+annotations and several `swagger-annotations`. All those annotations are 
+needed to generate a valid [Open API spec](todo) from these interfaces.

Review Comment:
   Oh, my fault.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org