You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2016/12/09 15:58:55 UTC
[1/4] lucene-solr:apiv2: SOLR-8029: Update 'cluster' specs with
descriptions and links to docs
Repository: lucene-solr
Updated Branches:
refs/heads/apiv2 d26d694b2 -> a2486fd2d
SOLR-8029: Update 'cluster' specs with descriptions and links to docs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/bf89a7a4
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/bf89a7a4
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/bf89a7a4
Branch: refs/heads/apiv2
Commit: bf89a7a405138b39d91d4dc31a9a920e4ecf6ff3
Parents: d26d694
Author: Cassandra Targett <ct...@apache.org>
Authored: Wed Dec 7 15:20:37 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Wed Dec 7 15:20:37 2016 -0600
----------------------------------------------------------------------
.../src/resources/apispec/cluster.Commands.json | 20 +++++++++----------
.../apispec/cluster.configs.Commands.json | 8 ++++++--
.../apispec/cluster.configs.delete.json | 3 ++-
.../src/resources/apispec/cluster.configs.json | 3 ++-
solr/core/src/resources/apispec/cluster.json | 3 ++-
.../src/resources/apispec/cluster.nodes.json | 3 ++-
.../cluster.security.BasicAuth.Commands.json | 7 ++++---
...cluster.security.RuleBasedAuthorization.json | 21 ++++++++++----------
.../cluster.security.authentication.json | 3 ++-
.../apispec/cluster.security.authorization.json | 3 ++-
10 files changed, 43 insertions(+), 31 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.Commands.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.Commands.json b/solr/core/src/resources/apispec/cluster.Commands.json
index 41419e0..8983964 100644
--- a/solr/core/src/resources/apispec/cluster.Commands.json
+++ b/solr/core/src/resources/apispec/cluster.Commands.json
@@ -1,6 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API",
- "Description": "Cluster-wide commands",
+ "description": "Cluster-wide commands to assign roles to nodes, remove role assignments, or add, edit or remove a cluster-wide property.",
"methods": [
"POST"
],
@@ -12,17 +12,17 @@
"commands": {
"add-role":{
"type":"object",
- "documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api15AddRole",
- "description":"Add a specific role to a node in the cluster ",
+ "documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api15",
+ "description":"Assign a specific role to a node in the cluster.",
"properties": {
"role": {
"type": "string",
- "description": "The name of the role. The only supported role as of now is overseer."
+ "description": "The name of the role. The only supported role is 'overseer'."
},
"node": {
"type": "string",
- "description": "The name of the node. It is possible to assign a role even before that node is started"
+ "description": "The name of the node. It is possible to assign a role even before that node is started."
}
},
@@ -33,17 +33,17 @@
},
"remove-role":{
"type":"object",
- "documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api16RemoveRole",
- "description":"",
+ "documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api16",
+ "description":"Unassign a role from a node in the cluster.",
"properties": {
"role": {
"type": "string",
- "description": "The name of the role. The only supported role as of now is overseer."
+ "description": "The name of the role. The only supported role as of now is 'overseer'."
},
"node": {
"type": "string",
- "description": "The name of the node. It is possible to assign a role even before that node is started"
+ "description": "The name of the node where the role should be removed."
}
},
"required": [
@@ -54,7 +54,7 @@
"set-property": {
"type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api11",
- "description": "Add, edit or delete a cluster-wide property.",
+ "description": "Add, edit, or delete a cluster-wide property.",
"properties": {
"name": {
"type": "string",
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.configs.Commands.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.configs.Commands.json b/solr/core/src/resources/apispec/cluster.configs.Commands.json
index 305bf25..d026cd5 100644
--- a/solr/core/src/resources/apispec/cluster.configs.Commands.json
+++ b/solr/core/src/resources/apispec/cluster.configs.Commands.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API",
+ "description": "Create ConfigSets.",
"methods": [
"POST"
],
@@ -10,17 +11,20 @@
"commands": {
"create": {
"type" :"object",
+ "description": "Create a ConfigSet, based on another ConfigSet already in ZooKeeper.",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-create",
"properties": {
"name" :{
"type" :"string",
- "description" : "ConfigSet to be created"
+ "description" : "The name of the ConfigSet to be created."
},
"baseConfigSet":{
"type" : "string",
- "description" :"ConfigSet to copy as a base"
+ "description" :"The existing ConfigSet to copy as the basis for the new one."
},
"properties" : {
"type":"object",
+ "description": "Additional key-value pairs, in the form of 'ConfigSetProp.<key>=<value>', as needed. These properties will override the same properties in the base ConfigSet.",
"additionalProperties" : true
}
},
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.configs.delete.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.configs.delete.json b/solr/core/src/resources/apispec/cluster.configs.delete.json
index ae8dbc3..236d457 100644
--- a/solr/core/src/resources/apispec/cluster.configs.delete.json
+++ b/solr/core/src/resources/apispec/cluster.configs.delete.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-delete",
+ "description": "Delete ConfigSets. The name of the ConfigSet to delete must be provided as a path parameter.",
"methods": [
"DELETE"
],
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.configs.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.configs.json b/solr/core/src/resources/apispec/cluster.configs.json
index b3d8c23..9a1443a 100644
--- a/solr/core/src/resources/apispec/cluster.configs.json
+++ b/solr/core/src/resources/apispec/cluster.configs.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-list",
+ "description": "List all ConfigSets in the cluster.",
"methods": [
"GET"
],
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.json b/solr/core/src/resources/apispec/cluster.json
index 434e9d5..0ec5b96 100644
--- a/solr/core/src/resources/apispec/cluster.json
+++ b/solr/core/src/resources/apispec/cluster.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API",
+ "description": "General information about the cluster, including defined collections (with the 'cluster' endpoint), status of the overseer (with the 'cluster/overseer' endpoint), and available nodes (with the 'cluster/nodes' endpoint).",
"methods": [
"GET"
],
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.nodes.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.nodes.json b/solr/core/src/resources/apispec/cluster.nodes.json
index 310577e..f992f7f 100644
--- a/solr/core/src/resources/apispec/cluster.nodes.json
+++ b/solr/core/src/resources/apispec/cluster.nodes.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API",
+ "description": "Provides general information about the available nodes of the cluster.",
"methods": [
"GET"
],
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.security.BasicAuth.Commands.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.security.BasicAuth.Commands.json b/solr/core/src/resources/apispec/cluster.security.BasicAuth.Commands.json
index 36f5e75..da04c85 100644
--- a/solr/core/src/resources/apispec/cluster.security.BasicAuth.Commands.json
+++ b/solr/core/src/resources/apispec/cluster.security.BasicAuth.Commands.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Basic+Authentication+Plugin",
+ "description": "Modifies the configuration of Basic authentication, allowing you to add or remove users and their passwords.",
"methods": [
"POST"
],
@@ -11,11 +12,11 @@
"commands": {
"set-user": {
"type":"object",
- "description": "The set-user command allows you to add users and change their passwords",
+ "description": "The set-user command allows you to add users and change their passwords. Usernames and passwords are expressed as key-value pairs in a JSON object.",
"additionalProperties": true
},
"delete-user": {
- "description": "Delete a user or a list of users",
+ "description": "Delete a user or a list of users. Passwords do not need to be provided, simply list the users in a JSON array, separated by colons.",
"type":"string"
}
}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.security.RuleBasedAuthorization.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.security.RuleBasedAuthorization.json b/solr/core/src/resources/apispec/cluster.security.RuleBasedAuthorization.json
index 060b2ad..eb9a11c 100644
--- a/solr/core/src/resources/apispec/cluster.security.RuleBasedAuthorization.json
+++ b/solr/core/src/resources/apispec/cluster.security.RuleBasedAuthorization.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-Based+Authorization+Plugin",
+ "description": "Defines roles for accessing Solr, and assigns users to those roles. Use this API to change user authorizations to each of Solr's components.",
"methods": [
"POST"
],
@@ -11,16 +12,16 @@
"commands": {
"set-permission": {
"type":"object",
- "description": "create a new permission, overwrite an existing permission definition, or assign a pre-defined permission to a role.",
+ "description": "Create a new permission, overwrite an existing permission definition, or assign a pre-defined permission to a role.",
"properties": {
"name":{
"type":"string",
- "description":"The name of the permission. The name will be used to update or delete the permission later."
+ "description": "The name of the permission. The name will be used to update or delete the permission later."
},
"method":{
"type":"string",
"enum":["GET", "POST", "DELETE","PUT"],
- "description":"HTTP methods that are allowed for this permission. You could allow only GET requests, or have a role that allows PUT and POST requests. The method values that are allowed for this property are GET, POST, PUT, DELETE and HEAD."
+ "description": "HTTP methods that are allowed for this permission. You could allow only GET requests, or have a role that allows PUT and POST requests. The method values that are allowed for this property are GET, POST, PUT, DELETE and HEAD."
},
"collection":{
@@ -28,7 +29,7 @@
"items": {
"type": "string"
},
- "description":"The collection or collections the permission will apply to. When the path that will be allowed is collection-specific, such as when setting permissions to allow use of the Schema API, omitting the collection property will allow the defined path and/or method for all collections. However, when the path is one that is non-collection-specific, such as the Collections API, the collection value must be null."
+ "description":"The collection or collections the permission will apply to. When the path that will be allowed is collection-specific, such as when setting permissions to allow use of the Schema API, omitting the collection property will allow the defined path and/or method for all collections. However, when the path is one that is non-collection-specific, such as the Collections API, the collection value must be null. In this case, two permissions may need to be created; one for collection-specific API paths allowing access to all collections, and another for non-collection-specific paths defining no collection limitations."
},
"path":{
@@ -40,7 +41,7 @@
},
"index": {
"type": "integer",
- "description": "The index of the permission you wish to overwrite. Skip this if it is a new permission that should be created"
+ "description": "The index of the permission you wish to overwrite. Skip this if it is a new permission that should be created."
},
"before":{
"type": "integer",
@@ -49,7 +50,7 @@
"params":{
"type":"object",
"additionalProperties":true,
- "description":"The names and values of request parameters. This property can be omitted if all request parameters are allowed, but will restrict access only to the values provided if defined."
+ "description": "The names and values of request parameters. This property can be omitted if all request parameters are allowed, but will restrict access only to the values provided if defined."
},
"role": {
"type": "array",
@@ -79,7 +80,7 @@
"items": {
"type": "string"
},
- "description": "The collection or collections the permission will apply to. When the path that will be allowed is collection-specific, such as when setting permissions to allow use of the Schema API, omitting the collection property will allow the defined path and/or method for all collections. However, when the path is one that is non-collection-specific, such as the Collections API, the collection value must be null."
+ "description": "The collection or collections the permission will apply to. When the path that will be allowed is collection-specific, such as when setting permissions to allow use of the Schema API, omitting the collection property will allow the defined path and/or method for all collections. However, when the path is one that is non-collection-specific, such as the Collections API, the collection value must be null. In this case, two permissions may need to be created; one for collection-specific API paths allowing access to all collections, and another for non-collection-specific paths defining no collection limitations."
},
"path": {
"type":"array",
@@ -90,7 +91,7 @@
},
"index": {
"type": "integer",
- "description": "The index of the permission you wish to overwrite"
+ "description": "The index of the permission you wish to overwrite."
},
"before": {
"type": "integer",
@@ -120,7 +121,7 @@
},
"set-user-role": {
"type":"object",
- "description": "A single command allows roles to be mapped to users. To remove a user's permission, you should set the role to null. The key is always a user id and the value is one or more role names",
+ "description": "A single command allows roles to be mapped to users. To remove a user's permission, you should set the role to null. The key is always a user id and the value is one or more role names.",
"additionalProperties":true
}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.security.authentication.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.security.authentication.json b/solr/core/src/resources/apispec/cluster.security.authentication.json
index 332abea..48757c3 100644
--- a/solr/core/src/resources/apispec/cluster.security.authentication.json
+++ b/solr/core/src/resources/apispec/cluster.security.authentication.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Authentication+and+Authorization+Plugins",
+ "description": "Shows the configuration for authentication, including users, classes (type of authentication) and other parameters.",
"methods": [
"GET"
],
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bf89a7a4/solr/core/src/resources/apispec/cluster.security.authorization.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/cluster.security.authorization.json b/solr/core/src/resources/apispec/cluster.security.authorization.json
index 13741a4..da09f8a 100644
--- a/solr/core/src/resources/apispec/cluster.security.authorization.json
+++ b/solr/core/src/resources/apispec/cluster.security.authorization.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Authentication+and+Authorization+Plugins",
+ "description":"Shows the configuration for authorization, including the classes (type of authorization), permissions, user-roles, and other parameters.",
"methods": [
"GET"
],
[2/4] lucene-solr:apiv2: SOLR-8029: Modify schemaEdit specs;
add include file for analyzers
Posted by ct...@apache.org.
SOLR-8029: Modify schemaEdit specs; add include file for analyzers
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/cedc63d4
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/cedc63d4
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/cedc63d4
Branch: refs/heads/apiv2
Commit: cedc63d46e5aca384b8b34fbe7c51568ffbe671a
Parents: bf89a7a
Author: Cassandra Targett <ct...@apache.org>
Authored: Thu Dec 8 15:34:51 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Thu Dec 8 15:34:51 2016 -0600
----------------------------------------------------------------------
.../apispec/core.SchemaEdit.addField.json | 71 ++++++++++++++------
.../core.SchemaEdit.addFieldType.analyzers.json | 39 +++++++++++
.../apispec/core.SchemaEdit.addFieldType.json | 39 ++++++-----
.../src/resources/apispec/core.SchemaEdit.json | 1 +
4 files changed, 112 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/cedc63d4/solr/core/src/resources/apispec/core.SchemaEdit.addField.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addField.json b/solr/core/src/resources/apispec/core.SchemaEdit.addField.json
index 798b81b..d4a6996 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addField.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addField.json
@@ -3,65 +3,96 @@
"type":"object",
"properties":{
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The name of the field. Names should be alphanumeric or underscore characters only, and not start with a digit. Names also cannot begin and end with an underscore, as such field names are reserved by the system."
},
"type": {
- "type": "string"
+ "type": "string",
+ "description":"The name of the fieldType for this field."
},
"defaultValue": {
- "type": "string"
+ "type": "string",
+ "description": "An optional default value that should be added automatically to any document that does not have a value for this field."
},
"indexed": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, the field will be indexed and will be available for use in queries to retrieve matching documents. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true.",
+ "default": "true"
},
"stored": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, the actual value of the field can be retrieved by queries and be displayed in results. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true.",
+ "default":"true"
},
"omitNorms": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, length normalization and index-time boosting for a field are omitted from the index. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all primitive field types (such as dates, strings, boolean, and numeric fields), but will default to false for non-primitive field types."
},
"omitTermFreqAndPositions": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, all term frequency, positions, and payloads will not be indexed. This means that phrase queries, proximity queries and similar queries that rely on analysis of the frequency of a query term or the position of a term to other terms will not be supported. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all field types that are not text fields."
},
"termVectors": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, term vectors will be stored to be able to compute similarity between two documents. This is required to use More Like This. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. Do not enable this if using the PostingsHighlighter.",
+ "default": "false"
},
"termPositions": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, term positions will be stored for use with highlighting. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. Do not enable this if using the PostingsHighlighter.",
+ "default": "false"
},
"termOffsets": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, term offsets will be stored for use with highlighting. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. Do not enable this if using the PostingsHighlighter.",
+ "default": "false"
},
"multiValued": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, a single document can have multiple values in a single field, and these values will be indexed. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false.",
+ "default": "false"
},
"sortMissingFirst": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, when sorting by the field, any documents missing a value for the field will be placed at the top of the list. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. If sortMissingFirst and sortMissingLast are both false, documents missing this field will be placed at the top when sorting in ascending order (asc) or at the bottom when sorting in descending order (desc).",
+ "default": "false"
},
"sortMissingLast": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, when sorting by the field, any documents missing a value for the field will be placed at the bottom of the list. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. If sortMissingFirst and sortMissingLast are both false, documents missing this field will be placed at the top when sorting in ascending order (asc) or at the bottom when sorting in descending order (desc).",
+ "default": "false"
},
"required": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, any document that does not have a value for the field will be rejected. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false.",
+ "default": "false"
},
"omitPositions": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, information about the position of terms in a document will not be stored in the index, which means phrase queries, proximity queries, and similar will not be supported for this field. It is similar to 'omitTermFreqAndPositions', but 'omitPositions' will allow term frequency information to be stored. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all field types that are not text fields."
},
"storeOffsetsWithPositions": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, term offsets will be stored with positions in the postings list in the index. This is required if using the PostingsHighlighter. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false.",
+ "default": "false"
},
"docValues": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, field values will be stored in a column-oriented docValues structure. This can be more efficient for some fields, particularly those used for faceting. More information is available from https://cwiki.apache.org/confluence/display/solr/DocValues. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all non-text fields (such as dates, integers, longs, etc.)."
},
"termPayloads": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, term payloads will be stored for use with highlighting. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. Do not enable this if using the PostingsHighlighter.",
+ "default": "false"
},
"useDocValuesAsStored": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true and docValues are enabled for the field, the field will be returned when all fields are requested (using '*' with the fl parameter), even if it is not stored. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true.",
+ "default": "true"
}
},
"required": [
"name",
"type"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/cedc63d4/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
new file mode 100644
index 0000000..c2e6acf
--- /dev/null
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
@@ -0,0 +1,39 @@
+"class": {
+ "type": "string"
+},
+"tokenizer":{
+ "type":"object",
+ "properties":{
+ "class":{
+ "type":"string"
+ }
+ },
+ "required":["class"],
+ "additionalProperties":true
+},
+"charFilters":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "properties":{
+ "class":{
+ "type":"string"
+ }
+ },
+ "required":["class"],
+ "additionalProperties":true
+ }
+},
+"filters":{
+ "type":"array",
+ "items":{
+ "type":"object",
+ "properties":{
+ "class":{
+ "type":"string"
+ }
+ },
+ "required":["class"],
+ "additionalProperties":true
+ }
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/cedc63d4/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
index 0ed22ac..ff6213e 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
@@ -2,43 +2,45 @@
"type":"object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The name of the field type. This name is used when defining a field. It is strongly recommended that field type names consist only of alphanumeric or underscore characters and not start with a digit."
},
"class": {
- "type": "string"
+ "type": "string",
+ "description": "The class name to use for the field type. Class names do not need to be fully qualified if they are included with Solr, so instead of 'org.apache.solr.schema.TextField', you can abbreviate the name as 'solr.TextField'. Custom or third-party class names may need to be fully qualified, however."
},
"positionIncrementGap": {
- "type": "number"
+ "type": "number",
+ "description": "The distance between the values of a multivalued field. This is used to prevent inaccurate phrase matches across two separate values of the same field.",
+ "default": "0"
},
"autoGeneratePhraseQueries": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, phrase queries will automatically be generated for adjacent terms. If false, terms must also be enclosed in double-quotes to be treated as phrases.",
+ "default": "false"
},
"docValuesFormat": {
- "type": "string"
+ "type": "string",
+ "description": "Defines a custom DocValuesFormat to use for fields of this type. A custom DocValuesFormat requires that a schema-aware codec has also been configured in solrconfig.xml."
},
"postingsFormat": {
- "type": "string"
+ "type": "string",
+ "description": "Defines a custom PostingsFormat to use for fields of this type. A custom PostingsFormat requires that a schema-aware codec has also been configured in solrconfig.xml."
},
"queryAnalyzer": {
"type": "object",
- "properties": {
- "tokenizer": {
- "type": "object",
- "properties": {
- "class": {
- "type": "string"
- }
- },
- "additionalProperties": true
- }
- },
+ "description": "A query analyzer section defines how incoming queries to Solr will be analyzed for a field of this type.",
+ "properties":
+ {"#include":"core.SchemaEdit.addFieldType.analyzers.json"},
"additionalProperties": true
},
"indexAnalyzer": {
"type": "object",
+ "description": "An index analyzer section defines how incoming text in documents will be analyzed for a field of this type.",
"properties": {
"tokenizer": {
"type": "object",
+ "description": "",
"properties": {
"class": {
"type": "string"
@@ -51,6 +53,7 @@
},
"analyzer": {
"type": "object",
+ "description": "An analyzer defines how both incoming text in documents and queries are analyzed for a field of this type. If a query analyzer and an index analyzer have both been defined, a general analyzer does not need to be defined for this type.",
"properties": {
"class": {
"type": "string"
@@ -100,4 +103,4 @@
"name",
"class"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/cedc63d4/solr/core/src/resources/apispec/core.SchemaEdit.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.json b/solr/core/src/resources/apispec/core.SchemaEdit.json
index 682884f..bbf4082 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API",
+ "description": "The Schema API provides viewing, editing, adding, and deleting elements of Solr's schema. This API can only be used if Managed Schema is enabled and the schema is defined as mutable. See https://cwiki.apache.org/confluence/display/solr/Schema+Factory+Definition+in+SolrConfig for more information about enabling Managed Schema.",
"methods": [
"POST"
],
[4/4] lucene-solr:apiv2: Add descriptions for Schema APIs
Posted by ct...@apache.org.
Add descriptions for Schema APIs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/a2486fd2
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/a2486fd2
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/a2486fd2
Branch: refs/heads/apiv2
Commit: a2486fd2d38a5495939132b315ff202519a7dfbf
Parents: 8d8cd3c
Author: Cassandra Targett <ct...@apache.org>
Authored: Fri Dec 9 09:57:56 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Fri Dec 9 09:57:56 2016 -0600
----------------------------------------------------------------------
.../src/resources/apispec/core.RealtimeGet.json | 7 ++++---
.../apispec/core.SchemaEdit.addCopyField.json | 9 +++++----
.../apispec/core.SchemaEdit.addFieldType.json | 10 +++++-----
.../apispec/core.SchemaEdit.deleteCopyField.json | 9 ++++++---
.../apispec/core.SchemaEdit.deleteDynamicField.json | 6 ++++--
.../apispec/core.SchemaEdit.deleteField.json | 5 +++--
.../apispec/core.SchemaEdit.deleteFieldType.json | 6 ++++--
.../apispec/core.SchemaRead.copyFields.json | 11 ++++++++---
.../resources/apispec/core.SchemaRead.fields.json | 16 +++++++++++++---
9 files changed, 52 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.RealtimeGet.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.RealtimeGet.json b/solr/core/src/resources/apispec/core.RealtimeGet.json
index af7fd66..308870e 100644
--- a/solr/core/src/resources/apispec/core.RealtimeGet.json
+++ b/solr/core/src/resources/apispec/core.RealtimeGet.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/RealTime+Get",
+ "description": "RealTime Get allows retrieving documents by ID before the documents have been committed to the index. It is useful when you need access to documents as soon as they are indexed but your commit times are high for other reasons.",
"methods": [
"GET"
],
@@ -10,15 +11,15 @@
"params": {
"id": {
"type": "string",
- "description": "one or more ids. Separate by commas if there are more than one"
+ "description": "A single document ID to retrieve."
},
"ids": {
"type": "string",
- "description": "one or more ids. Separate by commas if there are more than one"
+ "description": "One or more document IDs to retrieve. Separate by commas if more than one ID is specified."
},
"fq":{
"type": "string",
- "description": "Filter query"
+ "description": "An optional filter query to add to the query. One use case for this is security filtering, in case users or groups should not be able to retrieve the document ID requested."
}
}
}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.addCopyField.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addCopyField.json b/solr/core/src/resources/apispec/core.SchemaEdit.addCopyField.json
index d80b92f..26c4eff 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addCopyField.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addCopyField.json
@@ -1,21 +1,22 @@
{
"documentation" : "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-AddaNewCopyFieldRule",
+ "description": "Adds a new copy field rule, to allow one field to be populated with the contents of one or more other fields.",
"type": "object",
"properties": {
"source": {
"type": "string",
- "description": "The source field"
+ "description": "The field to copy from."
},
"dest": {
"type":"array",
"items": {
"type": "string"
},
- "description": "A field or an array of fields to which the source field will be copied."
+ "description": "A field or an array of fields to which the source field will be copied. A wildcard for a dynamic field can be used, but only if the source field also contains a dynamic field."
},
"maxChars": {
"type": "integer",
- "description": "The upper limit for the number of characters to be copied. The section Copying Fields has more details."
+ "description": "An upper limit for the number of characters to be copied. This would be useful if index size is a concern. If a limit is not specified, the entire field will be copied."
}
},
"required": [
@@ -23,4 +24,4 @@
"dest"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
index 0efb967..3a44f6e 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
@@ -31,11 +31,11 @@
"type": "object",
"description": "A query analyzer section defines how incoming queries to Solr will be analyzed for a field of this type.",
"properties":{
- "tokenizer": {
- "type": "object",
- "properties": {
- "class": {
- "type": "string"
+ "tokenizer": {
+ "type": "object",
+ "properties": {
+ "class": {
+ "type": "string"
}
},
"additionalProperties": true
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.deleteCopyField.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.deleteCopyField.json b/solr/core/src/resources/apispec/core.SchemaEdit.deleteCopyField.json
index b33549e..dd6ff3a 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.deleteCopyField.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.deleteCopyField.json
@@ -1,16 +1,19 @@
{
"type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaCopyFieldRule",
+ "description": "Deletes a copy field rule. Both sides of the copy rule (source and destination) are required in order to delete the rule.",
"properties":{
"source": {
- "type":"string"
+ "type":"string",
+ "description": "The field the copy rule is defined to copy from."
},
"dest": {
- "type": "string"
+ "type": "string",
+ "description": "The field the copy rule is defined to copy to."
}
},
"required": [
"source",
"dest"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json b/solr/core/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json
index 1ad22a0..9550548 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json
@@ -1,10 +1,12 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaDynamicFieldRule",
+ "description": "Deletes a dynamic field.",
"type":"object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The name of the dynamic field to delete."
}
},
"required":["name"]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.deleteField.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.deleteField.json b/solr/core/src/resources/apispec/core.SchemaEdit.deleteField.json
index 1a6126d..6c2cb00 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.deleteField.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.deleteField.json
@@ -1,11 +1,12 @@
{
"documentation" : "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaField",
+ "description": "Deletes a field from the schema.",
"type":"object",
"properties":{
"name":{
- "description" :"name of the field",
+ "description" :"The name of the field to delete.",
"type" : "string"
}
},
"required" : ["name"]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaEdit.deleteFieldType.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.deleteFieldType.json b/solr/core/src/resources/apispec/core.SchemaEdit.deleteFieldType.json
index fd17753..712462a 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.deleteFieldType.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.deleteFieldType.json
@@ -1,12 +1,14 @@
{
"documentation":"https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaFieldType",
+ "description": "Deletes a field type from the schema.",
"type":"object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The name of the field type to delete."
}
},
"required": [
"name"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaRead.copyFields.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaRead.copyFields.json b/solr/core/src/resources/apispec/core.SchemaRead.copyFields.json
index 35c4b56..4cf822e 100644
--- a/solr/core/src/resources/apispec/core.SchemaRead.copyFields.json
+++ b/solr/core/src/resources/apispec/core.SchemaRead.copyFields.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-ListCopyFields",
+ "description": "Lists all copy fields.",
"methods": [
"GET"
],
@@ -8,13 +9,17 @@
"schema/copyfields"
],
"params": {
+ "wt": {
+ "type": "string",
+ "description": "The format of the response. Valid options are xml or json."
+ },
"source.fl": {
"type": "string",
- "description": "Comma or space-separated list of one or more copyField source fields to include in the response - copyField directives with all other source fields will be excluded from the response. If not specified, all copyField-s will be included in the response"
+ "description": "Comma- or space-separated list of one or more source fields to include in the response. copyField directives with all other source fields will be excluded from the response. If not specified, all copyFields will be included in the response"
},
"dest.fl": {
"type": "string",
- "description": "Comma or space-separated list of one or more copyField dest fields to include in the response - copyField directives with all other dest fields will be excluded. If not specified, all copyField-s will be included in the response."
+ "description": "Comma or space-separated list of one or more copyField dest (destination) fields to include in the response. copyField directives with all other dest fields will be excluded. If not specified, all copyFields will be included in the response."
}
}
}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a2486fd2/solr/core/src/resources/apispec/core.SchemaRead.fields.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaRead.fields.json b/solr/core/src/resources/apispec/core.SchemaRead.fields.json
index 006f2e6..3b6c787 100644
--- a/solr/core/src/resources/apispec/core.SchemaRead.fields.json
+++ b/solr/core/src/resources/apispec/core.SchemaRead.fields.json
@@ -1,5 +1,6 @@
{
- "documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-ListFields",
+ "description": "Get only the fields defined in the schema.",
"methods": [
"GET"
],
@@ -9,14 +10,23 @@
"/schema/fields/{name}"
],
"params": {
+ "wt": {
+ "type": "string",
+ "description": "The format of the response. Valid options are xml or json.",
+ "default": "json"
+ },
+ "fl": {
+ "type": "string",
+ "description": "A comma- or space-separated list fields to return. If not specified, all fields will be returned. Note a single field can be requested by adding the field name to the endpoint."
+ },
"includeDynamic": {
"type": "boolean",
- "description": "If true, and if the fl query parameter is specified or the fieldname path parameter is used, matching dynamic fields are included in the response and identified with the dynamicBase property. If neither the fl query parameter nor the fieldname path parameter is specified, the includeDynamic query parameter is ignored. If false, matching dynamic fields will not be returned.",
+ "description": "If true, dynamic fields will be returned in the response.",
"default": false
},
"showDefaults": {
"type": "boolean",
- "description": "If true, all default field properties from each field's field type will be included in the response (e.g. tokenized for solr.TextField). If false, only explicitly specified field properties will be included.",
+ "description": "If true, all field properties from each field's field type will be included in the response, even if they are not explicitly defined on the field. If false, only explicitly defined field properties will be included.",
"default": false
}
}
[3/4] lucene-solr:apiv2: Remove new include file (doesn't work),
put SchemaEdit.addFieldType back the way it was
Posted by ct...@apache.org.
Remove new include file (doesn't work), put SchemaEdit.addFieldType back the way it was
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/8d8cd3cb
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/8d8cd3cb
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/8d8cd3cb
Branch: refs/heads/apiv2
Commit: 8d8cd3cb907d7b909788c9b13f5576a00e3e14e8
Parents: cedc63d
Author: Cassandra Targett <ct...@apache.org>
Authored: Thu Dec 8 16:08:02 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Thu Dec 8 16:08:02 2016 -0600
----------------------------------------------------------------------
.../core.SchemaEdit.addFieldType.analyzers.json | 39 --------------------
.../apispec/core.SchemaEdit.addFieldType.json | 13 ++++++-
2 files changed, 11 insertions(+), 41 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/8d8cd3cb/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
deleted file mode 100644
index c2e6acf..0000000
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.analyzers.json
+++ /dev/null
@@ -1,39 +0,0 @@
-"class": {
- "type": "string"
-},
-"tokenizer":{
- "type":"object",
- "properties":{
- "class":{
- "type":"string"
- }
- },
- "required":["class"],
- "additionalProperties":true
-},
-"charFilters":{
- "type":"array",
- "items":{
- "type":"object",
- "properties":{
- "class":{
- "type":"string"
- }
- },
- "required":["class"],
- "additionalProperties":true
- }
-},
-"filters":{
- "type":"array",
- "items":{
- "type":"object",
- "properties":{
- "class":{
- "type":"string"
- }
- },
- "required":["class"],
- "additionalProperties":true
- }
-}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/8d8cd3cb/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
index ff6213e..0efb967 100644
--- a/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
+++ b/solr/core/src/resources/apispec/core.SchemaEdit.addFieldType.json
@@ -30,8 +30,17 @@
"queryAnalyzer": {
"type": "object",
"description": "A query analyzer section defines how incoming queries to Solr will be analyzed for a field of this type.",
- "properties":
- {"#include":"core.SchemaEdit.addFieldType.analyzers.json"},
+ "properties":{
+ "tokenizer": {
+ "type": "object",
+ "properties": {
+ "class": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": true
+ }
+ },
"additionalProperties": true
},
"indexAnalyzer": {