You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Cassandra Targett (JIRA)" <ji...@apache.org> on 2016/11/01 13:16:58 UTC

[jira] [Commented] (SOLR-9709) update http://wiki.apache.org/solr/SolJSON 'JSON specific parameters' section

    [ https://issues.apache.org/jira/browse/SOLR-9709?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15625411#comment-15625411 ] 

Cassandra Targett commented on SOLR-9709:
-----------------------------------------

The JSON response writer is lightly documented in the Solr Ref Guide (https://cwiki.apache.org/confluence/display/solr/Response+Writers#ResponseWriters-JSONResponseWriter). It's missing the parameters and some other information, which has been on the Ref Guide TODO list for a very long time.

Adding the new params to the Solr Wiki perpetuates the problem of documentation in 2 places. I suggest that a more complete resolution to this is to migrate the missing content from the Solr Wiki to the Ref Guide and turn the Solr Wiki page into a stub as outlined here: https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-Migrating"Official"DocumentationfromMoinMoin. That would help with the overall migration process, which has been stalled for a long time but is still a major issue with documentation.

> update http://wiki.apache.org/solr/SolJSON 'JSON specific parameters' section
> -----------------------------------------------------------------------------
>
>                 Key: SOLR-9709
>                 URL: https://issues.apache.org/jira/browse/SOLR-9709
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: Response Writers
>            Reporter: Christine Poerschke
>            Priority: Minor
>
> Currently http://wiki.apache.org/solr/SolJSON#JSON_specific_parameters documents
> * json.nl=flat
> * json.nl=map
> * json.nl=arrarr
> but choices
> * json.nl=arrmap
> * json.nl=arrnvp
> are not documented.
> This ticket is to document {{json.nl=arrnvp}} added by SOLR-9442 and also {{json.nl=arrmap}} which already exists.
> link to relevant code: [JSONResponseWriter.java#L85-L89|https://github.com/apache/lucene-solr/blob/master/solr/core/src/java/org/apache/solr/response/JSONResponseWriter.java#L85-L89]



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org