Skip to content

Commit

Permalink
docs(elasticsearch): document the elasticsearch property
Browse files Browse the repository at this point in the history
Add documentation to the elasticsearch property to reflect behavior added in api-platform/core#5177
  • Loading branch information
jannes-io authored Nov 10, 2022
1 parent 26cbb7f commit eca7079
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions core/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ Keep in mind that it is your responsibility to populate your Elasticsearch index
a custom [state processors](state-processors.md#creating-a-custom-state-processor) or any other mechanism that suits your
project (such as an [ETL](https://en.wikipedia.org/wiki/Extract,_transform,_load)).

To disable elasticsearch index discovery for non-elasticsearch entities you can set `elasticsearch: false` in the `#[ApiResource]` attribute. If this property is absent, all entities will perform an index check during cache warmup to determine if they are on elasticsearch or not.

You're done! The API is now ready to use.

### Creating custom mapping
Expand Down

0 comments on commit eca7079

Please sign in to comment.