You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by GitBox <gi...@apache.org> on 2021/04/23 16:32:24 UTC
[GitHub] [solr] epugh opened a new pull request #91: SOLR-11646: v2 api documentation round three
epugh opened a new pull request #91:
URL: https://github.com/apache/solr/pull/91
# Description
Round three of adding v2 api equivalents to ref guide.
# Solution
writing!
# Tests
manual testing
# Checklist
Please review the following and check all that apply:
- [ X] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ X] I have created a Jira issue and added the issue ID to my pull request title.
- [ X] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [ X] I have developed this patch against the `main` branch.
- [ X] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [ X] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r644701396
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json' -d'
Review comment:
[0] I think you're missing a space between `-d` and the single-quote that starts the request-body, which I think would fail the command?
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
[+1] Good thought to standardize on techproducts here!
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -844,12 +827,27 @@ If `multiValued` is defined as either true or false (most likely true), that wil
==== List Fields Examples
-Get a list of all fields.
+[.dynamic-tabs]
+--
+[example.tab-pane#v1list-fields]
+====
+[tab-label]*V1 API*
+[source,bash]
+----
+http://localhost:8983/techproducts/schema/fields
+----
+====
+[example.tab-pane#v2list-fields]
+====
+[tab-label]*V2 API*
[source,bash]
----
-curl http://localhost:8983/solr/gettingstarted/schema/fields
+
+curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fields?wt=json"
Review comment:
[Q] Is the `wt=json` here redundant, or does the schema API really return something other than JSON by default?
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -118,7 +201,33 @@ http://localhost:8983/solr/admin/cores?action=CREATE&name=my_core&collection=my_
The RELOAD action loads a new core from the configuration of an existing, registered Solr core. While the new core is initializing, the existing one will continue to handle requests. When the new Solr core is ready, it takes over and the old core is unloaded.
-`admin/cores?action=RELOAD&core=_core-name_`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-reload]
+====
+[.tab-label]*V1 API*
+
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=RELOAD&core=techproducts
+
+----
+====
+
+[example.tab-pane#v2coreadmin-reload]
+====
+[.tab-label]*V2 API*
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores/techproducts -H 'Content-Type: application/json' -d'
Review comment:
[0] I think you're missing a space between `-d` and the single-quote that starts the request-body, which I think would fail the command?
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
[0] The way I read SOLR-15372, it's specific to configuration used by our techproducts example. Is that right?
I know we mention that these commands assume the "techproducts" example, but it still seems weird to mention this bug here. Only 1% of readers are going to be "following along " with a techproducts example locally, and I'd hate for users to think that there's some bug with core-creation generally.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r645101097
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
I end up using techproducts a lot to test things, and a way to learn about the apis. As long as you are okay (i.e -0) with it, then I'll leave it with techproducts. Thanks for the comment Cassandra!
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r645100024
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
I've tried a couple of workarounds, and no joy, so just going to take out the comment, and leave it...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r644701396
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json' -d'
Review comment:
[0] I think you're missing a space between `-d` and the single-quote that starts the request-body, which I think would fail the command?
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
[+1] Good thought to standardize on techproducts here!
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -844,12 +827,27 @@ If `multiValued` is defined as either true or false (most likely true), that wil
==== List Fields Examples
-Get a list of all fields.
+[.dynamic-tabs]
+--
+[example.tab-pane#v1list-fields]
+====
+[tab-label]*V1 API*
+[source,bash]
+----
+http://localhost:8983/techproducts/schema/fields
+----
+====
+[example.tab-pane#v2list-fields]
+====
+[tab-label]*V2 API*
[source,bash]
----
-curl http://localhost:8983/solr/gettingstarted/schema/fields
+
+curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fields?wt=json"
Review comment:
[Q] Is the `wt=json` here redundant, or does the schema API really return something other than JSON by default?
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -118,7 +201,33 @@ http://localhost:8983/solr/admin/cores?action=CREATE&name=my_core&collection=my_
The RELOAD action loads a new core from the configuration of an existing, registered Solr core. While the new core is initializing, the existing one will continue to handle requests. When the new Solr core is ready, it takes over and the old core is unloaded.
-`admin/cores?action=RELOAD&core=_core-name_`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-reload]
+====
+[.tab-label]*V1 API*
+
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=RELOAD&core=techproducts
+
+----
+====
+
+[example.tab-pane#v2coreadmin-reload]
+====
+[.tab-label]*V2 API*
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores/techproducts -H 'Content-Type: application/json' -d'
Review comment:
[0] I think you're missing a space between `-d` and the single-quote that starts the request-body, which I think would fail the command?
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
[0] The way I read SOLR-15372, it's specific to configuration used by our techproducts example. Is that right?
I know we mention that these commands assume the "techproducts" example, but it still seems weird to mention this bug here. Only 1% of readers are going to be "following along " with a techproducts example locally, and I'd hate for users to think that there's some bug with core-creation generally.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r645063187
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json' -d'
Review comment:
it seems to work! We have 32 instances of `-d'` and 152 of `-d '` so I will put the space in...
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
I've tried a couple of workarounds, and no joy, so just going to take out the comment, and leave it...
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
I end up using techproducts a lot to test things, and a way to learn about the apis. As long as you are okay (i.e -0) with it, then I'll leave it with techproducts. Thanks for the comment Cassandra!
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -844,12 +827,27 @@ If `multiValued` is defined as either true or false (most likely true), that wil
==== List Fields Examples
-Get a list of all fields.
+[.dynamic-tabs]
+--
+[example.tab-pane#v1list-fields]
+====
+[tab-label]*V1 API*
+[source,bash]
+----
+http://localhost:8983/techproducts/schema/fields
+----
+====
+[example.tab-pane#v2list-fields]
+====
+[tab-label]*V2 API*
[source,bash]
----
-curl http://localhost:8983/solr/gettingstarted/schema/fields
+
+curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fields?wt=json"
Review comment:
I don't know why I thought I was getting xml! I really appreciate the eagle eyes...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] ctargett commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
ctargett commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r644746888
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
I agree with Jason. The Jira is only relevant to the example you've chosen to use, not the API, so the bug is completely irrelevant to the overall documentation of the API.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r645110145
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -844,12 +827,27 @@ If `multiValued` is defined as either true or false (most likely true), that wil
==== List Fields Examples
-Get a list of all fields.
+[.dynamic-tabs]
+--
+[example.tab-pane#v1list-fields]
+====
+[tab-label]*V1 API*
+[source,bash]
+----
+http://localhost:8983/techproducts/schema/fields
+----
+====
+[example.tab-pane#v2list-fields]
+====
+[tab-label]*V2 API*
[source,bash]
----
-curl http://localhost:8983/solr/gettingstarted/schema/fields
+
+curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fields?wt=json"
Review comment:
I don't know why I thought I was getting xml! I really appreciate the eagle eyes...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on pull request #91:
URL: https://github.com/apache/solr/pull/91#issuecomment-853490514
Okay, I think I'm done with the schema-api.adoc page.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] ctargett commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
ctargett commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r644750680
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
Meh, I'm frankly -0 on changing every example to use techproducts. Sure it's an example we've always shipped, but I also think it's very limited. Not that I have any suggestions for alternatives, I just think there are 100 other things I'd rather do in the docs than spend time on that.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on pull request #91:
URL: https://github.com/apache/solr/pull/91#issuecomment-853490514
Okay, I think I'm done with the schema-api.adoc page.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] ctargett commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
ctargett commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r644746888
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
Review comment:
I agree with Jason. The Jira is only relevant to the example you've chosen to use, not the API, so the bug is completely irrelevant to the overall documentation of the API.
##########
File path: solr/solr-ref-guide/src/schema-api.adoc
##########
@@ -112,7 +93,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{
"name":"sell_by",
"type":"pdate",
"stored":true }
-}' http://localhost:8983/solr/gettingstarted/schema
+}' http://localhost:8983/solr/techproducts/schema
Review comment:
Meh, I'm frankly -0 on changing every example to use techproducts. Sure it's an example we've always shipped, but I also think it's very limited. Not that I have any suggestions for alternatives, I just think there are 100 other things I'd rather do in the docs than spend time on that.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh merged pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh merged pull request #91:
URL: https://github.com/apache/solr/pull/91
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #91: SOLR-11646: v2 api documentation round three
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #91:
URL: https://github.com/apache/solr/pull/91#discussion_r645063187
##########
File path: solr/solr-ref-guide/src/coreadmin-api.adoc
##########
@@ -50,6 +94,45 @@ The `CREATE` action creates a new core and registers it.
If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded.
`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`
+[.dynamic-tabs]
+--
+[example.tab-pane#v1coreadmin-create]
+====
+[.tab-label]*V1 API*
+
+Assuming you are using an existing configSet to create your new core:
+[source,bash]
+----
+http://localhost:8983/solr/admin/cores?action=CREATE&&name=techproducts_v2&configSet=sample_techproducts_configs
+
+----
+
+If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like
+[source,bash]
+----
+admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data
+----
+====
+
+[example.tab-pane#v2coreadmin-create]
+====
+[.tab-label]*V2 API*
+
+Assumes SOLR-15372 is committed.
+
+[source,bash]
+----
+curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json' -d'
Review comment:
it seems to work! We have 32 instances of `-d'` and 152 of `-d '` so I will put the space in...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org