gerlowskija commented on code in PR #2219:
URL: https://github.com/apache/solr/pull/2219#discussion_r1469903877
##########
dev-docs/apis.adoc:
##########
@@ -51,27 +51,28 @@ Separating the API "definition" and "implementation" in
this way allows us to on
Writing a new v2 API may appear daunting, but additions in reality are
actually pretty simple:
-1. *Create POJO ("Plain Old Java Object") classes as needed to represent the
API's request and response*:
+1. *Agree on Endpoint Syntax*: Before implementing, developers should generate
consensus around what the new API will look like. General guidelines and
conventions for the v2 API syntax are described
<<v2-api-conventions.adoc,here>>.
Review Comment:
It definitely works in adoc. The question I'd ask though is whether Github
is smart enough to do it as well when it's previewing these asciidoc files.
That's the main way we expect these to be consumed, right? Through the
Github UI? (i.e. we don't actually build these asciidoc files into any thing
analogous to the ref-guide?)
I'll push the change and see how Github handles it; if GH doesn't
do-the-right-thing I'll revert.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
