-
Notifications
You must be signed in to change notification settings - Fork 504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add new documentation IP2Geo processor automatic updating feature #4095
Conversation
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
@heemin32 The first-pass draft is ready for your technical review. Please review for technical accuracy, gaps in information, and other technical-related information. You're welcome to schedule a meeting with me to talk through this content. Thanks! |
Signed-off-by: vagimeli <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please consider if having a separate page for datasource + separate pages for each create, update, read, and delete APIs would be better for readability.
Co-authored-by: Heemin Kim <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heemin Kim <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heemin Kim <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!
|
||
| Key | Description | Default | | ||
|--------------------|-------------|---------| | ||
| plugins.geospatial.ip2geo.datasource.endpoint | Default endpoint for creating the data source API. | Defaults to https://geoip.maps.opensearch.org/v1/geolite2-city/manifest.json. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the terminating period shouldn't be part of the link.
_api-reference/ingest-apis/ip2geo.md
Outdated
| `datasource` | Required | - | The data source name to use to look up geographical information. | | ||
| `properties` | Optional | All fields in `datasource`. | The field that controls what properties are added to `target_field` from `datasource`. | | ||
| `target_field` | Optional | ip2geo | The field that holds the geographical information looked up from the data source. | | ||
| `ignore_missing` | Optional | false | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The end of the description is a bit oddly worded. Do we just mean "the processor does not modify the document"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revised to read: If set to true
, the processor does not modify the document if the field does not exist or is null
. Default is false
.
_api-reference/ingest-apis/ip2geo.md
Outdated
``` | ||
{% include copy-curl.html %} | ||
|
||
**Step 2: Ingest a document into the index.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"an index" instead of "the index"?
_api-reference/ingest-apis/ip2geo.md
Outdated
|
||
**Step 2: Ingest a document into the index.** | ||
|
||
The following query ingests a document into the index named `my-index`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"an index" instead of "the index"?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Description
Add new documentation about GeoIP automatic updating feature
Issues Resolved
#3524
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.