[DOC] Feedback on API content

[hdhalter]

What do you want to do?

x Request a change to existing documentation

Tell us about your request. Provide a summary of the request and all versions that are affected. Feedback from community on various API topics:

• [ ] 20230516 | /docs/2.0/api-reference/script-apis/exec-stored-script/ | Would be much helpful if it demonstrates how to filter on the scripted_field "total_ratings"
• [ ] 20230309 | /docs/2.3/api-reference/index-apis/create-index/ | Only contains settings. Where does the mapping go?
• [ ] 20230530 | /docs/latest/api-reference/document-apis/get-documents/ | it does not have example of the error response
• [ ] 20230510 | /docs/latest/api-reference/snapshots/index/ | How to list all available snapshots?
• [ ] 20230719 | /docs/latest/api-reference/snapshots/get-snapshot-status/ | "Snapshot states" lists 4 states: FAILED, IN_PROGRESS, PARTIAL , and SUCCESS. But when I just now ran the API request against my cluster (Amazon OpenSearch service with OpenSearch v2.5) I got the state "STARTED" which is not listed.
• [ ] 20230613 | /docs/1.3/api-reference/index-apis/update-settings/ |There is no details on use of wildcards and how to exclude certain indices while updating others
• [ ] 20230613 |/docs/latest/api-reference/index-apis/clear-index-cache/ |It does not show clearly how to clear cache in general. you should add step by step images.
• [ ] 20230612 |/docs/latest/api-reference/search/ |This page needs a more detailed example, something that uses other parameters, with exact matches/wild cards, etc.
• [ ] 20230623 | /docs/latest/api-reference/script-apis/exec-stored-script/ | I'd like to know if scripted_fields can be filtered on but there is no information on this.
• [ ] 20230621 | /docs/latest/api-reference/ingest-apis/create-update-ingest/ | Need more specific detail on processor types, script support, etc. (This will be fixed by https://github.com/opensearch-project/documentation-website/pull/4299/files)
• [ ] 20230801 | /docs/latest/api-reference/ingest-apis/create-update-ingest/ | Needs more detail on processor properties (set, field, value, and related).
• [ ] 20230801 | /docs/latest/api-reference/ingest-apis/create-update-ingest/ | what are the differences between elasticsearch and opensearch pipelines?
• [ ] 20230802 | /docs/latest/api-reference/document-apis/update-by-query/ | Why don't you put java sample code?
• [ ] 20230727 | /docs/latest/api-reference/scroll/ | no handler found for uri [/_search/scroll] and method [GET]
• [ ] 20230627 | /docs/1.3/api-reference/script-apis/create-stored-script/ | i want query ti insert data in index
• [ ] 20230704 | /docs/2.8/api-reference/search/ | What are the defintions of the fields in the response body? I am especially interested in the field "took"
• [ ] 20230907 | /docs/latest/api-reference/profile/ | Does the latest profile API support global ordinals in terms aggregation?
• [ ] 20230913 | /docs/2.6/api-reference/nodes-apis/nodes-hot-threads/ | it doesn't explain what the response means or how to interpret this data
• [ ] 20230913 | /docs/latest/api-reference/index-apis/update-settings/ | I got an error saying I needed to use a POST instead of a PUT
• [ ] 20230914 | /docs/latest/api-reference/index-apis/stats/ | write a f**g example link
• [ ] 20231030 | /docs/2.9/api-reference/multi-search/ | was looking for the shape of an error response
• [ ] 20231102 | /docs/latest/api-reference/document-apis/get-documents/ | The _source URL parameter is a string. However, the description does not seem to be quite right. Seems like it is expecting a Boolean
• [ ] 20231204 | /docs/latest/api-reference/search/ | Content type of the request is not mentioned

What other resources are available? Provide links to related issues, POCs, steps for testing, etc. https://opensearch.org/docs/latest/api-reference/index/

[hdhalter]

Feedback from 2024

• [ ] 20240115 | /docs/latest/api-reference/tasks/ | the list of all actions?
• [ ] 20240124 | /docs/latest/api-reference/document-apis/reindex/ | The Request body section contains just a table that doesn't show how the fields are nested into each other
• [ ] 20240125 | /docs/latest/api-reference/search/ | No examples, or detail. For example for "fields" in Request Body, the type is Array (Array of what?) the descriptions says "Specify a format to return results in a certain format" WHERE??? HOW???
• [ ] 20240201 | /docs/latest/api-reference/index-apis/clear-index-cache/ | Does the api to refresh index exist in OpenSearch, like in ElasticSearch
• [ ] 20240201 | /docs/latest/api-reference/index-apis/clear-index-cache/ | not clear if the api to refresh index exist in OpenSearch, like in ElasticSearch
• [ ] 20240201 | /docs/latest/api-reference/index-apis/create-index/ | has no examples and the python library fails connecting to the database
• [ ] 20240201 | /docs/latest/api-reference/scroll/ | I am looking for maximum that we can use for size for scroll that is not available on this page.
• [ ] 20240204 | /docs/latest/api-reference/cat/cat-indices/ |
• [ ] 20240204 | /docs/latest/api-reference/document-apis/update-by-query/ | please also add how to update multiple field
• [ ] 20240208 | /docs/latest/api-reference/index-apis/create-index/ | No copy curl is there I need to recreate the command by myself for pretty standard thing.
• [ ] 20240208 | /docs/latest/api-reference/index-apis/delete-index/ | Does not show various example to use the page and what kind of response we can expect which makes it pretty much trial and error.
• [ ] 20240212 | /docs/2.2/api-reference/cluster-api/cluster-settings/ | List the cluster settings parameters
• [ ] 20240218 | /docs/latest/api-reference/cat/index/ | page is helpful, but parameter sort doesn¬¥t seem to work, could you please add an example **See the API spec for an example.
• [ ] 20240221 | /docs/latest/api-reference/index-apis/clone/ | It doesn't mention anywhere in the page that the source index should be set to readonly
• [ ] 20240227 | /docs/latest/api-reference/units/ | Date with nanoseconds format Used for the date_nanos datatype of OpenSearch Default: MMM D, YYYY @ HH:mm:ss.SSSSSSSSS
• [ ] 20240228 | /docs/1.3/api-reference/ | _template
• [ ] 20240311 | /docs/2.12/api-reference/index-apis/put-mapping/ | Followed the doc to edit my mapping and it returns mapper_parsing_exception, "type" parameter is unnsupported.
• [ ] 20240322 | /docs/latest/api-reference/index-apis/put-mapping/ | not enough details about the api sepc
• [ ] 20240328 | /docs/2.12/api-reference/document-apis/reindex/ | Reindexing from remote hosts requires an entry into the 'allowlist' for that host. There's no docs f or it.
• [ ] 20240401 | /docs/2.7/api-reference/index-apis/put-mapping/ | i didnt understand the problem in me ;)
• [ ] 20240412 | /docs/latest/api-reference/document-apis/update-by-query/ | not clear
• [ ] 20240419 | /docs/latest/api-reference/search/ | no info on status codes
• [ ] 20240508 | /docs/latest/api-reference/index-apis/create-index/ | The Index naming restrictions section does not include the size limitation of 255.
• [ ] 20240516 | /docs/latest/api-reference/index-apis/get-index/ | I need Python Sample code. I am getting this error: AttributeError: 'OpenSearchServiceServerless' object has no attribute 'indices'
• [ ] 20240626 | /docs/latest/api-reference/ | Hello The API to create "saved queries" or dashbard are missing unfortunelty. Is there any initiative in progress? Thanks
• [ ] 20240614 | /docs/latest/api-reference/document-apis/update-by-query/ | _update_by_query 404 permission error othe post post _doc is working
• [ ] 20240703 | /docs/latest/api-reference/index-apis/put-mapping/ | Where is the full reference for the index mappings?