From a2e11285cc0b5b15395ffca70939e445cf05bb7c Mon Sep 17 00:00:00 2001 From: Aschen Date: Fri, 31 May 2019 15:50:50 +0200 Subject: [PATCH 01/10] Rename folders and write redirections --- redirections.yml | 510 ++++++++++++++++++ .../admin}/dump/index.md | 0 .../admin}/index.md | 0 .../admin}/reset-cache/index.md | 0 .../admin}/reset-database/index.md | 0 .../admin}/reset-kuzzle-data/index.md | 0 .../admin}/reset-security/index.md | 0 .../admin}/shutdown/index.md | 0 .../auth}/check-token/index.md | 0 .../auth}/create-my-credentials/index.md | 0 .../auth}/credentials-exists/index.md | 0 .../auth}/delete-my-credentials/index.md | 0 .../auth}/get-current-user/index.md | 0 .../auth}/get-my-credentials/index.md | 0 .../auth}/get-my-rights/index.md | 0 .../auth}/get-strategies/index.md | 0 .../auth}/index.md | 0 .../auth}/login/index.md | 0 .../auth}/logout/index.md | 0 .../auth}/update-my-credentials/index.md | 0 .../auth}/update-self/index.md | 0 .../auth}/validate-my-credentials/index.md | 0 .../bulk}/import/index.md | 0 .../bulk}/index.md | 0 .../collection}/create/index.md | 0 .../delete-specifications/index.md | 0 .../collection}/exists/index.md | 0 .../collection}/get-mapping/index.md | 0 .../collection}/get-specifications/index.md | 0 .../collection}/index.md | 0 .../collection}/list/index.md | 0 .../scroll-specifications/index.md | 0 .../search-specifications/index.md | 0 .../collection}/truncate/index.md | 0 .../collection}/update-mapping/index.md | 0 .../update-specifications/index.md | 0 .../validate-specifications/index.md | 0 .../document}/count/index.md | 0 .../document}/create-or-replace/index.md | 0 .../document}/create/index.md | 0 .../document}/delete-by-query/index.md | 0 .../document}/delete/index.md | 0 .../document}/get/index.md | 0 .../document}/index.md | 0 .../document}/m-create-or-replace/index.md | 0 .../document}/m-create/index.md | 0 .../document}/m-delete/index.md | 0 .../document}/m-get/index.md | 0 .../document}/m-replace/index.md | 0 .../document}/m-update/index.md | 0 .../document}/replace/index.md | 0 .../document}/scroll/index.md | 0 .../document}/search/index.md | 0 .../document}/update/index.md | 0 .../document}/validate/index.md | 0 .../{api-reference => controllers}/index.md | 0 .../index}/create/index.md | 0 .../index}/delete/index.md | 0 .../index}/exists/index.md | 0 .../index}/get-auto-refresh/index.md | 0 .../index}/index.md | 0 .../index}/list/index.md | 0 .../index}/m-delete/index.md | 0 .../index}/refresh-internal/index.md | 0 .../index}/refresh/index.md | 0 .../index}/set-auto-refresh/index.md | 0 .../memory-storage}/append/index.md | 0 .../memory-storage}/bitcount/index.md | 0 .../memory-storage}/bitop/index.md | 0 .../memory-storage}/bitpos/index.md | 0 .../memory-storage}/dbsize/index.md | 0 .../memory-storage}/decr/index.md | 0 .../memory-storage}/decrby/index.md | 0 .../memory-storage}/del/index.md | 0 .../memory-storage}/exists/index.md | 0 .../memory-storage}/expire/index.md | 0 .../memory-storage}/expireat/index.md | 0 .../memory-storage}/flushdb/index.md | 0 .../memory-storage}/geoadd/index.md | 0 .../memory-storage}/geodist/index.md | 0 .../memory-storage}/geohash/index.md | 0 .../memory-storage}/geopos/index.md | 0 .../memory-storage}/georadius/index.md | 0 .../georadiusbymember/index.md | 0 .../memory-storage}/get/index.md | 0 .../memory-storage}/getbit/index.md | 0 .../memory-storage}/getrange/index.md | 0 .../memory-storage}/getset/index.md | 0 .../memory-storage}/hdel/index.md | 0 .../memory-storage}/hexists/index.md | 0 .../memory-storage}/hget/index.md | 0 .../memory-storage}/hgetall/index.md | 0 .../memory-storage}/hincrby/index.md | 0 .../memory-storage}/hincrbyfloat/index.md | 0 .../memory-storage}/hkeys/index.md | 0 .../memory-storage}/hlen/index.md | 0 .../memory-storage}/hmget/index.md | 0 .../memory-storage}/hmset/index.md | 0 .../memory-storage}/hscan/index.md | 0 .../memory-storage}/hset/index.md | 0 .../memory-storage}/hsetnx/index.md | 0 .../memory-storage}/hstrlen/index.md | 0 .../memory-storage}/hvals/index.md | 0 .../memory-storage}/incr/index.md | 0 .../memory-storage}/incrby/index.md | 0 .../memory-storage}/incrbyfloat/index.md | 0 .../memory-storage}/index.md | 0 .../memory-storage}/keys/index.md | 0 .../memory-storage}/lindex/index.md | 0 .../memory-storage}/linsert/index.md | 0 .../memory-storage}/llen/index.md | 0 .../memory-storage}/lpop/index.md | 0 .../memory-storage}/lpush/index.md | 0 .../memory-storage}/lpushx/index.md | 0 .../memory-storage}/lrange/index.md | 0 .../memory-storage}/lrem/index.md | 0 .../memory-storage}/lset/index.md | 0 .../memory-storage}/ltrim/index.md | 0 .../memory-storage}/mget/index.md | 0 .../memory-storage}/mset/index.md | 0 .../memory-storage}/msetnx/index.md | 0 .../memory-storage}/object/index.md | 0 .../memory-storage}/persist/index.md | 0 .../memory-storage}/pexpire/index.md | 0 .../memory-storage}/pexpireat/index.md | 0 .../memory-storage}/pfadd/index.md | 0 .../memory-storage}/pfcount/index.md | 0 .../memory-storage}/pfmerge/index.md | 0 .../memory-storage}/ping/index.md | 0 .../memory-storage}/psetex/index.md | 0 .../memory-storage}/pttl/index.md | 0 .../memory-storage}/randomkey/index.md | 0 .../memory-storage}/rename/index.md | 0 .../memory-storage}/renamenx/index.md | 0 .../memory-storage}/rpop/index.md | 0 .../memory-storage}/rpoplpush/index.md | 0 .../memory-storage}/rpush/index.md | 0 .../memory-storage}/rpushx/index.md | 0 .../memory-storage}/sadd/index.md | 0 .../memory-storage}/scan/index.md | 0 .../memory-storage}/scard/index.md | 0 .../memory-storage}/sdiff/index.md | 0 .../memory-storage}/sdiffstore/index.md | 0 .../memory-storage}/set/index.md | 0 .../memory-storage}/setex/index.md | 0 .../memory-storage}/setnx/index.md | 0 .../memory-storage}/sinter/index.md | 0 .../memory-storage}/sinterstore/index.md | 0 .../memory-storage}/sismember/index.md | 0 .../memory-storage}/smembers/index.md | 0 .../memory-storage}/smove/index.md | 0 .../memory-storage}/sort/index.md | 0 .../memory-storage}/spop/index.md | 0 .../memory-storage}/srandmember/index.md | 0 .../memory-storage}/srem/index.md | 0 .../memory-storage}/sscan/index.md | 0 .../memory-storage}/strlen/index.md | 0 .../memory-storage}/sunion/index.md | 0 .../memory-storage}/sunionstore/index.md | 0 .../memory-storage}/time/index.md | 0 .../memory-storage}/touch/index.md | 0 .../memory-storage}/ttl/index.md | 0 .../memory-storage}/type/index.md | 0 .../memory-storage}/zadd/index.md | 0 .../memory-storage}/zcard/index.md | 0 .../memory-storage}/zcount/index.md | 0 .../memory-storage}/zincrby/index.md | 0 .../memory-storage}/zinterstore/index.md | 0 .../memory-storage}/zlexcount/index.md | 0 .../memory-storage}/zrange/index.md | 0 .../memory-storage}/zrangebylex/index.md | 0 .../memory-storage}/zrangebyscore/index.md | 0 .../memory-storage}/zrank/index.md | 0 .../memory-storage}/zrem/index.md | 0 .../memory-storage}/zremrangebylex/index.md | 0 .../memory-storage}/zremrangebyrank/index.md | 0 .../memory-storage}/zremrangebyscore/index.md | 0 .../memory-storage}/zrevrange/index.md | 0 .../memory-storage}/zrevrangebylex/index.md | 0 .../memory-storage}/zrevrangebyscore/index.md | 0 .../memory-storage}/zrevrank/index.md | 0 .../memory-storage}/zscan/index.md | 0 .../memory-storage}/zscore/index.md | 0 .../memory-storage}/zunionstore/index.md | 0 .../realtime}/count/index.md | 0 .../realtime}/index.md | 0 .../realtime}/join/index.md | 0 .../realtime}/list/index.md | 0 .../realtime}/publish/index.md | 0 .../realtime}/subscribe/index.md | 0 .../realtime}/unsubscribe/index.md | 0 .../realtime}/validate/index.md | 0 .../security}/create-credentials/index.md | 0 .../security}/create-first-admin/index.md | 0 .../create-or-replace-profile/index.md | 0 .../security}/create-or-replace-role/index.md | 0 .../security}/create-profile/index.md | 0 .../security}/create-restricted-user/index.md | 0 .../security}/create-role/index.md | 0 .../security}/create-user/index.md | 0 .../security}/delete-credentials/index.md | 0 .../security}/delete-profile/index.md | 0 .../security}/delete-role/index.md | 0 .../security}/delete-user/index.md | 0 .../get-all-credential-fields/index.md | 0 .../security}/get-credential-fields/index.md | 0 .../security}/get-credentials-by-id/index.md | 0 .../security}/get-credentials/index.md | 0 .../security}/get-profile-mapping/index.md | 0 .../security}/get-profile-rights/index.md | 0 .../security}/get-profile/index.md | 0 .../security}/get-role-mapping/index.md | 0 .../security}/get-role/index.md | 0 .../security}/get-user-mapping/index.md | 0 .../security}/get-user-rights/index.md | 0 .../security}/get-user/index.md | 0 .../security}/has-credentials/index.md | 0 .../security}/index.md | 0 .../security}/m-delete-profiles/index.md | 0 .../security}/m-delete-roles/index.md | 0 .../security}/m-delete-users/index.md | 0 .../security}/m-get-profiles/index.md | 0 .../security}/m-get-roles/index.md | 0 .../security}/replace-user/index.md | 0 .../security}/scroll-profiles/index.md | 0 .../security}/scroll-users/index.md | 0 .../security}/search-profiles/index.md | 0 .../security}/search-roles/index.md | 0 .../security}/search-users/index.md | 0 .../security}/update-credentials/index.md | 0 .../security}/update-profile-mapping/index.md | 0 .../security}/update-profile/index.md | 0 .../security}/update-role-mapping/index.md | 0 .../security}/update-role/index.md | 0 .../security}/update-user-mapping/index.md | 0 .../security}/update-user/index.md | 0 .../security}/validate-credentials/index.md | 0 .../server}/admin-exists/index.md | 0 .../server}/get-all-stats/index.md | 0 .../server}/get-config/index.md | 0 .../server}/get-last-stats/index.md | 0 .../server}/get-stats/index.md | 0 .../server}/index.md | 0 .../server}/info/index.md | 0 .../server}/now/index.md | 0 src/core/1/guide/guides/index.md | 7 - .../androidstudio_project_databasesearch.png | Bin .../androidstudio_project_noactivity.png | Bin .../code-examples/dbsearch/android/index.md | 0 .../code-examples/dbsearch/go/index.md | 0 .../code-examples/dbsearch/index.md | 0 .../dbsearch/introduction/index.md | 0 .../dbsearch/javascript/index.md | 0 .../dbsearch/javascript/snippets/connect.js | 0 .../javascript/snippets/connect.test.yml | 0 .../dbsearch/javascript/snippets/create.js | 0 .../javascript/snippets/create.test.yml | 0 .../dbsearch/javascript/snippets/final.js | 0 .../javascript/snippets/final.test.yml | 0 .../dbsearch/javascript/snippets/load-sdk.js | 0 .../javascript/snippets/load-sdk.test.yml | 0 .../dbsearch/javascript/snippets/search.js | 0 .../javascript/snippets/search.test.yml | 0 .../androidstudio_project_geofencing.png | Bin .../androidstudio_project_noactivity.png | Bin .../code-examples/geofencing/android/index.md | 0 .../code-examples/geofencing/go/index.md | 0 .../code-examples/geofencing/index.md | 0 .../geofencing/introduction/index.md | 0 .../geofencing/javascript/index.md | 0 .../javascript/snippets/createdoc.js | 0 .../javascript/snippets/createdoc.test.yml | 0 .../javascript/snippets/definearea.js | 0 .../javascript/snippets/definearea.test.yml | 0 .../geofencing/javascript/snippets/geofenc.js | 0 .../javascript/snippets/geofenc.test.yml | 0 .../javascript/snippets/load-sdk.js | 0 .../javascript/snippets/load-sdk.test.yml | 0 .../javascript/snippets/location.js | 0 .../javascript/snippets/location.test.yml | 0 .../javascript/snippets/subscribe.js | 0 .../javascript/snippets/subscribe.test.yml | 0 .../javascript/snippets/updatedoc.js | 0 .../javascript/snippets/updatedoc.test.yml | 0 .../{guide => guides}/code-examples/index.md | 2 +- .../iot/android/androidstudio_project_iot.png | Bin .../androidstudio_project_noactivity.png | Bin .../code-examples/iot/android/index.md | 0 .../code-examples/iot/go/index.md | 0 .../code-examples/iot/index.md | 0 .../code-examples/iot/introduction/index.md | 0 .../code-examples/iot/javascript/index.md | 0 .../iot/javascript/snippets/publish.js | 0 .../iot/javascript/snippets/publish.test.yml | 0 .../iot/javascript/snippets/subscribe.js | 0 .../javascript/snippets/subscribe.test.yml | 0 .../androidstudio_project_noactivity.png | Bin .../android/androidstudio_project_pubsub.png | Bin .../code-examples/pubsub/android/index.md | 0 .../code-examples/pubsub/go/index.md | 0 .../code-examples/pubsub/index.md | 0 .../pubsub/introduction/index.md | 0 .../code-examples/pubsub/javascript/index.md | 0 .../pubsub/javascript/snippets/load-sdk.js | 0 .../javascript/snippets/load-sdk.test.yml | 0 .../pubsub/javascript/snippets/publish.js | 0 .../javascript/snippets/publish.test.yml | 0 .../pubsub/javascript/snippets/pubsubjs.js | 0 .../javascript/snippets/pubsubjs.test.yml | 0 .../pubsub/javascript/snippets/subscribe.js | 0 .../javascript/snippets/subscribe.test.yml | 0 .../cookbooks/datavalidation/fields/index.md | 0 .../cookbooks/datavalidation/index.md | 0 .../datavalidation/introduction/index.md | 0 .../cookbooks/datavalidation/schema/index.md | 0 .../datavalidation/validators/index.md | 0 .../elasticsearch/basic-queries/index.md | 0 .../elasticsearch/bool-query/index.md | 0 .../elasticsearch/data-insertion/index.md | 0 .../cookbooks/elasticsearch/index.md | 0 .../elasticsearch/installation/index.md | 0 .../elasticsearch/introduction/index.md | 0 .../elasticsearch/useful-commands/index.md | 0 .../1/{guide => guides}/cookbooks/index.md | 2 +- .../guides/essentials/cli/index.md | 0 .../guides/essentials/configuration/index.md | 0 .../essentials/data-validation/index.md | 0 .../essentials/database-mappings/index.md | 0 .../essentials/document-metadata/index.md | 4 +- .../1/{guide => }/guides/essentials/index.md | 0 .../essentials/installing-console/index.md | 4 +- .../installing-console/kuzbo-connecting.png | Bin .../installing-console/kuzbo-firstadmin.png | Bin .../essentials/installing-kuzzle/index.md | 0 .../guides/essentials/introduction/index.md | 0 .../guides/essentials/persisted/index.md | 0 .../guides/essentials/plugins/index.md | 0 .../guides/essentials/real-time/index.md | 0 .../real-time/snippets/subscribe-filter.js | 0 .../snippets/subscribe-filter.test.yml | 0 .../real-time/snippets/subscribe-no-filter.js | 0 .../snippets/subscribe-no-filter.test.yml | 0 .../real-time/snippets/subscribe-options.js | 0 .../snippets/subscribe-options.test.yml | 0 .../request-and-response-format/index.md | 0 .../guides/essentials/security/index.md | 2 +- .../essentials/security/profiles-roles.png | Bin .../essentials/signal-handling/index.md | 0 .../essentials/user-authentication/index.md | 0 .../user-authentication/snippets/login.js | 0 .../snippets/login.test.yml | 0 .../getting-started/first-steps/index.md | 0 .../first-steps/snippets/create.js | 0 .../first-steps/snippets/create.test.yml | 0 .../first-steps/snippets/init-sample.js | 0 .../first-steps/snippets/init-sample.test.yml | 0 .../first-steps/snippets/init.js | 0 .../first-steps/snippets/init.test.yml | 0 .../first-steps/snippets/load-sdk.js | 0 .../first-steps/snippets/load-sdk.test.yml | 0 .../first-steps/snippets/subscribe.js | 0 .../first-steps/snippets/subscribe.test.yml | 0 .../guides/getting-started/index.md | 0 .../getting-started/running-kuzzle/index.md | 0 src/core/1/{guide => guides}/index.md | 0 .../Kuzzle_Server_Architecture.png | Bin .../guides/kuzzle-depth/architecture/index.md | 0 .../Authentication_Overview.png | Bin .../authentication/details-local.png | Bin .../authentication/details-oauth2.png | Bin .../kuzzle-depth/authentication/index.md | 2 +- .../{guide => }/guides/kuzzle-depth/index.md | 2 +- .../Asynchronous_Communication_Overview.png | Bin ...nous_Communication_Publishing_Directly.png | Bin ...us_Communication_Publishing_Indirectly.png | Bin ...synchronous_Communication_Subscription.png | Bin ...hronous_Request_HTTP_Protocol_Overview.png | Bin ...hronous_Request_HTTP_Protocol_Sequence.png | Bin ...us_Request_Websocket_Protocol_Overview.png | Bin ...us_Request_Websocket_Protocol_Sequence.png | Bin .../kuzzle-depth/request-life-cycle/index.md | 0 .../kuzzle-depth/roles-definitions/index.md | 0 src/core/1/koncorde/essentials/index.md | 2 +- .../essentials/available-plugins/index.md | 0 .../essentials/getting-started/index.md | 8 +- .../plugins/{plugins => }/essentials/index.md | 0 .../essentials/introduction/index.md | 8 +- .../{plugins => guides}/controllers/index.md | 8 +- .../events/api-events/index.md | 0 .../auth-strategy-authenticated/index.md | 2 +- .../events/core-auth-strategy-added/index.md | 2 +- .../core-auth-strategy-removed/index.md | 2 +- .../events/core-kuzzle-start/index.md | 0 .../events/core-overload/index.md | 0 .../events/http-delete/index.md | 0 .../events/http-get/index.md | 0 .../events/http-head/index.md | 0 .../events/http-options/index.md | 0 .../events/http-patch/index.md | 0 .../events/http-post/index.md | 0 .../events/http-put/index.md | 0 .../{plugins => guides}/events/index.md | 0 .../{plugins => guides}/events/intro/index.md | 2 +- .../events/notify-dispatch/index.md | 0 .../events/notify-document/index.md | 0 .../events/notify-server/index.md | 0 .../events/notify-user/index.md | 0 .../events/plugin-events/index.md | 2 +- .../events/request-on-authorized/index.md | 2 +- .../events/request-on-error/index.md | 2 +- .../events/request-on-success/index.md | 2 +- .../events/request-on-unauthorized/index.md | 0 .../events/room-new/index.md | 0 .../events/room-remove/index.md | 0 .../index.md | 0 .../{plugins => guides}/hooks/index.md | 6 +- .../1/plugins/{plugins => guides}/index.md | 2 +- .../manual-setup/config/index.md | 0 .../{plugins => guides}/manual-setup/index.md | 0 .../manual-setup/init-function/index.md | 0 .../manual-setup/prerequisites/index.md | 0 .../{plugins => guides}/pipes/index.md | 6 +- .../strategies/auth-functions/index.md | 4 +- .../{plugins => guides}/strategies/index.md | 0 .../strategies/overview/index.md | 10 +- .../plugin-context/accessors/execute/index.md | 2 +- .../plugin-context/accessors/sdk/index.md | 8 +- .../plugin-context/accessors/storage/index.md | 2 +- .../plugin-context/accessors/trigger/index.md | 2 +- .../accessors/validation/index.md | 2 +- .../constructors/basevalidationtype/index.md | 4 +- .../plugin-context/constructors/dsl/index.md | 2 +- .../constructors/repository/index.md | 2 +- .../constructors/request/index.md | 4 +- .../plugin-context/errors/intro/index.md | 4 +- .../plugin-context/errors/parseerror/index.md | 2 +- .../context/clientconnection/index.md | 0 .../{protocols => api}/context/debug/index.md | 0 .../context/errors/index.md | 0 .../{protocols => api}/context/index.md | 2 +- .../{protocols => api}/context/intro/index.md | 0 .../{protocols => api}/context/log/index.md | 0 .../context/request/index.md | 8 +- .../context/requestcontext/index.md | 0 .../context/requestinput/index.md | 0 .../entrypoint/execute/index.md | 0 .../{protocols => api}/entrypoint/index.md | 2 +- .../entrypoint/intro/index.md | 0 .../entrypoint/newconnection/index.md | 0 .../entrypoint/removeconnection/index.md | 0 .../1/protocols/{protocols => api}/index.md | 4 +- .../methods/broadcast/index.md | 0 .../methods/disconnect/index.md | 0 .../{protocols => api}/methods/index.md | 2 +- .../{protocols => api}/methods/init/index.md | 0 .../methods/joinchannel/index.md | 0 .../methods/leavechannel/index.md | 0 .../methods/notify/index.md | 0 .../essentials/getting-started/index.md | 0 .../{protocols => }/essentials/index.md | 0 .../native-protocols/http/index.md | 0 .../{protocols => }/native-protocols/index.md | 2 +- .../native-protocols/mqtt/index.md | 0 .../native-protocols/socketio/index.md | 0 .../native-protocols/websocket/index.md | 0 src/sdk/android/3/controllers/index.md | 7 - .../collection-mapping/apply/index.md | 0 .../apply/snippets/apply-1.java | 0 .../collection-mapping/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../collection-mapping/index.md | 0 .../collection-mapping/refresh/index.md | 0 .../refresh/snippets/refresh-1.java | 0 .../collection-mapping/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.java | 0 .../collection-mapping/set/index.md | 0 .../set/snippets/set-1.java | 0 .../collection/collection-mapping/index.md | 0 .../snippets/collection-mapping-1.java | 0 .../collection/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../collection/count/index.md | 0 .../collection/count/snippets/count-1.java | 0 .../collection/create-document/index.md | 0 .../snippets/create-document-1.java | 0 .../collection/create/index.md | 0 .../collection/create/snippets/create-1.java | 0 .../collection/delete-document/index.md | 0 .../snippets/delete-document-1.java | 0 .../collection/delete-specifications/index.md | 0 .../snippets/delete-specifications-1.java | 0 .../collection/document/index.md | 0 .../document/snippets/document-1.java | 0 .../collection/fetch-document/index.md | 0 .../snippets/fetch-document-1.java | 0 .../collection/get-mapping/index.md | 0 .../get-mapping/snippets/get-mapping-1.java | 0 .../collection/get-specifications/index.md | 0 .../snippets/get-specifications-1.java | 0 .../collection/index.md | 0 .../collection/mcreate-document/index.md | 0 .../snippets/mcreate-document-1.java | 0 .../mcreate-or-replace-document/index.md | 0 .../mcreate-or-replace-document-1.java | 0 .../collection/mdelete-document/index.md | 0 .../snippets/mdelete-document-1.java | 0 .../collection/mget-document/index.md | 0 .../snippets/mget-document-1.java | 0 .../collection/mreplace-document/index.md | 0 .../snippets/mreplace-document-1.java | 0 .../collection/mupdate-document/index.md | 0 .../snippets/mupdate-document-1.java | 0 .../collection/publish-message/index.md | 0 .../snippets/publish-message-1.java | 0 .../collection/replace-document/index.md | 0 .../snippets/replace-document-1.java | 0 .../collection/room/index.md | 0 .../collection/room/snippets/room-1.java | 0 .../collection/scroll-specifications/index.md | 0 .../snippets/scroll-specifications-1.java | 0 .../collection/scroll/index.md | 0 .../collection/scroll/snippets/scroll-1.java | 0 .../collection/search-specifications/index.md | 0 .../snippets/search-specifications-1.java | 0 .../collection/search/index.md | 0 .../collection/search/snippets/search-1.java | 0 .../collection/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.java | 0 .../collection/subscribe/index.md | 2 +- .../subscribe/snippets/subscribe-1.java | 0 .../collection/truncate/index.md | 0 .../truncate/snippets/truncate-1.java | 0 .../collection/update-document/index.md | 0 .../snippets/update-document-1.java | 0 .../collection/update-specifications/index.md | 0 .../snippets/update-specifications-1.java | 0 .../validate-specifications/index.md | 0 .../snippets/validate-specifications-1.java | 0 .../document/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../document/delete/index.md | 0 .../document/delete/snippets/delete-1.java | 0 .../document/exists/index.md | 0 .../document/exists/snippets/exists-1.java | 0 .../document/index.md | 0 .../document/publish/index.md | 0 .../document/publish/snippets/publish-1.java | 0 .../document/refresh/index.md | 0 .../document/refresh/snippets/refresh-1.java | 0 .../document/save/index.md | 0 .../document/save/snippets/save-1.java | 0 .../document/set-content/index.md | 0 .../set-content/snippets/set-content-1.java | 0 .../document/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.java | 0 .../document/subscribe/index.md | 4 +- .../subscribe/snippets/subscribe-1.java | 0 .../memory-storage/append/index.md | 0 .../append/snippets/append-1.java | 0 .../memory-storage/bitcount/index.md | 0 .../bitcount/snippets/bitcount-1.java | 0 .../memory-storage/bitop/index.md | 0 .../bitop/snippets/bitop-1.java | 0 .../memory-storage/bitpos/index.md | 0 .../bitpos/snippets/bitpos-1.java | 0 .../memory-storage/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../memory-storage/dbsize/index.md | 0 .../dbsize/snippets/dbsize-1.java | 0 .../memory-storage/decr/index.md | 0 .../memory-storage/decr/snippets/decr-1.java | 0 .../memory-storage/decrby/index.md | 0 .../decrby/snippets/decrby-1.java | 0 .../memory-storage/del/index.md | 0 .../memory-storage/del/snippets/del-1.java | 0 .../memory-storage/exists/index.md | 0 .../exists/snippets/exists-1.java | 0 .../memory-storage/expire/index.md | 0 .../expire/snippets/expire-1.java | 0 .../memory-storage/expireat/index.md | 0 .../expireat/snippets/expireat-1.java | 0 .../memory-storage/flushdb/index.md | 0 .../flushdb/snippets/flushdb-1.java | 0 .../memory-storage/geoadd/index.md | 0 .../geoadd/snippets/geoadd-1.java | 0 .../memory-storage/geodist/index.md | 0 .../geodist/snippets/geodist-1.java | 0 .../memory-storage/geohash/index.md | 0 .../geohash/snippets/geohash-1.java | 0 .../memory-storage/geopos/index.md | 0 .../geopos/snippets/geopos-1.java | 0 .../memory-storage/georadius/index.md | 0 .../georadius/snippets/georadius-1.java | 0 .../memory-storage/georadiusbymember/index.md | 0 .../snippets/georadiusbymember-1.java | 0 .../memory-storage/get/index.md | 0 .../memory-storage/get/snippets/get-1.java | 0 .../memory-storage/getbit/index.md | 0 .../getbit/snippets/getbit-1.java | 0 .../memory-storage/getrange/index.md | 0 .../getrange/snippets/getrange-1.java | 0 .../memory-storage/getset/index.md | 0 .../getset/snippets/getset-1.java | 0 .../memory-storage/hdel/index.md | 0 .../memory-storage/hdel/snippets/hdel-1.java | 0 .../memory-storage/hexists/index.md | 0 .../hexists/snippets/hexists-1.java | 0 .../memory-storage/hget/index.md | 0 .../memory-storage/hget/snippets/hget-1.java | 0 .../memory-storage/hgetall/index.md | 0 .../hgetall/snippets/hgetall-1.java | 0 .../memory-storage/hincrby/index.md | 0 .../hincrby/snippets/hincrby-1.java | 0 .../memory-storage/hincrbyfloat/index.md | 0 .../hincrbyfloat/snippets/hincrbyfloat-1.java | 0 .../memory-storage/hkeys/index.md | 0 .../hkeys/snippets/hkeys-1.java | 0 .../memory-storage/hlen/index.md | 0 .../memory-storage/hlen/snippets/hlen-1.java | 0 .../memory-storage/hmget/index.md | 0 .../hmget/snippets/hmget-1.java | 0 .../memory-storage/hmset/index.md | 0 .../hmset/snippets/hmset-1.java | 0 .../memory-storage/hscan/index.md | 0 .../hscan/snippets/hscan-1.java | 0 .../memory-storage/hset/index.md | 0 .../memory-storage/hset/snippets/hset-1.java | 0 .../memory-storage/hsetnx/index.md | 0 .../hsetnx/snippets/hsetnx-1.java | 0 .../memory-storage/hstrlen/index.md | 0 .../hstrlen/snippets/hstrlen-1.java | 0 .../memory-storage/hvals/index.md | 0 .../hvals/snippets/hvals-1.java | 0 .../memory-storage/incr/index.md | 0 .../memory-storage/incr/snippets/incr-1.java | 0 .../memory-storage/incrby/index.md | 0 .../incrby/snippets/incrby-1.java | 0 .../memory-storage/incrbyfloat/index.md | 0 .../incrbyfloat/snippets/incrbyfloat-1.java | 0 .../memory-storage/index.md | 0 .../memory-storage/keys/index.md | 0 .../memory-storage/keys/snippets/keys-1.java | 0 .../memory-storage/lindex/index.md | 0 .../lindex/snippets/lindex-1.java | 0 .../memory-storage/linsert/index.md | 0 .../linsert/snippets/linsert-1.java | 0 .../memory-storage/llen/index.md | 0 .../memory-storage/llen/snippets/llen-1.java | 0 .../memory-storage/lpop/index.md | 0 .../memory-storage/lpop/snippets/lpop-1.java | 0 .../memory-storage/lpush/index.md | 0 .../lpush/snippets/lpush-1.java | 0 .../memory-storage/lpushx/index.md | 0 .../lpushx/snippets/lpushx-1.java | 0 .../memory-storage/lrange/index.md | 0 .../lrange/snippets/lrange-1.java | 0 .../memory-storage/lrem/index.md | 0 .../memory-storage/lrem/snippets/lrem-1.java | 0 .../memory-storage/lset/index.md | 0 .../memory-storage/lset/snippets/lset-1.java | 0 .../memory-storage/ltrim/index.md | 0 .../ltrim/snippets/ltrim-1.java | 0 .../memory-storage/mget/index.md | 0 .../memory-storage/mget/snippets/mget-1.java | 0 .../memory-storage/mset/index.md | 0 .../memory-storage/mset/snippets/mset-1.java | 0 .../memory-storage/msetnx/index.md | 0 .../msetnx/snippets/msetnx-1.java | 0 .../memory-storage/object/index.md | 0 .../object/snippets/object-1.java | 0 .../memory-storage/persist/index.md | 0 .../persist/snippets/persist-1.java | 0 .../memory-storage/pexpire/index.md | 0 .../pexpire/snippets/pexpire-1.java | 0 .../memory-storage/pexpireat/index.md | 0 .../pexpireat/snippets/pexpireat-1.java | 0 .../memory-storage/pfadd/index.md | 0 .../pfadd/snippets/pfadd-1.java | 0 .../memory-storage/pfcount/index.md | 0 .../pfcount/snippets/pfcount-1.java | 0 .../memory-storage/pfmerge/index.md | 0 .../pfmerge/snippets/pfmerge-1.java | 0 .../memory-storage/ping/index.md | 0 .../memory-storage/ping/snippets/ping-1.java | 0 .../memory-storage/psetex/index.md | 0 .../psetex/snippets/psetex-1.java | 0 .../memory-storage/pttl/index.md | 0 .../memory-storage/pttl/snippets/pttl-1.java | 0 .../memory-storage/randomkey/index.md | 0 .../randomkey/snippets/randomkey-1.java | 0 .../memory-storage/rename/index.md | 0 .../rename/snippets/rename-1.java | 0 .../memory-storage/renamenx/index.md | 0 .../renamenx/snippets/renamenx-1.java | 0 .../memory-storage/rpop/index.md | 0 .../memory-storage/rpop/snippets/rpop-1.java | 0 .../memory-storage/rpoplpush/index.md | 0 .../rpoplpush/snippets/rpoplpush-1.java | 0 .../memory-storage/rpush/index.md | 0 .../rpush/snippets/rpush-1.java | 0 .../memory-storage/rpushx/index.md | 0 .../rpushx/snippets/rpushx-1.java | 0 .../memory-storage/sadd/index.md | 0 .../memory-storage/sadd/snippets/sadd-1.java | 0 .../memory-storage/scan/index.md | 0 .../memory-storage/scan/snippets/scan-1.java | 0 .../memory-storage/scard/index.md | 0 .../scard/snippets/scard-1.java | 0 .../memory-storage/sdiff/index.md | 0 .../sdiff/snippets/sdiff-1.java | 0 .../memory-storage/sdiffstore/index.md | 0 .../sdiffstore/snippets/sdiffstore-1.java | 0 .../memory-storage/set/index.md | 0 .../memory-storage/set/snippets/set-1.java | 0 .../memory-storage/setex/index.md | 0 .../setex/snippets/setex-1.java | 0 .../memory-storage/setnx/index.md | 0 .../setnx/snippets/setnx-1.java | 0 .../memory-storage/sinter/index.md | 0 .../sinter/snippets/sinter-1.java | 0 .../memory-storage/sinterstore/index.md | 0 .../sinterstore/snippets/sinterstore-1.java | 0 .../memory-storage/sismember/index.md | 0 .../sismember/snippets/sismember-1.java | 0 .../memory-storage/smembers/index.md | 0 .../smembers/snippets/smembers-1.java | 0 .../memory-storage/smove/index.md | 0 .../smove/snippets/smove-1.java | 0 .../memory-storage/sort/index.md | 0 .../memory-storage/sort/snippets/sort-1.java | 0 .../memory-storage/spop/index.md | 0 .../memory-storage/spop/snippets/spop-1.java | 0 .../memory-storage/srandmember/index.md | 0 .../srandmember/snippets/srandmember-1.java | 0 .../memory-storage/srem/index.md | 0 .../memory-storage/srem/snippets/srem-1.java | 0 .../memory-storage/sscan/index.md | 0 .../sscan/snippets/sscan-1.java | 0 .../memory-storage/strlen/index.md | 0 .../strlen/snippets/strlen-1.java | 0 .../memory-storage/sunion/index.md | 0 .../sunion/snippets/sunion-1.java | 0 .../memory-storage/sunionstore/index.md | 0 .../sunionstore/snippets/sunionstore-1.java | 0 .../memory-storage/time/index.md | 0 .../memory-storage/time/snippets/time-1.java | 0 .../memory-storage/touch/index.md | 0 .../touch/snippets/touch-1.java | 0 .../memory-storage/ttl/index.md | 0 .../memory-storage/ttl/snippets/ttl-1.java | 0 .../memory-storage/type/index.md | 0 .../memory-storage/type/snippets/type-1.java | 0 .../memory-storage/zadd/index.md | 0 .../memory-storage/zadd/snippets/zadd-1.java | 0 .../memory-storage/zcard/index.md | 0 .../zcard/snippets/zcard-1.java | 0 .../memory-storage/zcount/index.md | 0 .../zcount/snippets/zcount-1.java | 0 .../memory-storage/zincrby/index.md | 0 .../zincrby/snippets/zincrby-1.java | 0 .../memory-storage/zinterstore/index.md | 0 .../zinterstore/snippets/zinterstore-1.java | 0 .../memory-storage/zlexcount/index.md | 0 .../zlexcount/snippets/zlexcount-1.java | 0 .../memory-storage/zrange/index.md | 0 .../zrange/snippets/zrange-1.java | 0 .../memory-storage/zrangebylex/index.md | 0 .../zrangebylex/snippets/zrangebylex-1.java | 0 .../memory-storage/zrangebyscore/index.md | 0 .../snippets/zrangebyscore-1.java | 0 .../memory-storage/zrank/index.md | 0 .../zrank/snippets/zrank-1.java | 0 .../memory-storage/zrem/index.md | 0 .../memory-storage/zrem/snippets/zrem-1.java | 0 .../memory-storage/zremrangebylex/index.md | 0 .../snippets/zremrangebylex-1.java | 0 .../memory-storage/zremrangebyrank/index.md | 0 .../snippets/zremrangebyrank-1.java | 0 .../memory-storage/zremrangebyscore/index.md | 0 .../snippets/zremrangebyscore-1.java | 0 .../memory-storage/zrevrange/index.md | 0 .../zrevrange/snippets/zrevrange-1.java | 0 .../memory-storage/zrevrangebylex/index.md | 0 .../snippets/zrevrangebylex-1.java | 0 .../memory-storage/zrevrangebyscore/index.md | 0 .../snippets/zrevrangebyscore-1.java | 0 .../memory-storage/zrevrank/index.md | 0 .../zrevrank/snippets/zrevrank-1.java | 0 .../memory-storage/zscan/index.md | 0 .../zscan/snippets/zscan-1.java | 0 .../memory-storage/zscore/index.md | 0 .../zscore/snippets/zscore-1.java | 0 .../memory-storage/zunionstore/index.md | 0 .../zunionstore/snippets/zunionstore-1.java | 0 .../profile/add-policy/index.md | 0 .../add-policy/snippets/add-policy-1.java | 0 .../profile/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../profile/delete/index.md | 0 .../profile/delete/snippets/delete-1.java | 0 .../profile/get-policies/index.md | 0 .../get-policies/snippets/get-policies-1.java | 0 .../profile/index.md | 0 .../profile/save/index.md | 0 .../profile/save/snippets/save-1.java | 0 .../profile/set-content/index.md | 0 .../set-content/snippets/set-content-1.java | 0 .../profile/set-policies/index.md | 0 .../set-policies/snippets/set-policies-1.java | 0 .../profile/update/index.md | 0 .../profile/update/snippets/update-1.java | 0 .../role/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../role/delete/index.md | 0 .../role/delete/snippets/delete-1.java | 0 .../role/index.md | 0 .../role/save/index.md | 0 .../role/save/snippets/save-1.java | 0 .../role/set-content/index.md | 0 .../set-content/snippets/set-content-1.java | 0 .../role/update/index.md | 0 .../role/update/snippets/update-1.java | 0 .../room/constructor/index.md | 6 +- .../constructor/snippets/constructor-1.java | 0 .../room/count/index.md | 0 .../room/count/snippets/count-1.java | 0 .../room/index.md | 0 .../room/renew/index.md | 2 +- .../room/renew/snippets/renew-1.java | 0 .../room/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.java | 0 .../room/unsubscribe/index.md | 0 .../unsubscribe/snippets/unsubscribe-1.java | 0 .../search-result/constructor/index.md | 0 .../search-result/fetch-next/index.md | 0 .../fetch-next/snippets/fetch-next-1.java | 0 .../fetch-next/snippets/fetch-next-2.java | 0 .../search-result/index.md | 0 .../security/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../security/create-credentials/index.md | 0 .../snippets/create-credentials-1.java | 0 .../security/create-profile/index.md | 0 .../snippets/create-profile-1.java | 0 .../security/create-restricted-user/index.md | 0 .../snippets/create-restricted-user-1.java | 0 .../security/create-role/index.md | 0 .../create-role/snippets/create-role-1.java | 0 .../security/create-user/index.md | 0 .../create-user/snippets/create-user-1.java | 0 .../security/delete-credentials/index.md | 0 .../snippets/delete-credentials-1.java | 0 .../security/delete-profile/index.md | 0 .../snippets/delete-profile-1.java | 0 .../security/delete-role/index.md | 0 .../delete-role/snippets/delete-role-1.java | 0 .../security/delete-user/index.md | 0 .../delete-user/snippets/delete-user-1.java | 0 .../security/fetch-profile/index.md | 0 .../snippets/fetch-profile-1.java | 0 .../security/fetch-role/index.md | 0 .../fetch-role/snippets/fetch-role-1.java | 0 .../security/fetch-user/index.md | 0 .../fetch-user/snippets/fetch-user-1.java | 0 .../get-all-credential-fields/index.md | 0 .../snippets/get-all-credential-fields-1.java | 0 .../security/get-credentials-fields/index.md | 0 .../snippets/get-credentials-fields-1.java | 0 .../security/get-credentials/index.md | 0 .../snippets/get-credentials-1.java | 0 .../security/get-user-rights/index.md | 0 .../snippets/get-user-rights-1.java | 0 .../security/has-credentials/index.md | 0 .../snippets/has-credentials-1.java | 0 .../security/index.md | 0 .../security/is-action-allowed/index.md | 0 .../snippets/is-action-allowed-1.java | 0 .../security/profile/index.md | 0 .../security/profile/snippets/profile-1.java | 0 .../security/replace-user/index.md | 0 .../replace-user/snippets/replace-user-1.java | 0 .../security/role/index.md | 0 .../security/role/snippets/role-1.java | 0 .../security/scroll-profiles/index.md | 0 .../snippets/scroll-profiles-1.java | 0 .../security/scroll-users/index.md | 0 .../scroll-users/snippets/scroll-users-1.java | 0 .../security/search-profiles/index.md | 0 .../snippets/search-profiles-1.java | 0 .../security/search-roles/index.md | 0 .../search-roles/snippets/search-roles-1.java | 0 .../security/search-users/index.md | 0 .../search-users/snippets/search-users-1.java | 0 .../security/update-credentials/index.md | 0 .../snippets/update-credentials-1.java | 0 .../security/update-profile/index.md | 0 .../snippets/update-profile-1.java | 0 .../security/update-role/index.md | 0 .../update-role/snippets/update-role-1.java | 0 .../security/update-user/index.md | 0 .../update-user/snippets/update-user-1.java | 0 .../security/user/index.md | 0 .../security/user/snippets/user-1.java | 0 .../security/validate-credentials/index.md | 0 .../snippets/validate-credentials-1.java | 0 .../user/add-profile/index.md | 0 .../add-profile/snippets/add-profile-1.java | 0 .../user/constructor/index.md | 0 .../constructor/snippets/constructor-1.java | 0 .../user/create/index.md | 0 .../user/create/snippets/create-1.java | 0 .../user/delete/index.md | 0 .../user/delete/snippets/delete-1.java | 0 .../user/get-profileids/index.md | 0 .../snippets/get-profileids-1.java | 0 .../user/get-profiles/index.md | 0 .../get-profiles/snippets/get-profiles-1.java | 0 .../user/index.md | 0 .../user/replace/index.md | 0 .../user/replace/snippets/replace-1.java | 0 .../user/save-restricted/index.md | 0 .../snippets/save-restricted-1.java | 0 .../user/save/index.md | 0 .../user/save/snippets/save-1.java | 0 .../user/set-content/index.md | 0 .../set-content/snippets/set-content-1.java | 0 .../user/set-credentials/index.md | 0 .../snippets/set-credentials-1.java | 0 .../user/set-profiles/index.md | 0 .../set-profiles/snippets/set-profiles-1.java | 0 .../user/update/index.md | 0 .../user/update/snippets/update-1.java | 0 .../index.md | 0 .../snippets/handling-errors-1.java | 0 .../{offline-first => offline-tools}/index.md | 8 +- .../index.md | 4 +- src/sdk/cpp/1/controllers/auth/login/index.md | 6 +- src/sdk/go/1/controllers/auth/login/index.md | 4 +- .../protocols/http/index.md | 0 .../1/{core-structs => }/protocols/index.md | 2 +- .../protocols/socketio/index.md | 0 .../protocols/websocket/index.md | 0 .../java/1/controllers/auth/login/index.md | 4 +- .../protocol => protocols}/http/index.md | 0 .../protocol => protocols}/index.md | 2 +- .../protocol => protocols}/socketio/index.md | 0 .../protocol => protocols}/websocket/index.md | 0 .../collection-mapping/apply/index.md | 0 .../apply/snippets/apply-1.js | 0 .../collection-mapping/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../collection-mapping/index.md | 0 .../collection-mapping/refresh/index.md | 0 .../refresh/snippets/refresh-1.js | 0 .../collection-mapping/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.js | 0 .../collection-mapping/set/index.md | 0 .../collection-mapping/set/snippets/set-1.js | 0 .../collection/collection-mapping/index.md | 0 .../snippets/collection-mapping-1.js | 0 .../collection/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../collection/count/index.md | 0 .../collection/count/snippets/count-1.js | 0 .../collection/count/snippets/count-2.js | 0 .../collection/create-document/index.md | 0 .../snippets/create-document-1.js | 0 .../collection/create/index.md | 0 .../collection/create/snippets/create-1.js | 0 .../collection/create/snippets/create-2.js | 0 .../collection/delete-document/index.md | 0 .../snippets/delete-document-1.js | 0 .../snippets/delete-document-2.js | 0 .../collection/delete-specifications/index.md | 0 .../snippets/delete-specifications-1.js | 0 .../snippets/delete-specifications-2.js | 0 .../collection/document/index.md | 0 .../document/snippets/document-1.js | 0 .../collection/fetch-document/index.md | 0 .../snippets/fetch-document-1.js | 0 .../collection/get-mapping/index.md | 0 .../get-mapping/snippets/get-mapping-1.js | 0 .../collection/get-specifications/index.md | 0 .../snippets/get-specifications-1.js | 0 .../snippets/get-specifications-2.js | 0 .../5/{ => core-classes}/collection/index.md | 0 .../collection/mcreate-document/index.md | 0 .../snippets/mcreate-document-1.js | 0 .../snippets/mcreate-document-2.js | 0 .../mcreate-or-replace-document/index.md | 0 .../snippets/mcreate-or-replace-document-1.js | 0 .../snippets/mcreate-or-replace-document-2.js | 0 .../collection/mdelete-document/index.md | 0 .../snippets/mdelete-document-1.js | 0 .../snippets/mdelete-document-2.js | 0 .../collection/mget-document/index.md | 0 .../mget-document/snippets/mget-document-1.js | 0 .../mget-document/snippets/mget-document-2.js | 0 .../collection/mreplace-document/index.md | 0 .../snippets/mreplace-document-1.js | 0 .../snippets/mreplace-document-2.js | 0 .../collection/mupdate-document/index.md | 0 .../snippets/mupdate-document-1.js | 0 .../snippets/mupdate-document-2.js | 0 .../collection/publish-message/index.md | 0 .../snippets/publish-message-1.js | 0 .../collection/replace-document/index.md | 0 .../snippets/replace-document-1.js | 0 .../collection/room/index.md | 0 .../collection/room/snippets/room-1.js | 0 .../collection/scroll-specifications/index.md | 0 .../snippets/scroll-specifications-1.js | 0 .../snippets/scroll-specifications-2.js | 0 .../collection/scroll/index.md | 0 .../collection/scroll/snippets/scroll-1.js | 0 .../collection/search-specifications/index.md | 0 .../snippets/search-specifications-1.js | 0 .../snippets/search-specifications-2.js | 0 .../collection/search/index.md | 0 .../collection/search/snippets/search-1.js | 0 .../collection/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.js | 0 .../collection/subscribe/index.md | 2 +- .../subscribe/snippets/subscribe-1.js | 0 .../collection/truncate/index.md | 0 .../truncate/snippets/truncate-1.js | 0 .../truncate/snippets/truncate-2.js | 0 .../collection/update-document/index.md | 0 .../snippets/update-document-1.js | 0 .../collection/update-specifications/index.md | 0 .../snippets/update-specifications-1.js | 0 .../snippets/update-specifications-2.js | 0 .../validate-specifications/index.md | 0 .../snippets/validate-specifications-1.js | 0 .../document/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../document/delete/index.md | 0 .../document/delete/snippets/delete-1.js | 0 .../document/exists/index.md | 0 .../document/exists/snippets/exists-1.js | 0 .../js/5/{ => core-classes}/document/index.md | 0 .../document/publish/index.md | 0 .../document/publish/snippets/publish-1.js | 0 .../document/refresh/index.md | 0 .../document/refresh/snippets/refresh-1.js | 0 .../{ => core-classes}/document/save/index.md | 0 .../document/save/snippets/save-1.js | 0 .../document/set-content/index.md | 0 .../set-content/snippets/set-content-1.js | 0 .../document/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.js | 0 .../document/subscribe/index.md | 4 +- .../subscribe/snippets/subscribe-1.js | 0 src/sdk/js/5/core-classes/index.md | 7 + .../kuzzle/add-listener/index.md | 0 .../add-listener/snippets/add-listener-1.js | 0 .../kuzzle/check-token/index.md | 0 .../check-token/snippets/check-token-1.js | 0 .../check-token/snippets/check-token-2.js | 0 .../check-token/snippets/check-token-3.js | 0 .../kuzzle/collection/index.md | 0 .../collection/snippets/collection-1.js | 0 .../kuzzle/connect/index.md | 0 .../kuzzle/connect/snippets/connect-1.js | 0 .../kuzzle/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../kuzzle/create-index/index.md | 0 .../create-index/snippets/create-index-1.js | 0 .../create-index/snippets/create-index-2.js | 0 .../kuzzle/create-my-credentials/index.md | 0 .../snippets/create-my-credentials-1.js | 0 .../kuzzle/delete-my-credentials/index.md | 0 .../snippets/delete-my-credentials-1.js | 0 .../kuzzle/disconnect/index.md | 0 .../disconnect/snippets/disconnect-1.js | 0 .../kuzzle/flush-queue/index.md | 0 .../flush-queue/snippets/flush-queue-1.js | 0 .../kuzzle/get-all-statistics/index.md | 0 .../snippets/get-all-statistics-1.js | 0 .../snippets/get-all-statistics-2.js | 0 .../kuzzle/get-auto-refresh/index.md | 0 .../snippets/get-auto-refresh-1.js | 0 .../kuzzle/get-jwt-token/index.md | 0 .../get-jwt-token/snippets/get-jwt-token-1.js | 0 .../kuzzle/get-my-credentials/index.md | 0 .../snippets/get-my-credentials-1.js | 0 .../snippets/get-my-credentials-2.js | 0 .../kuzzle/get-my-rights/index.md | 0 .../get-my-rights/snippets/get-my-rights-1.js | 0 .../get-my-rights/snippets/get-my-rights-2.js | 0 .../kuzzle/get-server-info/index.md | 0 .../snippets/get-server-info-1.js | 0 .../snippets/get-server-info-2.js | 0 .../kuzzle/get-statistics/index.md | 0 .../snippets/get-statistics-1.js | 0 .../snippets/get-statistics-2.js | 0 .../snippets/get-statistics-3.js | 0 .../snippets/get-statistics-4.js | 0 .../js/5/{ => core-classes}/kuzzle/index.md | 0 .../kuzzle/list-collections/index.md | 0 .../snippets/list-collections-1.js | 0 .../snippets/list-collections-2.js | 0 .../kuzzle/list-indexes/index.md | 0 .../list-indexes/snippets/list-indexes-1.js | 0 .../list-indexes/snippets/list-indexes-2.js | 0 .../{ => core-classes}/kuzzle/login/index.md | 0 .../kuzzle/login/snippets/login-1.js | 0 .../{ => core-classes}/kuzzle/logout/index.md | 0 .../kuzzle/logout/snippets/logout-1.js | 0 .../kuzzle/memory-storage/index.md | 0 .../5/{ => core-classes}/kuzzle/now/index.md | 0 .../kuzzle/now/snippets/now-1.js | 0 .../kuzzle/now/snippets/now-2.js | 0 .../{ => core-classes}/kuzzle/query/index.md | 0 .../kuzzle/query/snippets/query-1.js | 0 .../kuzzle/query/snippets/query-2.js | 0 .../kuzzle/refresh-index/index.md | 0 .../refresh-index/snippets/refresh-index-1.js | 0 .../kuzzle/remove-all-listeners/index.md | 0 .../snippets/remove-all-listeners-1.js | 0 .../kuzzle/remove-listener/index.md | 0 .../snippets/remove-listener-1.js | 0 .../kuzzle/replay-queue/index.md | 0 .../replay-queue/snippets/replay-queue-1.js | 0 .../kuzzle/security/index.md | 0 .../kuzzle/set-auto-refresh/index.md | 0 .../snippets/set-auto-refresh-1.js | 0 .../kuzzle/set-default-index/index.md | 0 .../snippets/set-default-index-1.js | 0 .../kuzzle/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.js | 0 .../kuzzle/set-jwt-token/index.md | 0 .../set-jwt-token/snippets/set-jwt-token-1.js | 0 .../kuzzle/start-queuing/index.md | 0 .../start-queuing/snippets/start-queuing-1.js | 0 .../kuzzle/stop-queuing/index.md | 0 .../stop-queuing/snippets/stop-queuing-1.js | 0 .../kuzzle/unset-jwt-token/index.md | 0 .../snippets/unset-jwt-token-1.js | 0 .../kuzzle/update-my-credentials/index.md | 0 .../snippets/update-my-credentials-1.js | 0 .../kuzzle/update-self/index.md | 0 .../update-self/snippets/update-self-1.js | 0 .../kuzzle/validate-my-credentials/index.md | 0 .../snippets/validate-my-credentials-1.js | 0 .../kuzzle/who-am-i/index.md | 0 .../kuzzle/who-am-i/snippets/who-am-i-1.js | 0 .../memory-storage/append/index.md | 0 .../append/snippets/append-1.js | 0 .../append/snippets/append-2.js | 0 .../memory-storage/bitcount/index.md | 0 .../bitcount/snippets/bitcount-1.js | 0 .../bitcount/snippets/bitcount-2.js | 0 .../memory-storage/bitop/index.md | 0 .../memory-storage/bitop/snippets/bitop-1.js | 0 .../memory-storage/bitop/snippets/bitop-2.js | 0 .../memory-storage/bitpos/index.md | 0 .../bitpos/snippets/bitpos-1.js | 0 .../bitpos/snippets/bitpos-2.js | 0 .../memory-storage/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../memory-storage/dbsize/index.md | 0 .../dbsize/snippets/dbsize-1.js | 0 .../dbsize/snippets/dbsize-2.js | 0 .../memory-storage/decr/index.md | 0 .../memory-storage/decr/snippets/decr-1.js | 0 .../memory-storage/decr/snippets/decr-2.js | 0 .../memory-storage/decrby/index.md | 0 .../decrby/snippets/decrby-1.js | 0 .../decrby/snippets/decrby-2.js | 0 .../memory-storage/del/index.md | 0 .../memory-storage/del/snippets/del-1.js | 0 .../memory-storage/del/snippets/del-2.js | 0 .../memory-storage/exists/index.md | 0 .../exists/snippets/exists-1.js | 0 .../exists/snippets/exists-2.js | 0 .../memory-storage/expire/index.md | 0 .../expire/snippets/expire-1.js | 0 .../expire/snippets/expire-2.js | 0 .../memory-storage/expireat/index.md | 0 .../expireat/snippets/expireat-1.js | 0 .../expireat/snippets/expireat-2.js | 0 .../memory-storage/flushdb/index.md | 0 .../flushdb/snippets/flushdb-1.js | 0 .../memory-storage/geoadd/index.md | 0 .../geoadd/snippets/geoadd-1.js | 0 .../geoadd/snippets/geoadd-2.js | 0 .../memory-storage/geodist/index.md | 0 .../geodist/snippets/geodist-1.js | 0 .../geodist/snippets/geodist-2.js | 0 .../memory-storage/geohash/index.md | 0 .../geohash/snippets/geohash-1.js | 0 .../geohash/snippets/geohash-2.js | 0 .../memory-storage/geopos/index.md | 0 .../geopos/snippets/geopos-1.js | 0 .../geopos/snippets/geopos-2.js | 0 .../memory-storage/georadius/index.md | 0 .../georadius/snippets/georadius-1.js | 0 .../georadius/snippets/georadius-2.js | 0 .../georadius/snippets/georadius-3.js | 0 .../georadius/snippets/georadius-4.js | 0 .../memory-storage/georadiusbymember/index.md | 0 .../snippets/georadiusbymember-1.js | 0 .../snippets/georadiusbymember-2.js | 0 .../snippets/georadiusbymember-3.js | 0 .../snippets/georadiusbymember-4.js | 0 .../memory-storage/get/index.md | 0 .../memory-storage/get/snippets/get-1.js | 0 .../memory-storage/get/snippets/get-2.js | 0 .../memory-storage/getbit/index.md | 0 .../getbit/snippets/getbit-1.js | 0 .../getbit/snippets/getbit-2.js | 0 .../memory-storage/getrange/index.md | 0 .../getrange/snippets/getrange-1.js | 0 .../getrange/snippets/getrange-2.js | 0 .../memory-storage/getset/index.md | 0 .../getset/snippets/getset-1.js | 0 .../getset/snippets/getset-2.js | 0 .../memory-storage/hdel/index.md | 0 .../memory-storage/hdel/snippets/hdel-1.js | 0 .../memory-storage/hdel/snippets/hdel-2.js | 0 .../memory-storage/hexists/index.md | 0 .../hexists/snippets/hexists-1.js | 0 .../hexists/snippets/hexists-2.js | 0 .../memory-storage/hget/index.md | 0 .../memory-storage/hget/snippets/hget-1.js | 0 .../memory-storage/hget/snippets/hget-2.js | 0 .../memory-storage/hgetall/index.md | 0 .../hgetall/snippets/hgetall-1.js | 0 .../hgetall/snippets/hgetall-2.js | 0 .../memory-storage/hincrby/index.md | 0 .../hincrby/snippets/hincrby-1.js | 0 .../hincrby/snippets/hincrby-2.js | 0 .../memory-storage/hincrbyfloat/index.md | 0 .../hincrbyfloat/snippets/hincrbyfloat-1.js | 0 .../hincrbyfloat/snippets/hincrbyfloat-2.js | 0 .../memory-storage/hkeys/index.md | 0 .../memory-storage/hkeys/snippets/hkeys-1.js | 0 .../memory-storage/hkeys/snippets/hkeys-2.js | 0 .../memory-storage/hlen/index.md | 0 .../memory-storage/hlen/snippets/hlen-1.js | 0 .../memory-storage/hlen/snippets/hlen-2.js | 0 .../memory-storage/hmget/index.md | 0 .../memory-storage/hmget/snippets/hmget-1.js | 0 .../memory-storage/hmget/snippets/hmget-2.js | 0 .../memory-storage/hmset/index.md | 0 .../memory-storage/hmset/snippets/hmset-1.js | 0 .../memory-storage/hscan/index.md | 0 .../memory-storage/hscan/snippets/hscan-1.js | 0 .../memory-storage/hscan/snippets/hscan-2.js | 0 .../memory-storage/hset/index.md | 0 .../memory-storage/hset/snippets/hset-1.js | 0 .../memory-storage/hset/snippets/hset-2.js | 0 .../memory-storage/hsetnx/index.md | 0 .../hsetnx/snippets/hsetnx-1.js | 0 .../hsetnx/snippets/hsetnx-2.js | 0 .../memory-storage/hstrlen/index.md | 0 .../hstrlen/snippets/hstrlen-1.js | 0 .../hstrlen/snippets/hstrlen-2.js | 0 .../memory-storage/hvals/index.md | 0 .../memory-storage/hvals/snippets/hvals-1.js | 0 .../memory-storage/hvals/snippets/hvals-2.js | 0 .../memory-storage/incr/index.md | 0 .../memory-storage/incr/snippets/incr-1.js | 0 .../memory-storage/incr/snippets/incr-2.js | 0 .../memory-storage/incrby/index.md | 0 .../incrby/snippets/incrby-1.js | 0 .../incrby/snippets/incrby-2.js | 0 .../memory-storage/incrbyfloat/index.md | 0 .../incrbyfloat/snippets/incrbyfloat-1.js | 0 .../incrbyfloat/snippets/incrbyfloat-2.js | 0 .../memory-storage/index.md | 0 .../memory-storage/keys/index.md | 0 .../memory-storage/keys/snippets/keys-1.js | 0 .../memory-storage/keys/snippets/keys-2.js | 0 .../memory-storage/lindex/index.md | 0 .../lindex/snippets/lindex-1.js | 0 .../lindex/snippets/lindex-2.js | 0 .../memory-storage/linsert/index.md | 0 .../linsert/snippets/linsert-1.js | 0 .../linsert/snippets/linsert-2.js | 0 .../memory-storage/llen/index.md | 0 .../memory-storage/llen/snippets/llen-1.js | 0 .../memory-storage/llen/snippets/llen-2.js | 0 .../memory-storage/lpop/index.md | 0 .../memory-storage/lpop/snippets/lpop-1.js | 0 .../memory-storage/lpop/snippets/lpop-2.js | 0 .../memory-storage/lpush/index.md | 0 .../memory-storage/lpush/snippets/lpush-1.js | 0 .../memory-storage/lpush/snippets/lpush-2.js | 0 .../memory-storage/lpushx/index.md | 0 .../lpushx/snippets/lpushx-1.js | 0 .../lpushx/snippets/lpushx-2.js | 0 .../memory-storage/lrange/index.md | 0 .../lrange/snippets/lrange-1.js | 0 .../lrange/snippets/lrange-2.js | 0 .../memory-storage/lrem/index.md | 0 .../memory-storage/lrem/snippets/lrem-1.js | 0 .../memory-storage/lrem/snippets/lrem-2.js | 0 .../memory-storage/lset/index.md | 0 .../memory-storage/lset/snippets/lset-1.js | 0 .../memory-storage/ltrim/index.md | 0 .../memory-storage/ltrim/snippets/ltrim-1.js | 0 .../memory-storage/mget/index.md | 0 .../memory-storage/mget/snippets/mget-1.js | 0 .../memory-storage/mget/snippets/mget-2.js | 0 .../memory-storage/mset/index.md | 0 .../memory-storage/mset/snippets/mset-1.js | 0 .../memory-storage/msetnx/index.md | 0 .../msetnx/snippets/msetnx-1.js | 0 .../msetnx/snippets/msetnx-2.js | 0 .../memory-storage/object/index.md | 0 .../object/snippets/object-1.js | 0 .../object/snippets/object-2.js | 0 .../memory-storage/persist/index.md | 0 .../persist/snippets/persist-1.js | 0 .../persist/snippets/persist-2.js | 0 .../memory-storage/pexpire/index.md | 0 .../pexpire/snippets/pexpire-1.js | 0 .../pexpire/snippets/pexpire-2.js | 0 .../memory-storage/pexpireat/index.md | 0 .../pexpireat/snippets/pexpireat-1.js | 0 .../pexpireat/snippets/pexpireat-2.js | 0 .../memory-storage/pfadd/index.md | 0 .../memory-storage/pfadd/snippets/pfadd-1.js | 0 .../memory-storage/pfadd/snippets/pfadd-2.js | 0 .../memory-storage/pfcount/index.md | 0 .../pfcount/snippets/pfcount-1.js | 0 .../pfcount/snippets/pfcount-2.js | 0 .../memory-storage/pfmerge/index.md | 0 .../pfmerge/snippets/pfmerge-1.js | 0 .../memory-storage/ping/index.md | 0 .../memory-storage/ping/snippets/ping-1.js | 0 .../memory-storage/ping/snippets/ping-2.js | 0 .../memory-storage/psetex/index.md | 0 .../psetex/snippets/psetex-1.js | 0 .../memory-storage/pttl/index.md | 0 .../memory-storage/pttl/snippets/pttl-1.js | 0 .../memory-storage/pttl/snippets/pttl-2.js | 0 .../memory-storage/randomkey/index.md | 0 .../randomkey/snippets/randomkey-1.js | 0 .../randomkey/snippets/randomkey-2.js | 0 .../memory-storage/rename/index.md | 0 .../rename/snippets/rename-1.js | 0 .../memory-storage/renamenx/index.md | 0 .../renamenx/snippets/renamenx-1.js | 0 .../renamenx/snippets/renamenx-2.js | 0 .../memory-storage/rpop/index.md | 0 .../memory-storage/rpop/snippets/rpop-1.js | 0 .../memory-storage/rpop/snippets/rpop-2.js | 0 .../memory-storage/rpoplpush/index.md | 0 .../rpoplpush/snippets/rpoplpush-1.js | 0 .../rpoplpush/snippets/rpoplpush-2.js | 0 .../memory-storage/rpush/index.md | 0 .../memory-storage/rpush/snippets/rpush-1.js | 0 .../memory-storage/rpush/snippets/rpush-2.js | 0 .../memory-storage/rpushx/index.md | 0 .../rpushx/snippets/rpushx-1.js | 0 .../rpushx/snippets/rpushx-2.js | 0 .../memory-storage/sadd/index.md | 0 .../memory-storage/sadd/snippets/sadd-1.js | 0 .../memory-storage/sadd/snippets/sadd-2.js | 0 .../memory-storage/scan/index.md | 0 .../memory-storage/scan/snippets/scan-1.js | 0 .../memory-storage/scan/snippets/scan-2.js | 0 .../memory-storage/scard/index.md | 0 .../memory-storage/scard/snippets/scard-1.js | 0 .../memory-storage/scard/snippets/scard-2.js | 0 .../memory-storage/sdiff/index.md | 0 .../memory-storage/sdiff/snippets/sdiff-1.js | 0 .../memory-storage/sdiff/snippets/sdiff-2.js | 0 .../memory-storage/sdiffstore/index.md | 0 .../sdiffstore/snippets/sdiffstore-1.js | 0 .../sdiffstore/snippets/sdiffstore-2.js | 0 .../memory-storage/set/index.md | 0 .../memory-storage/set/snippets/set-1.js | 0 .../memory-storage/setex/index.md | 0 .../memory-storage/setex/snippets/setex-1.js | 0 .../memory-storage/setnx/index.md | 0 .../memory-storage/setnx/snippets/setnx-1.js | 0 .../memory-storage/setnx/snippets/setnx-2.js | 0 .../memory-storage/sinter/index.md | 0 .../sinter/snippets/sinter-1.js | 0 .../sinter/snippets/sinter-2.js | 0 .../memory-storage/sinterstore/index.md | 0 .../sinterstore/snippets/sinterstore-1.js | 0 .../sinterstore/snippets/sinterstore-2.js | 0 .../memory-storage/sismember/index.md | 0 .../sismember/snippets/sismember-1.js | 0 .../sismember/snippets/sismember-2.js | 0 .../memory-storage/smembers/index.md | 0 .../smembers/snippets/smembers-1.js | 0 .../smembers/snippets/smembers-2.js | 0 .../memory-storage/smove/index.md | 0 .../memory-storage/smove/snippets/smove-1.js | 0 .../memory-storage/smove/snippets/smove-2.js | 0 .../memory-storage/sort/index.md | 0 .../memory-storage/sort/snippets/sort-1.js | 0 .../memory-storage/sort/snippets/sort-2.js | 0 .../memory-storage/spop/index.md | 0 .../memory-storage/spop/snippets/spop-1.js | 0 .../memory-storage/spop/snippets/spop-2.js | 0 .../memory-storage/srandmember/index.md | 0 .../srandmember/snippets/srandmember-1.js | 0 .../srandmember/snippets/srandmember-2.js | 0 .../memory-storage/srem/index.md | 0 .../memory-storage/srem/snippets/srem-1.js | 0 .../memory-storage/srem/snippets/srem-2.js | 0 .../memory-storage/sscan/index.md | 0 .../memory-storage/sscan/snippets/sscan-1.js | 0 .../memory-storage/sscan/snippets/sscan-2.js | 0 .../memory-storage/strlen/index.md | 0 .../strlen/snippets/strlen-1.js | 0 .../strlen/snippets/strlen-2.js | 0 .../memory-storage/sunion/index.md | 0 .../sunion/snippets/sunion-1.js | 0 .../sunion/snippets/sunion-2.js | 0 .../memory-storage/sunionstore/index.md | 0 .../sunionstore/snippets/sunionstore-1.js | 0 .../sunionstore/snippets/sunionstore-2.js | 0 .../memory-storage/time/index.md | 0 .../memory-storage/time/snippets/time-1.js | 0 .../memory-storage/time/snippets/time-2.js | 0 .../memory-storage/touch/index.md | 0 .../memory-storage/touch/snippets/touch-1.js | 0 .../memory-storage/touch/snippets/touch-2.js | 0 .../memory-storage/ttl/index.md | 0 .../memory-storage/ttl/snippets/ttl-1.js | 0 .../memory-storage/ttl/snippets/ttl-2.js | 0 .../memory-storage/type/index.md | 0 .../memory-storage/type/snippets/type-1.js | 0 .../memory-storage/type/snippets/type-2.js | 0 .../memory-storage/zadd/index.md | 0 .../memory-storage/zadd/snippets/zadd-1.js | 0 .../memory-storage/zadd/snippets/zadd-2.js | 0 .../memory-storage/zcard/index.md | 0 .../memory-storage/zcard/snippets/zcard-1.js | 0 .../memory-storage/zcard/snippets/zcard-2.js | 0 .../memory-storage/zcount/index.md | 0 .../zcount/snippets/zcount-1.js | 0 .../zcount/snippets/zcount-2.js | 0 .../memory-storage/zincrby/index.md | 0 .../zincrby/snippets/zincrby-1.js | 0 .../zincrby/snippets/zincrby-2.js | 0 .../memory-storage/zinterstore/index.md | 0 .../zinterstore/snippets/zinterstore-1.js | 0 .../zinterstore/snippets/zinterstore-2.js | 0 .../memory-storage/zlexcount/index.md | 0 .../zlexcount/snippets/zlexcount-1.js | 0 .../zlexcount/snippets/zlexcount-2.js | 0 .../memory-storage/zrange/index.md | 0 .../zrange/snippets/zrange-1.js | 0 .../zrange/snippets/zrange-2.js | 0 .../memory-storage/zrangebylex/index.md | 0 .../zrangebylex/snippets/zrangebylex-1.js | 0 .../zrangebylex/snippets/zrangebylex-2.js | 0 .../memory-storage/zrangebyscore/index.md | 0 .../zrangebyscore/snippets/zrangebyscore-1.js | 0 .../zrangebyscore/snippets/zrangebyscore-2.js | 0 .../memory-storage/zrank/index.md | 0 .../memory-storage/zrank/snippets/zrank-1.js | 0 .../memory-storage/zrank/snippets/zrank-2.js | 0 .../memory-storage/zrem/index.md | 0 .../memory-storage/zrem/snippets/zrem-1.js | 0 .../memory-storage/zrem/snippets/zrem-2.js | 0 .../memory-storage/zremrangebylex/index.md | 0 .../snippets/zremrangebylex-1.js | 0 .../snippets/zremrangebylex-2.js | 0 .../memory-storage/zremrangebyrank/index.md | 0 .../snippets/zremrangebyrank-1.js | 0 .../snippets/zremrangebyrank-2.js | 0 .../memory-storage/zremrangebyscore/index.md | 0 .../snippets/zremrangebyscore-1.js | 0 .../snippets/zremrangebyscore-2.js | 0 .../memory-storage/zrevrange/index.md | 0 .../zrevrange/snippets/zrevrange-1.js | 0 .../zrevrange/snippets/zrevrange-2.js | 0 .../memory-storage/zrevrangebylex/index.md | 0 .../snippets/zrevrangebylex-1.js | 0 .../snippets/zrevrangebylex-2.js | 0 .../memory-storage/zrevrangebyscore/index.md | 0 .../snippets/zrevrangebyscore-1.js | 0 .../snippets/zrevrangebyscore-2.js | 0 .../memory-storage/zrevrank/index.md | 0 .../zrevrank/snippets/zrevrank-1.js | 0 .../zrevrank/snippets/zrevrank-2.js | 0 .../memory-storage/zscan/index.md | 0 .../memory-storage/zscan/snippets/zscan-1.js | 0 .../memory-storage/zscan/snippets/zscan-2.js | 0 .../memory-storage/zscore/index.md | 0 .../zscore/snippets/zscore-1.js | 0 .../zscore/snippets/zscore-2.js | 0 .../memory-storage/zunionstore/index.md | 0 .../zunionstore/snippets/zunionstore-1.js | 0 .../zunionstore/snippets/zunionstore-2.js | 0 .../profile/add-policy/index.md | 0 .../add-policy/snippets/add-policy-1.js | 0 .../profile/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../profile/delete/index.md | 0 .../profile/delete/snippets/delete-1.js | 0 .../profile/get-policies/index.md | 0 .../get-policies/snippets/get-policies-1.js | 0 .../get-policies/snippets/get-policies-2.js | 0 .../js/5/{ => core-classes}/profile/index.md | 0 .../{ => core-classes}/profile/save/index.md | 0 .../profile/save/snippets/save-1.js | 0 .../profile/set-content/index.md | 0 .../set-content/snippets/set-content-1.js | 0 .../profile/set-policies/index.md | 0 .../set-policies/snippets/set-policies-1.js | 0 .../profile/update/index.md | 0 .../profile/update/snippets/update-1.js | 0 .../role/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../5/{ => core-classes}/role/delete/index.md | 0 .../role/delete/snippets/delete-1.js | 0 src/sdk/js/5/{ => core-classes}/role/index.md | 0 .../5/{ => core-classes}/role/save/index.md | 0 .../role/save/snippets/save-1.js | 0 .../role/set-content/index.md | 0 .../set-content/snippets/set-content-1.js | 0 .../5/{ => core-classes}/role/update/index.md | 0 .../role/update/snippets/update-1.js | 0 .../room/constructor/index.md | 6 +- .../constructor/snippets/constructor-1.js | 0 .../5/{ => core-classes}/room/count/index.md | 0 .../room/count/snippets/count-1.js | 0 .../room/count/snippets/count-2.js | 0 src/sdk/js/5/{ => core-classes}/room/index.md | 0 .../5/{ => core-classes}/room/renew/index.md | 2 +- .../room/renew/snippets/renew-1.js | 0 .../room/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.js | 0 .../room/unsubscribe/index.md | 0 .../unsubscribe/snippets/unsubscribe-1.js | 0 .../search-result/constructor/index.md | 0 .../search-result/fetch-next/index.md | 0 .../fetch-next/snippets/fetch-next-1.js | 0 .../fetch-next/snippets/fetch-next-2.js | 0 .../{ => core-classes}/search-result/index.md | 0 .../security/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../security/create-credentials/index.md | 0 .../snippets/create-credentials-1.js | 0 .../snippets/create-credentials-2.js | 0 .../security/create-profile/index.md | 0 .../snippets/create-profile-1.js | 0 .../security/create-restricted-user/index.md | 0 .../snippets/create-restricted-user-1.js | 0 .../security/create-role/index.md | 0 .../create-role/snippets/create-role-1.js | 0 .../security/create-user/index.md | 0 .../create-user/snippets/create-user-1.js | 0 .../security/delete-credentials/index.md | 0 .../snippets/delete-credentials-1.js | 0 .../snippets/delete-credentials-2.js | 0 .../security/delete-profile/index.md | 0 .../snippets/delete-profile-1.js | 0 .../snippets/delete-profile-2.js | 0 .../security/delete-role/index.md | 0 .../delete-role/snippets/delete-role-1.js | 0 .../delete-role/snippets/delete-role-2.js | 0 .../security/delete-user/index.md | 0 .../delete-user/snippets/delete-user-1.js | 0 .../delete-user/snippets/delete-user-2.js | 0 .../security/fetch-profile/index.md | 0 .../fetch-profile/snippets/fetch-profile-1.js | 0 .../security/fetch-role/index.md | 0 .../fetch-role/snippets/fetch-role-1.js | 0 .../security/fetch-user/index.md | 0 .../fetch-user/snippets/fetch-user-1.js | 0 .../get-all-credential-fields/index.md | 0 .../snippets/get-all-credential-fields-1.js | 0 .../snippets/get-all-credential-fields-2.js | 0 .../security/get-credentials-fields/index.md | 0 .../snippets/get-credentials-fields-1.js | 0 .../snippets/get-credentials-fields-2.js | 0 .../security/get-credentials/index.md | 0 .../snippets/get-credentials-1.js | 0 .../snippets/get-credentials-2.js | 0 .../security/get-user-rights/index.md | 0 .../snippets/get-user-rights-1.js | 0 .../snippets/get-user-rights-2.js | 0 .../security/has-credentials/index.md | 0 .../snippets/has-credentials-1.js | 0 .../js/5/{ => core-classes}/security/index.md | 0 .../security/is-action-allowed/index.md | 0 .../snippets/is-action-allowed-1.js | 0 .../security/profile/index.md | 0 .../security/profile/snippets/profile-1.js | 0 .../security/replace-user/index.md | 0 .../replace-user/snippets/replace-user-1.js | 0 .../{ => core-classes}/security/role/index.md | 0 .../security/role/snippets/role-1.js | 0 .../security/scroll-profiles/index.md | 0 .../snippets/scroll-profiles-1.js | 0 .../security/scroll-users/index.md | 0 .../scroll-users/snippets/scroll-users-1.js | 0 .../security/search-profiles/index.md | 0 .../snippets/search-profiles-1.js | 0 .../snippets/search-profiles-2.js | 0 .../security/search-roles/index.md | 0 .../search-roles/snippets/search-roles-1.js | 0 .../search-roles/snippets/search-roles-2.js | 0 .../security/search-users/index.md | 0 .../search-users/snippets/search-users-1.js | 0 .../search-users/snippets/search-users-2.js | 0 .../security/update-credentials/index.md | 0 .../snippets/update-credentials-1.js | 0 .../snippets/update-credentials-2.js | 0 .../security/update-profile/index.md | 0 .../snippets/update-profile-1.js | 0 .../security/update-role/index.md | 0 .../update-role/snippets/update-role-1.js | 0 .../security/update-user/index.md | 0 .../update-user/snippets/update-user-1.js | 0 .../{ => core-classes}/security/user/index.md | 0 .../security/user/snippets/user-1.js | 0 .../security/validate-credentials/index.md | 0 .../snippets/validate-credentials-1.js | 0 .../snippets/validate-credentials-2.js | 0 .../user/add-profile/index.md | 0 .../add-profile/snippets/add-profile-1.js | 0 .../user/constructor/index.md | 0 .../constructor/snippets/constructor-1.js | 0 .../5/{ => core-classes}/user/create/index.md | 0 .../user/create/snippets/create-1.js | 0 .../5/{ => core-classes}/user/delete/index.md | 0 .../user/delete/snippets/delete-1.js | 0 .../user/get-profileids/index.md | 0 .../snippets/get-profileids-1.js | 0 .../user/get-profiles/index.md | 0 .../get-profiles/snippets/get-profiles-1.js | 0 src/sdk/js/5/{ => core-classes}/user/index.md | 0 .../{ => core-classes}/user/replace/index.md | 0 .../user/replace/snippets/replace-1.js | 0 .../user/save-restricted/index.md | 0 .../snippets/save-restricted-1.js | 0 .../5/{ => core-classes}/user/save/index.md | 0 .../user/save/snippets/save-1.js | 0 .../user/set-content/index.md | 0 .../set-content/snippets/set-content-1.js | 0 .../user/set-credentials/index.md | 0 .../snippets/set-credentials-1.js | 0 .../user/set-profiles/index.md | 0 .../set-profiles/snippets/set-profiles-1.js | 0 .../5/{ => core-classes}/user/update/index.md | 0 .../user/update/snippets/update-1.js | 0 .../error-handling}/index.md | 0 .../snippets/handling-errors-1.js | 0 src/sdk/js/5/{ => essentials}/events/index.md | 0 src/sdk/js/5/essentials/index.md | 7 + .../offline-tools}/index.md | 8 +- .../realtime-notifications}/index.md | 4 +- .../snippets/notifications-1.js | 0 .../snippets/notifications-2.js | 0 .../snippets/notifications-3.js | 0 .../snippets/notifications-4.js | 0 .../snippets/notifications-5.js | 0 src/sdk/js/6/controllers/auth/login/index.md | 2 +- 1661 files changed, 631 insertions(+), 121 deletions(-) create mode 100644 redirections.yml rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/dump/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/reset-cache/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/reset-database/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/reset-kuzzle-data/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/reset-security/index.md (100%) rename src/core/1/api/{api-reference/controller-admin => controllers/admin}/shutdown/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/check-token/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/create-my-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/credentials-exists/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/delete-my-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/get-current-user/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/get-my-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/get-my-rights/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/get-strategies/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/login/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/logout/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/update-my-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/update-self/index.md (100%) rename src/core/1/api/{api-reference/controller-auth => controllers/auth}/validate-my-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-bulk => controllers/bulk}/import/index.md (100%) rename src/core/1/api/{api-reference/controller-bulk => controllers/bulk}/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/create/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/delete-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/exists/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/get-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/get-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/list/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/scroll-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/search-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/truncate/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/update-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/update-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-collection => controllers/collection}/validate-specifications/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/count/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/create-or-replace/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/create/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/delete-by-query/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/delete/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/get/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-create-or-replace/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-create/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-delete/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-get/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-replace/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/m-update/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/replace/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/scroll/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/search/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/update/index.md (100%) rename src/core/1/api/{api-reference/controller-document => controllers/document}/validate/index.md (100%) rename src/core/1/api/{api-reference => controllers}/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/create/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/delete/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/exists/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/get-auto-refresh/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/list/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/m-delete/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/refresh-internal/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/refresh/index.md (100%) rename src/core/1/api/{api-reference/controller-index => controllers/index}/set-auto-refresh/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/append/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/bitcount/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/bitop/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/bitpos/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/dbsize/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/decr/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/decrby/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/del/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/exists/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/expire/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/expireat/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/flushdb/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/geoadd/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/geodist/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/geohash/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/geopos/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/georadius/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/georadiusbymember/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/get/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/getbit/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/getrange/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/getset/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hdel/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hexists/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hget/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hgetall/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hincrby/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hincrbyfloat/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hkeys/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hlen/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hmget/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hmset/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hscan/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hset/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hsetnx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hstrlen/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/hvals/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/incr/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/incrby/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/incrbyfloat/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/keys/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lindex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/linsert/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/llen/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lpop/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lpush/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lpushx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lrange/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lrem/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/lset/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/ltrim/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/mget/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/mset/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/msetnx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/object/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/persist/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pexpire/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pexpireat/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pfadd/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pfcount/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pfmerge/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/ping/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/psetex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/pttl/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/randomkey/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/rename/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/renamenx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/rpop/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/rpoplpush/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/rpush/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/rpushx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sadd/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/scan/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/scard/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sdiff/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sdiffstore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/set/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/setex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/setnx/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sinter/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sinterstore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sismember/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/smembers/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/smove/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sort/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/spop/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/srandmember/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/srem/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sscan/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/strlen/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sunion/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/sunionstore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/time/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/touch/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/ttl/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/type/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zadd/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zcard/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zcount/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zincrby/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zinterstore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zlexcount/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrange/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrangebylex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrangebyscore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrank/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrem/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zremrangebylex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zremrangebyrank/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zremrangebyscore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrevrange/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrevrangebylex/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrevrangebyscore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zrevrank/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zscan/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zscore/index.md (100%) rename src/core/1/api/{api-reference/controller-memory-storage => controllers/memory-storage}/zunionstore/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/count/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/join/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/list/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/publish/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/subscribe/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/unsubscribe/index.md (100%) rename src/core/1/api/{api-reference/controller-realtime => controllers/realtime}/validate/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-first-admin/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-or-replace-profile/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-or-replace-role/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-profile/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-restricted-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-role/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/create-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/delete-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/delete-profile/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/delete-role/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/delete-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-all-credential-fields/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-credential-fields/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-credentials-by-id/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-profile-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-profile-rights/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-profile/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-role-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-role/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-user-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-user-rights/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/get-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/has-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/m-delete-profiles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/m-delete-roles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/m-delete-users/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/m-get-profiles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/m-get-roles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/replace-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/scroll-profiles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/scroll-users/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/search-profiles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/search-roles/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/search-users/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-profile-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-profile/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-role-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-role/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-user-mapping/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/update-user/index.md (100%) rename src/core/1/api/{api-reference/controller-security => controllers/security}/validate-credentials/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/admin-exists/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/get-all-stats/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/get-config/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/get-last-stats/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/get-stats/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/info/index.md (100%) rename src/core/1/api/{api-reference/controller-server => controllers/server}/now/index.md (100%) delete mode 100644 src/core/1/guide/guides/index.md rename src/core/1/{guide => guides}/code-examples/dbsearch/android/androidstudio_project_databasesearch.png (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/android/androidstudio_project_noactivity.png (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/android/index.md (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/go/index.md (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/index.md (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/introduction/index.md (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/index.md (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/connect.js (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/connect.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/create.js (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/create.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/final.js (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/final.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/load-sdk.js (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/load-sdk.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/search.js (100%) rename src/core/1/{guide => guides}/code-examples/dbsearch/javascript/snippets/search.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/android/androidstudio_project_geofencing.png (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/android/androidstudio_project_noactivity.png (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/android/index.md (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/go/index.md (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/index.md (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/introduction/index.md (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/index.md (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/createdoc.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/createdoc.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/definearea.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/definearea.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/geofenc.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/geofenc.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/load-sdk.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/load-sdk.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/location.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/location.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/subscribe.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/subscribe.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/updatedoc.js (100%) rename src/core/1/{guide => guides}/code-examples/geofencing/javascript/snippets/updatedoc.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/index.md (88%) rename src/core/1/{guide => guides}/code-examples/iot/android/androidstudio_project_iot.png (100%) rename src/core/1/{guide => guides}/code-examples/iot/android/androidstudio_project_noactivity.png (100%) rename src/core/1/{guide => guides}/code-examples/iot/android/index.md (100%) rename src/core/1/{guide => guides}/code-examples/iot/go/index.md (100%) rename src/core/1/{guide => guides}/code-examples/iot/index.md (100%) rename src/core/1/{guide => guides}/code-examples/iot/introduction/index.md (100%) rename src/core/1/{guide => guides}/code-examples/iot/javascript/index.md (100%) rename src/core/1/{guide => guides}/code-examples/iot/javascript/snippets/publish.js (100%) rename src/core/1/{guide => guides}/code-examples/iot/javascript/snippets/publish.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/iot/javascript/snippets/subscribe.js (100%) rename src/core/1/{guide => guides}/code-examples/iot/javascript/snippets/subscribe.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/android/androidstudio_project_noactivity.png (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/android/androidstudio_project_pubsub.png (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/android/index.md (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/go/index.md (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/index.md (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/introduction/index.md (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/index.md (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/load-sdk.js (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/load-sdk.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/publish.js (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/publish.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/pubsubjs.js (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/pubsubjs.test.yml (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/subscribe.js (100%) rename src/core/1/{guide => guides}/code-examples/pubsub/javascript/snippets/subscribe.test.yml (100%) rename src/core/1/{guide => guides}/cookbooks/datavalidation/fields/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/datavalidation/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/datavalidation/introduction/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/datavalidation/schema/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/datavalidation/validators/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/basic-queries/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/bool-query/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/data-insertion/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/installation/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/introduction/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/elasticsearch/useful-commands/index.md (100%) rename src/core/1/{guide => guides}/cookbooks/index.md (86%) rename src/core/1/{guide => }/guides/essentials/cli/index.md (100%) rename src/core/1/{guide => }/guides/essentials/configuration/index.md (100%) rename src/core/1/{guide => }/guides/essentials/data-validation/index.md (100%) rename src/core/1/{guide => }/guides/essentials/database-mappings/index.md (100%) rename src/core/1/{guide => }/guides/essentials/document-metadata/index.md (96%) rename src/core/1/{guide => }/guides/essentials/index.md (100%) rename src/core/1/{guide => }/guides/essentials/installing-console/index.md (97%) rename src/core/1/{guide => }/guides/essentials/installing-console/kuzbo-connecting.png (100%) rename src/core/1/{guide => }/guides/essentials/installing-console/kuzbo-firstadmin.png (100%) rename src/core/1/{guide => }/guides/essentials/installing-kuzzle/index.md (100%) rename src/core/1/{guide => }/guides/essentials/introduction/index.md (100%) rename src/core/1/{guide => }/guides/essentials/persisted/index.md (100%) rename src/core/1/{guide => }/guides/essentials/plugins/index.md (100%) rename src/core/1/{guide => }/guides/essentials/real-time/index.md (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-filter.js (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-filter.test.yml (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-no-filter.js (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-no-filter.test.yml (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-options.js (100%) rename src/core/1/{guide => }/guides/essentials/real-time/snippets/subscribe-options.test.yml (100%) rename src/core/1/{guide => }/guides/essentials/request-and-response-format/index.md (100%) rename src/core/1/{guide => }/guides/essentials/security/index.md (95%) rename src/core/1/{guide => }/guides/essentials/security/profiles-roles.png (100%) rename src/core/1/{guide => }/guides/essentials/signal-handling/index.md (100%) rename src/core/1/{guide => }/guides/essentials/user-authentication/index.md (100%) rename src/core/1/{guide => }/guides/essentials/user-authentication/snippets/login.js (100%) rename src/core/1/{guide => }/guides/essentials/user-authentication/snippets/login.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/index.md (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/create.js (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/create.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/init-sample.js (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/init-sample.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/init.js (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/init.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/load-sdk.js (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/load-sdk.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/subscribe.js (100%) rename src/core/1/{guide => }/guides/getting-started/first-steps/snippets/subscribe.test.yml (100%) rename src/core/1/{guide => }/guides/getting-started/index.md (100%) rename src/core/1/{guide => }/guides/getting-started/running-kuzzle/index.md (100%) rename src/core/1/{guide => guides}/index.md (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/architecture/Kuzzle_Server_Architecture.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/architecture/index.md (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/authentication/Authentication_Overview.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/authentication/details-local.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/authentication/details-oauth2.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/authentication/index.md (98%) rename src/core/1/{guide => }/guides/kuzzle-depth/index.md (88%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Overview.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Directly.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Indirectly.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Subscription.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Overview.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Sequence.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Overview.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Sequence.png (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/request-life-cycle/index.md (100%) rename src/core/1/{guide => }/guides/kuzzle-depth/roles-definitions/index.md (100%) rename src/core/1/plugins/{plugins => }/essentials/available-plugins/index.md (100%) rename src/core/1/plugins/{plugins => }/essentials/getting-started/index.md (89%) rename src/core/1/plugins/{plugins => }/essentials/index.md (100%) rename src/core/1/plugins/{plugins => }/essentials/introduction/index.md (64%) rename src/core/1/plugins/{plugins => guides}/controllers/index.md (96%) rename src/core/1/plugins/{plugins => guides}/events/api-events/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/auth-strategy-authenticated/index.md (96%) rename src/core/1/plugins/{plugins => guides}/events/core-auth-strategy-added/index.md (95%) rename src/core/1/plugins/{plugins => guides}/events/core-auth-strategy-removed/index.md (94%) rename src/core/1/plugins/{plugins => guides}/events/core-kuzzle-start/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/core-overload/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-delete/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-get/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-head/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-options/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-patch/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-post/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/http-put/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/intro/index.md (57%) rename src/core/1/plugins/{plugins => guides}/events/notify-dispatch/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/notify-document/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/notify-server/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/notify-user/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/plugin-events/index.md (98%) rename src/core/1/plugins/{plugins => guides}/events/request-on-authorized/index.md (83%) rename src/core/1/plugins/{plugins => guides}/events/request-on-error/index.md (82%) rename src/core/1/plugins/{plugins => guides}/events/request-on-success/index.md (82%) rename src/core/1/plugins/{plugins => guides}/events/request-on-unauthorized/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/room-new/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/room-remove/index.md (100%) rename src/core/1/plugins/{plugins => guides}/events/security-format-user-for-serialization/index.md (100%) rename src/core/1/plugins/{plugins => guides}/hooks/index.md (81%) rename src/core/1/plugins/{plugins => guides}/index.md (54%) rename src/core/1/plugins/{plugins => guides}/manual-setup/config/index.md (100%) rename src/core/1/plugins/{plugins => guides}/manual-setup/index.md (100%) rename src/core/1/plugins/{plugins => guides}/manual-setup/init-function/index.md (100%) rename src/core/1/plugins/{plugins => guides}/manual-setup/prerequisites/index.md (100%) rename src/core/1/plugins/{plugins => guides}/pipes/index.md (87%) rename src/core/1/plugins/{plugins => guides}/strategies/auth-functions/index.md (99%) rename src/core/1/plugins/{plugins => guides}/strategies/index.md (100%) rename src/core/1/plugins/{plugins => guides}/strategies/overview/index.md (93%) rename src/core/1/protocols/{protocols => api}/context/clientconnection/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/debug/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/errors/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/index.md (86%) rename src/core/1/protocols/{protocols => api}/context/intro/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/log/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/request/index.md (91%) rename src/core/1/protocols/{protocols => api}/context/requestcontext/index.md (100%) rename src/core/1/protocols/{protocols => api}/context/requestinput/index.md (100%) rename src/core/1/protocols/{protocols => api}/entrypoint/execute/index.md (100%) rename src/core/1/protocols/{protocols => api}/entrypoint/index.md (87%) rename src/core/1/protocols/{protocols => api}/entrypoint/intro/index.md (100%) rename src/core/1/protocols/{protocols => api}/entrypoint/newconnection/index.md (100%) rename src/core/1/protocols/{protocols => api}/entrypoint/removeconnection/index.md (100%) rename src/core/1/protocols/{protocols => api}/index.md (75%) rename src/core/1/protocols/{protocols => api}/methods/broadcast/index.md (100%) rename src/core/1/protocols/{protocols => api}/methods/disconnect/index.md (100%) rename src/core/1/protocols/{protocols => api}/methods/index.md (90%) rename src/core/1/protocols/{protocols => api}/methods/init/index.md (100%) rename src/core/1/protocols/{protocols => api}/methods/joinchannel/index.md (100%) rename src/core/1/protocols/{protocols => api}/methods/leavechannel/index.md (100%) rename src/core/1/protocols/{protocols => api}/methods/notify/index.md (100%) rename src/core/1/protocols/{protocols => }/essentials/getting-started/index.md (100%) rename src/core/1/protocols/{protocols => }/essentials/index.md (100%) rename src/core/1/protocols/{protocols => }/native-protocols/http/index.md (100%) rename src/core/1/protocols/{protocols => }/native-protocols/index.md (91%) rename src/core/1/protocols/{protocols => }/native-protocols/mqtt/index.md (100%) rename src/core/1/protocols/{protocols => }/native-protocols/socketio/index.md (100%) rename src/core/1/protocols/{protocols => }/native-protocols/websocket/index.md (100%) delete mode 100644 src/sdk/android/3/controllers/index.md rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/apply/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/apply/snippets/apply-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/refresh/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/refresh/snippets/refresh-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/set-headers/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/set-headers/snippets/set-headers-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/set/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection-mapping/set/snippets/set-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/collection-mapping/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/collection-mapping/snippets/collection-mapping-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/count/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/count/snippets/count-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/create-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/create-document/snippets/create-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/create/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/create/snippets/create-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/delete-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/delete-document/snippets/delete-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/delete-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/delete-specifications/snippets/delete-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/document/snippets/document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/fetch-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/fetch-document/snippets/fetch-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/get-mapping/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/get-mapping/snippets/get-mapping-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/get-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/get-specifications/snippets/get-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mcreate-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mcreate-document/snippets/mcreate-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mcreate-or-replace-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mdelete-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mdelete-document/snippets/mdelete-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mget-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mget-document/snippets/mget-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mreplace-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mreplace-document/snippets/mreplace-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mupdate-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/mupdate-document/snippets/mupdate-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/publish-message/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/publish-message/snippets/publish-message-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/replace-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/replace-document/snippets/replace-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/room/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/room/snippets/room-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/scroll-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/scroll-specifications/snippets/scroll-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/scroll/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/scroll/snippets/scroll-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/search-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/search-specifications/snippets/search-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/search/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/search/snippets/search-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/set-headers/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/set-headers/snippets/set-headers-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/subscribe/index.md (98%) rename src/sdk/android/3/{controllers => core-classes}/collection/subscribe/snippets/subscribe-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/truncate/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/truncate/snippets/truncate-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/update-document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/update-document/snippets/update-document-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/update-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/update-specifications/snippets/update-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/validate-specifications/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/collection/validate-specifications/snippets/validate-specifications-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/delete/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/delete/snippets/delete-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/exists/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/exists/snippets/exists-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/publish/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/publish/snippets/publish-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/refresh/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/refresh/snippets/refresh-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/save/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/save/snippets/save-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/set-content/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/set-content/snippets/set-content-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/set-headers/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/document/set-headers/snippets/set-headers-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/document/subscribe/index.md (89%) rename src/sdk/android/3/{controllers => core-classes}/document/subscribe/snippets/subscribe-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/append/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/append/snippets/append-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitcount/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitcount/snippets/bitcount-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitop/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitop/snippets/bitop-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitpos/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/bitpos/snippets/bitpos-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/dbsize/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/dbsize/snippets/dbsize-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/decr/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/decr/snippets/decr-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/decrby/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/decrby/snippets/decrby-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/del/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/del/snippets/del-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/exists/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/exists/snippets/exists-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/expire/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/expire/snippets/expire-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/expireat/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/expireat/snippets/expireat-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/flushdb/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/flushdb/snippets/flushdb-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geoadd/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geoadd/snippets/geoadd-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geodist/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geodist/snippets/geodist-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geohash/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geohash/snippets/geohash-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geopos/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/geopos/snippets/geopos-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/georadius/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/georadius/snippets/georadius-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/georadiusbymember/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/get/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/get/snippets/get-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getbit/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getbit/snippets/getbit-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getrange/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getrange/snippets/getrange-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getset/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/getset/snippets/getset-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hdel/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hdel/snippets/hdel-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hexists/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hexists/snippets/hexists-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hget/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hget/snippets/hget-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hgetall/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hgetall/snippets/hgetall-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hincrby/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hincrby/snippets/hincrby-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hincrbyfloat/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hkeys/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hkeys/snippets/hkeys-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hlen/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hlen/snippets/hlen-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hmget/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hmget/snippets/hmget-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hmset/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hmset/snippets/hmset-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hscan/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hscan/snippets/hscan-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hset/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hset/snippets/hset-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hsetnx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hsetnx/snippets/hsetnx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hstrlen/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hstrlen/snippets/hstrlen-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hvals/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/hvals/snippets/hvals-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incr/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incr/snippets/incr-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incrby/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incrby/snippets/incrby-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incrbyfloat/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/incrbyfloat/snippets/incrbyfloat-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/keys/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/keys/snippets/keys-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lindex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lindex/snippets/lindex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/linsert/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/linsert/snippets/linsert-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/llen/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/llen/snippets/llen-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpop/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpop/snippets/lpop-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpush/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpush/snippets/lpush-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpushx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lpushx/snippets/lpushx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lrange/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lrange/snippets/lrange-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lrem/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lrem/snippets/lrem-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lset/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/lset/snippets/lset-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ltrim/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ltrim/snippets/ltrim-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/mget/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/mget/snippets/mget-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/mset/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/mset/snippets/mset-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/msetnx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/msetnx/snippets/msetnx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/object/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/object/snippets/object-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/persist/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/persist/snippets/persist-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pexpire/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pexpire/snippets/pexpire-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pexpireat/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pexpireat/snippets/pexpireat-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfadd/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfadd/snippets/pfadd-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfcount/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfcount/snippets/pfcount-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfmerge/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pfmerge/snippets/pfmerge-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ping/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ping/snippets/ping-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/psetex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/psetex/snippets/psetex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pttl/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/pttl/snippets/pttl-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/randomkey/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/randomkey/snippets/randomkey-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rename/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rename/snippets/rename-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/renamenx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/renamenx/snippets/renamenx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpop/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpop/snippets/rpop-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpoplpush/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpoplpush/snippets/rpoplpush-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpush/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpush/snippets/rpush-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpushx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/rpushx/snippets/rpushx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sadd/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sadd/snippets/sadd-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/scan/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/scan/snippets/scan-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/scard/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/scard/snippets/scard-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sdiff/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sdiff/snippets/sdiff-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sdiffstore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sdiffstore/snippets/sdiffstore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/set/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/set/snippets/set-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/setex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/setex/snippets/setex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/setnx/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/setnx/snippets/setnx-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sinter/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sinter/snippets/sinter-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sinterstore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sinterstore/snippets/sinterstore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sismember/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sismember/snippets/sismember-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/smembers/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/smembers/snippets/smembers-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/smove/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/smove/snippets/smove-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sort/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sort/snippets/sort-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/spop/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/spop/snippets/spop-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/srandmember/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/srandmember/snippets/srandmember-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/srem/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/srem/snippets/srem-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sscan/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sscan/snippets/sscan-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/strlen/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/strlen/snippets/strlen-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sunion/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sunion/snippets/sunion-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sunionstore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/sunionstore/snippets/sunionstore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/time/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/time/snippets/time-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/touch/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/touch/snippets/touch-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ttl/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/ttl/snippets/ttl-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/type/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/type/snippets/type-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zadd/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zadd/snippets/zadd-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zcard/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zcard/snippets/zcard-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zcount/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zcount/snippets/zcount-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zincrby/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zincrby/snippets/zincrby-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zinterstore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zinterstore/snippets/zinterstore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zlexcount/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zlexcount/snippets/zlexcount-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrange/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrange/snippets/zrange-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrangebylex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrangebylex/snippets/zrangebylex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrangebyscore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrangebyscore/snippets/zrangebyscore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrank/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrank/snippets/zrank-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrem/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrem/snippets/zrem-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebylex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebylex/snippets/zremrangebylex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebyrank/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebyscore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrange/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrange/snippets/zrevrange-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrangebylex/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrangebyscore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrank/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zrevrank/snippets/zrevrank-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zscan/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zscan/snippets/zscan-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zscore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zscore/snippets/zscore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zunionstore/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/memory-storage/zunionstore/snippets/zunionstore-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/add-policy/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/add-policy/snippets/add-policy-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/delete/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/delete/snippets/delete-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/get-policies/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/get-policies/snippets/get-policies-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/save/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/save/snippets/save-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/set-content/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/set-content/snippets/set-content-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/set-policies/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/set-policies/snippets/set-policies-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/update/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/profile/update/snippets/update-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/role/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/role/delete/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/delete/snippets/delete-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/save/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/save/snippets/save-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/role/set-content/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/set-content/snippets/set-content-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/role/update/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/role/update/snippets/update-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/room/constructor/index.md (79%) rename src/sdk/android/3/{controllers => core-classes}/room/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/room/count/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/room/count/snippets/count-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/room/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/room/renew/index.md (92%) rename src/sdk/android/3/{controllers => core-classes}/room/renew/snippets/renew-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/room/set-headers/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/room/set-headers/snippets/set-headers-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/room/unsubscribe/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/room/unsubscribe/snippets/unsubscribe-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/search-result/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/search-result/fetch-next/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/search-result/fetch-next/snippets/fetch-next-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/search-result/fetch-next/snippets/fetch-next-2.java (100%) rename src/sdk/android/3/{controllers => core-classes}/search-result/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-credentials/snippets/create-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-profile/snippets/create-profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-restricted-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-restricted-user/snippets/create-restricted-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-role/snippets/create-role-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/create-user/snippets/create-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-credentials/snippets/delete-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-profile/snippets/delete-profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-role/snippets/delete-role-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/delete-user/snippets/delete-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-profile/snippets/fetch-profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-role/snippets/fetch-role-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/fetch-user/snippets/fetch-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-all-credential-fields/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-all-credential-fields/snippets/get-all-credential-fields-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-credentials-fields/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-credentials-fields/snippets/get-credentials-fields-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-credentials/snippets/get-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-user-rights/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/get-user-rights/snippets/get-user-rights-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/has-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/has-credentials/snippets/has-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/is-action-allowed/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/is-action-allowed/snippets/is-action-allowed-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/profile/snippets/profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/replace-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/replace-user/snippets/replace-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/role/snippets/role-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/scroll-profiles/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/scroll-profiles/snippets/scroll-profiles-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/scroll-users/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/scroll-users/snippets/scroll-users-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-profiles/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-profiles/snippets/search-profiles-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-roles/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-roles/snippets/search-roles-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-users/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/search-users/snippets/search-users-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-credentials/snippets/update-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-profile/snippets/update-profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-role/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-role/snippets/update-role-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/update-user/snippets/update-user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/user/snippets/user-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/security/validate-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/security/validate-credentials/snippets/validate-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/add-profile/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/add-profile/snippets/add-profile-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/constructor/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/constructor/snippets/constructor-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/create/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/create/snippets/create-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/delete/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/delete/snippets/delete-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/get-profileids/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/get-profileids/snippets/get-profileids-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/get-profiles/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/get-profiles/snippets/get-profiles-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/replace/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/replace/snippets/replace-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/save-restricted/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/save-restricted/snippets/save-restricted-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/save/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/save/snippets/save-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-content/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-content/snippets/set-content-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-credentials/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-credentials/snippets/set-credentials-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-profiles/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/set-profiles/snippets/set-profiles-1.java (100%) rename src/sdk/android/3/{controllers => core-classes}/user/update/index.md (100%) rename src/sdk/android/3/{controllers => core-classes}/user/update/snippets/update-1.java (100%) rename src/sdk/android/3/essentials/{handling-errors => error-handling}/index.md (100%) rename src/sdk/android/3/essentials/{handling-errors => error-handling}/snippets/handling-errors-1.java (100%) rename src/sdk/android/3/essentials/{offline-first => offline-tools}/index.md (98%) rename src/sdk/android/3/essentials/{notifications => realtime-notifications}/index.md (98%) rename src/sdk/go/1/{core-structs => }/protocols/http/index.md (100%) rename src/sdk/go/1/{core-structs => }/protocols/index.md (83%) rename src/sdk/go/1/{core-structs => }/protocols/socketio/index.md (100%) rename src/sdk/go/1/{core-structs => }/protocols/websocket/index.md (100%) rename src/sdk/java/1/{core-classes/protocol => protocols}/http/index.md (100%) rename src/sdk/java/1/{core-classes/protocol => protocols}/index.md (83%) rename src/sdk/java/1/{core-classes/protocol => protocols}/socketio/index.md (100%) rename src/sdk/java/1/{core-classes/protocol => protocols}/websocket/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/apply/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/apply/snippets/apply-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/refresh/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/refresh/snippets/refresh-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/set-headers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/set-headers/snippets/set-headers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/set/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection-mapping/set/snippets/set-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/collection-mapping/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/collection-mapping/snippets/collection-mapping-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/count/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/count/snippets/count-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/count/snippets/count-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/create-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/create-document/snippets/create-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/create/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/create/snippets/create-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/create/snippets/create-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-document/snippets/delete-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-document/snippets/delete-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-specifications/snippets/delete-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/delete-specifications/snippets/delete-specifications-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/document/snippets/document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/fetch-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/fetch-document/snippets/fetch-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/get-mapping/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/get-mapping/snippets/get-mapping-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/get-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/get-specifications/snippets/get-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/get-specifications/snippets/get-specifications-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-document/snippets/mcreate-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-document/snippets/mcreate-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-or-replace-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mdelete-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mdelete-document/snippets/mdelete-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mdelete-document/snippets/mdelete-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mget-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mget-document/snippets/mget-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mget-document/snippets/mget-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mreplace-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mreplace-document/snippets/mreplace-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mreplace-document/snippets/mreplace-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mupdate-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/mupdate-document/snippets/mupdate-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/mupdate-document/snippets/mupdate-document-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/publish-message/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/publish-message/snippets/publish-message-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/replace-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/replace-document/snippets/replace-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/room/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/room/snippets/room-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/scroll-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/scroll-specifications/snippets/scroll-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/scroll-specifications/snippets/scroll-specifications-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/scroll/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/scroll/snippets/scroll-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/search-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/search-specifications/snippets/search-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/search-specifications/snippets/search-specifications-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/search/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/search/snippets/search-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/set-headers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/set-headers/snippets/set-headers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/subscribe/index.md (98%) rename src/sdk/js/5/{ => core-classes}/collection/subscribe/snippets/subscribe-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/truncate/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/truncate/snippets/truncate-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/truncate/snippets/truncate-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/update-document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/update-document/snippets/update-document-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/update-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/update-specifications/snippets/update-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/update-specifications/snippets/update-specifications-2.js (100%) rename src/sdk/js/5/{ => core-classes}/collection/validate-specifications/index.md (100%) rename src/sdk/js/5/{ => core-classes}/collection/validate-specifications/snippets/validate-specifications-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/delete/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/delete/snippets/delete-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/exists/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/exists/snippets/exists-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/publish/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/publish/snippets/publish-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/refresh/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/refresh/snippets/refresh-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/save/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/save/snippets/save-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/set-content/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/set-content/snippets/set-content-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/set-headers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/document/set-headers/snippets/set-headers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/document/subscribe/index.md (89%) rename src/sdk/js/5/{ => core-classes}/document/subscribe/snippets/subscribe-1.js (100%) create mode 100644 src/sdk/js/5/core-classes/index.md rename src/sdk/js/5/{ => core-classes}/kuzzle/add-listener/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/add-listener/snippets/add-listener-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/check-token/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/check-token/snippets/check-token-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/check-token/snippets/check-token-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/check-token/snippets/check-token-3.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/collection/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/collection/snippets/collection-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/connect/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/connect/snippets/connect-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/create-index/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/create-index/snippets/create-index-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/create-index/snippets/create-index-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/create-my-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/create-my-credentials/snippets/create-my-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/delete-my-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/disconnect/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/disconnect/snippets/disconnect-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/flush-queue/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/flush-queue/snippets/flush-queue-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-all-statistics/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-all-statistics/snippets/get-all-statistics-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-all-statistics/snippets/get-all-statistics-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-auto-refresh/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-jwt-token/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-jwt-token/snippets/get-jwt-token-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-credentials/snippets/get-my-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-credentials/snippets/get-my-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-rights/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-rights/snippets/get-my-rights-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-my-rights/snippets/get-my-rights-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-server-info/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-server-info/snippets/get-server-info-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-server-info/snippets/get-server-info-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-statistics/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-statistics/snippets/get-statistics-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-statistics/snippets/get-statistics-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-statistics/snippets/get-statistics-3.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/get-statistics/snippets/get-statistics-4.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-collections/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-collections/snippets/list-collections-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-collections/snippets/list-collections-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-indexes/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-indexes/snippets/list-indexes-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/list-indexes/snippets/list-indexes-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/login/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/login/snippets/login-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/logout/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/logout/snippets/logout-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/memory-storage/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/now/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/now/snippets/now-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/now/snippets/now-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/query/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/query/snippets/query-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/query/snippets/query-2.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/refresh-index/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/refresh-index/snippets/refresh-index-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/remove-all-listeners/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/remove-listener/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/remove-listener/snippets/remove-listener-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/replay-queue/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/replay-queue/snippets/replay-queue-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/security/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-auto-refresh/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-default-index/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-default-index/snippets/set-default-index-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-headers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-headers/snippets/set-headers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-jwt-token/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/set-jwt-token/snippets/set-jwt-token-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/start-queuing/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/start-queuing/snippets/start-queuing-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/stop-queuing/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/stop-queuing/snippets/stop-queuing-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/unset-jwt-token/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/update-my-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/update-my-credentials/snippets/update-my-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/update-self/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/update-self/snippets/update-self-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/validate-my-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/who-am-i/index.md (100%) rename src/sdk/js/5/{ => core-classes}/kuzzle/who-am-i/snippets/who-am-i-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/append/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/append/snippets/append-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/append/snippets/append-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitcount/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitcount/snippets/bitcount-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitcount/snippets/bitcount-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitop/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitop/snippets/bitop-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitop/snippets/bitop-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitpos/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitpos/snippets/bitpos-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/bitpos/snippets/bitpos-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/dbsize/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/dbsize/snippets/dbsize-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/dbsize/snippets/dbsize-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decr/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decr/snippets/decr-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decr/snippets/decr-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decrby/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decrby/snippets/decrby-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/decrby/snippets/decrby-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/del/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/del/snippets/del-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/del/snippets/del-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/exists/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/exists/snippets/exists-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/exists/snippets/exists-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expire/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expire/snippets/expire-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expire/snippets/expire-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expireat/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expireat/snippets/expireat-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/expireat/snippets/expireat-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/flushdb/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/flushdb/snippets/flushdb-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geoadd/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geoadd/snippets/geoadd-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geoadd/snippets/geoadd-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geodist/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geodist/snippets/geodist-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geodist/snippets/geodist-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geohash/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geohash/snippets/geohash-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geohash/snippets/geohash-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geopos/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geopos/snippets/geopos-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/geopos/snippets/geopos-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadius/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadius/snippets/georadius-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadius/snippets/georadius-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadius/snippets/georadius-3.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadius/snippets/georadius-4.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadiusbymember/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-3.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-4.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/get/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/get/snippets/get-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/get/snippets/get-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getbit/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getbit/snippets/getbit-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getbit/snippets/getbit-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getrange/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getrange/snippets/getrange-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getrange/snippets/getrange-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getset/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getset/snippets/getset-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/getset/snippets/getset-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hdel/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hdel/snippets/hdel-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hdel/snippets/hdel-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hexists/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hexists/snippets/hexists-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hexists/snippets/hexists-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hget/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hget/snippets/hget-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hget/snippets/hget-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hgetall/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hgetall/snippets/hgetall-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hgetall/snippets/hgetall-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrby/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrby/snippets/hincrby-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrby/snippets/hincrby-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrbyfloat/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hincrbyfloat/snippets/hincrbyfloat-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hkeys/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hkeys/snippets/hkeys-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hkeys/snippets/hkeys-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hlen/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hlen/snippets/hlen-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hlen/snippets/hlen-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hmget/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hmget/snippets/hmget-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hmget/snippets/hmget-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hmset/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hmset/snippets/hmset-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hscan/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hscan/snippets/hscan-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hscan/snippets/hscan-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hset/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hset/snippets/hset-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hset/snippets/hset-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hsetnx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hsetnx/snippets/hsetnx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hsetnx/snippets/hsetnx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hstrlen/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hstrlen/snippets/hstrlen-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hstrlen/snippets/hstrlen-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hvals/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hvals/snippets/hvals-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/hvals/snippets/hvals-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incr/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incr/snippets/incr-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incr/snippets/incr-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrby/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrby/snippets/incrby-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrby/snippets/incrby-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrbyfloat/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrbyfloat/snippets/incrbyfloat-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/incrbyfloat/snippets/incrbyfloat-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/keys/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/keys/snippets/keys-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/keys/snippets/keys-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lindex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lindex/snippets/lindex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lindex/snippets/lindex-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/linsert/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/linsert/snippets/linsert-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/linsert/snippets/linsert-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/llen/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/llen/snippets/llen-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/llen/snippets/llen-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpop/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpop/snippets/lpop-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpop/snippets/lpop-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpush/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpush/snippets/lpush-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpush/snippets/lpush-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpushx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpushx/snippets/lpushx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lpushx/snippets/lpushx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrange/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrange/snippets/lrange-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrange/snippets/lrange-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrem/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrem/snippets/lrem-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lrem/snippets/lrem-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lset/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/lset/snippets/lset-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ltrim/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ltrim/snippets/ltrim-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/mget/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/mget/snippets/mget-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/mget/snippets/mget-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/mset/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/mset/snippets/mset-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/msetnx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/msetnx/snippets/msetnx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/msetnx/snippets/msetnx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/object/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/object/snippets/object-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/object/snippets/object-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/persist/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/persist/snippets/persist-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/persist/snippets/persist-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpire/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpire/snippets/pexpire-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpire/snippets/pexpire-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpireat/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpireat/snippets/pexpireat-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pexpireat/snippets/pexpireat-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfadd/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfadd/snippets/pfadd-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfadd/snippets/pfadd-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfcount/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfcount/snippets/pfcount-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfcount/snippets/pfcount-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfmerge/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pfmerge/snippets/pfmerge-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ping/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ping/snippets/ping-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ping/snippets/ping-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/psetex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/psetex/snippets/psetex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pttl/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pttl/snippets/pttl-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/pttl/snippets/pttl-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/randomkey/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/randomkey/snippets/randomkey-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/randomkey/snippets/randomkey-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rename/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rename/snippets/rename-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/renamenx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/renamenx/snippets/renamenx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/renamenx/snippets/renamenx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpop/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpop/snippets/rpop-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpop/snippets/rpop-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpoplpush/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpoplpush/snippets/rpoplpush-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpoplpush/snippets/rpoplpush-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpush/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpush/snippets/rpush-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpush/snippets/rpush-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpushx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpushx/snippets/rpushx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/rpushx/snippets/rpushx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sadd/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sadd/snippets/sadd-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sadd/snippets/sadd-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scan/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scan/snippets/scan-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scan/snippets/scan-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scard/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scard/snippets/scard-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/scard/snippets/scard-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiff/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiff/snippets/sdiff-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiff/snippets/sdiff-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiffstore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiffstore/snippets/sdiffstore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sdiffstore/snippets/sdiffstore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/set/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/set/snippets/set-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/setex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/setex/snippets/setex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/setnx/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/setnx/snippets/setnx-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/setnx/snippets/setnx-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinter/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinter/snippets/sinter-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinter/snippets/sinter-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinterstore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinterstore/snippets/sinterstore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sinterstore/snippets/sinterstore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sismember/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sismember/snippets/sismember-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sismember/snippets/sismember-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smembers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smembers/snippets/smembers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smembers/snippets/smembers-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smove/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smove/snippets/smove-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/smove/snippets/smove-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sort/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sort/snippets/sort-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sort/snippets/sort-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/spop/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/spop/snippets/spop-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/spop/snippets/spop-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srandmember/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srandmember/snippets/srandmember-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srandmember/snippets/srandmember-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srem/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srem/snippets/srem-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/srem/snippets/srem-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sscan/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sscan/snippets/sscan-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sscan/snippets/sscan-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/strlen/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/strlen/snippets/strlen-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/strlen/snippets/strlen-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunion/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunion/snippets/sunion-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunion/snippets/sunion-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunionstore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunionstore/snippets/sunionstore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/sunionstore/snippets/sunionstore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/time/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/time/snippets/time-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/time/snippets/time-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/touch/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/touch/snippets/touch-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/touch/snippets/touch-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ttl/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ttl/snippets/ttl-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/ttl/snippets/ttl-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/type/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/type/snippets/type-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/type/snippets/type-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zadd/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zadd/snippets/zadd-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zadd/snippets/zadd-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcard/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcard/snippets/zcard-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcard/snippets/zcard-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcount/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcount/snippets/zcount-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zcount/snippets/zcount-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zincrby/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zincrby/snippets/zincrby-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zincrby/snippets/zincrby-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zinterstore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zinterstore/snippets/zinterstore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zinterstore/snippets/zinterstore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zlexcount/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zlexcount/snippets/zlexcount-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zlexcount/snippets/zlexcount-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrange/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrange/snippets/zrange-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrange/snippets/zrange-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebylex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebylex/snippets/zrangebylex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebylex/snippets/zrangebylex-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebyscore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebyscore/snippets/zrangebyscore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrangebyscore/snippets/zrangebyscore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrank/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrank/snippets/zrank-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrank/snippets/zrank-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrem/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrem/snippets/zrem-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrem/snippets/zrem-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebylex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebylex/snippets/zremrangebylex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebylex/snippets/zremrangebylex-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyrank/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyrank/snippets/zremrangebyrank-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyscore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zremrangebyscore/snippets/zremrangebyscore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrange/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrange/snippets/zrevrange-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrange/snippets/zrevrange-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebylex/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebylex/snippets/zrevrangebylex-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebyscore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrank/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrank/snippets/zrevrank-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zrevrank/snippets/zrevrank-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscan/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscan/snippets/zscan-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscan/snippets/zscan-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscore/snippets/zscore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zscore/snippets/zscore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zunionstore/index.md (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zunionstore/snippets/zunionstore-1.js (100%) rename src/sdk/js/5/{ => core-classes}/memory-storage/zunionstore/snippets/zunionstore-2.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/add-policy/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/add-policy/snippets/add-policy-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/delete/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/delete/snippets/delete-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/get-policies/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/get-policies/snippets/get-policies-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/get-policies/snippets/get-policies-2.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/save/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/save/snippets/save-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/set-content/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/set-content/snippets/set-content-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/set-policies/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/set-policies/snippets/set-policies-1.js (100%) rename src/sdk/js/5/{ => core-classes}/profile/update/index.md (100%) rename src/sdk/js/5/{ => core-classes}/profile/update/snippets/update-1.js (100%) rename src/sdk/js/5/{ => core-classes}/role/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/role/delete/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/delete/snippets/delete-1.js (100%) rename src/sdk/js/5/{ => core-classes}/role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/save/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/save/snippets/save-1.js (100%) rename src/sdk/js/5/{ => core-classes}/role/set-content/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/set-content/snippets/set-content-1.js (100%) rename src/sdk/js/5/{ => core-classes}/role/update/index.md (100%) rename src/sdk/js/5/{ => core-classes}/role/update/snippets/update-1.js (100%) rename src/sdk/js/5/{ => core-classes}/room/constructor/index.md (78%) rename src/sdk/js/5/{ => core-classes}/room/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/room/count/index.md (100%) rename src/sdk/js/5/{ => core-classes}/room/count/snippets/count-1.js (100%) rename src/sdk/js/5/{ => core-classes}/room/count/snippets/count-2.js (100%) rename src/sdk/js/5/{ => core-classes}/room/index.md (100%) rename src/sdk/js/5/{ => core-classes}/room/renew/index.md (92%) rename src/sdk/js/5/{ => core-classes}/room/renew/snippets/renew-1.js (100%) rename src/sdk/js/5/{ => core-classes}/room/set-headers/index.md (100%) rename src/sdk/js/5/{ => core-classes}/room/set-headers/snippets/set-headers-1.js (100%) rename src/sdk/js/5/{ => core-classes}/room/unsubscribe/index.md (100%) rename src/sdk/js/5/{ => core-classes}/room/unsubscribe/snippets/unsubscribe-1.js (100%) rename src/sdk/js/5/{ => core-classes}/search-result/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/search-result/fetch-next/index.md (100%) rename src/sdk/js/5/{ => core-classes}/search-result/fetch-next/snippets/fetch-next-1.js (100%) rename src/sdk/js/5/{ => core-classes}/search-result/fetch-next/snippets/fetch-next-2.js (100%) rename src/sdk/js/5/{ => core-classes}/search-result/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/create-credentials/snippets/create-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-credentials/snippets/create-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/create-profile/snippets/create-profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-restricted-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/create-restricted-user/snippets/create-restricted-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/create-role/snippets/create-role-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/create-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/create-user/snippets/create-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-credentials/snippets/delete-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-credentials/snippets/delete-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-profile/snippets/delete-profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-profile/snippets/delete-profile-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-role/snippets/delete-role-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-role/snippets/delete-role-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-user/snippets/delete-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/delete-user/snippets/delete-user-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-profile/snippets/fetch-profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-role/snippets/fetch-role-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/fetch-user/snippets/fetch-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-all-credential-fields/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/get-all-credential-fields/snippets/get-all-credential-fields-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-all-credential-fields/snippets/get-all-credential-fields-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials-fields/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials-fields/snippets/get-credentials-fields-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials-fields/snippets/get-credentials-fields-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials/snippets/get-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-credentials/snippets/get-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-user-rights/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/get-user-rights/snippets/get-user-rights-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/get-user-rights/snippets/get-user-rights-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/has-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/has-credentials/snippets/has-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/is-action-allowed/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/is-action-allowed/snippets/is-action-allowed-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/profile/snippets/profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/replace-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/replace-user/snippets/replace-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/role/snippets/role-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/scroll-profiles/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/scroll-profiles/snippets/scroll-profiles-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/scroll-users/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/scroll-users/snippets/scroll-users-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-profiles/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/search-profiles/snippets/search-profiles-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-profiles/snippets/search-profiles-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-roles/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/search-roles/snippets/search-roles-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-roles/snippets/search-roles-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-users/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/search-users/snippets/search-users-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/search-users/snippets/search-users-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/update-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/update-credentials/snippets/update-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/update-credentials/snippets/update-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/security/update-profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/update-profile/snippets/update-profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/update-role/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/update-role/snippets/update-role-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/update-user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/update-user/snippets/update-user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/user/snippets/user-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/validate-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/security/validate-credentials/snippets/validate-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/security/validate-credentials/snippets/validate-credentials-2.js (100%) rename src/sdk/js/5/{ => core-classes}/user/add-profile/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/add-profile/snippets/add-profile-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/constructor/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/constructor/snippets/constructor-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/create/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/create/snippets/create-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/delete/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/delete/snippets/delete-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/get-profileids/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/get-profileids/snippets/get-profileids-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/get-profiles/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/get-profiles/snippets/get-profiles-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/replace/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/replace/snippets/replace-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/save-restricted/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/save-restricted/snippets/save-restricted-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/save/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/save/snippets/save-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/set-content/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/set-content/snippets/set-content-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/set-credentials/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/set-credentials/snippets/set-credentials-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/set-profiles/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/set-profiles/snippets/set-profiles-1.js (100%) rename src/sdk/js/5/{ => core-classes}/user/update/index.md (100%) rename src/sdk/js/5/{ => core-classes}/user/update/snippets/update-1.js (100%) rename src/sdk/js/5/{handling-errors => essentials/error-handling}/index.md (100%) rename src/sdk/js/5/{handling-errors => essentials/error-handling}/snippets/handling-errors-1.js (100%) rename src/sdk/js/5/{ => essentials}/events/index.md (100%) create mode 100644 src/sdk/js/5/essentials/index.md rename src/sdk/js/5/{offline-first => essentials/offline-tools}/index.md (98%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/index.md (98%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/snippets/notifications-1.js (100%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/snippets/notifications-2.js (100%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/snippets/notifications-3.js (100%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/snippets/notifications-4.js (100%) rename src/sdk/js/5/{notifications => essentials/realtime-notifications}/snippets/notifications-5.js (100%) diff --git a/redirections.yml b/redirections.yml new file mode 100644 index 000000000..1d6820dae --- /dev/null +++ b/redirections.yml @@ -0,0 +1,510 @@ +--- +redirections: + # legacy + - from: api-documentation + to: core/1/api + - from: sdk-reference/essentials + to: sdk + - from: elasticsearch-cookbook/bool-query + to: core/1/guide/cookbooks/elasticsearch/bool-query + - from: guide/getting-started + to: core/1/guide/guides/getting-started + - from: guide/essentials/installing-kuzzle + to: core/1/guide/guides/essentials/installing-kuzzle + - from: guide/essentials/installing-console + to: core/1/guide/guides/essentials/installing-console + - from: guide/code-examples/geofencing/javascript + to: core/1/guide/code-examples/geofencing/javascript + - from: guide/essentials + to: core/1/guide/guides/essentials + - from: sdk-reference/collection + to: sdk + - from: elasticsearch-cookbook/useful-commands + to: core/1/guide/cookbooks/elasticsearch/useful-commands + - from: guide/code-examples/dbsearch/javascript + to: core/1/guide/code-examples/dbsearch/javascript + - from: guide/essentials/plugins + to: core/1/plugins/plugins/essentials/available-plugins + - from: guide/kuzzle-depth + to: core/1/guide/guides/kuzzle-depth + - from: plugins-reference/plugins-features + to: core/1/plugins/plugins/essentials/getting-started + - from: sdk-reference/essentials/events + to: sdk/js/6/essentials/events + - from: sdk-reference/essentials/notifications + to: sdk/js/6/essentials/realtime-notifications + - from: elasticsearch-cookbook/basic-queries + to: core/1/guide/cookbooks/elasticsearch/basic-queries + - from: guide/essentials/real-time + to: core/1/guide/guides/essentials/real-time + - from: sdk-reference/collection/search + to: sdk + - from: sdk-reference/kuzzle + to: sdk + - from: api-documentation/query-syntax + to: core/1/api/essentials/query-syntax + - from: kuzzle-events/plugin-events + to: core/1/plugins/plugins/events + - from: sdk-reference/kuzzle/login + to: sdk/js/6/controllers/auth/login + - from: sdk-reference/memory-storage/pfadd + to: sdk/js/6/controllers/ms/pfadd + + # protocols methods + - from: protocols/1/essentials/broadcast + to: core/1/protocols/methods/broadcast + - from: protocols/1/essentials/disconnect + to: core/1/protocols/methods/disconnect + - from: protocols/1/essentials/init + to: core/1/protocols/methods/init + - from: protocols/1/essentials/joinchannel + to: core/1/protocols/methods/joinchannel + - from: protocols/1/essentials/leavechannel + to: core/1/protocols/methods/leavechannel + - from: protocols/1/essentials/notify + to: core/1/protocols/methods/notify + + # plugins: essentials -> dedicated section + - from: plugins/1/essentials/strategies + to: core/1/plugins/plugins/strategies/overview + - from: plugins/1/essentials/pipes + to: core/1/plugins/plugins/pipes + - from: plugins/1/plugin-layout/init-function + to: core/1/plugins/plugins/manual-setup/init-function + - from: plugins/1/essentials/controllers + to: core/1/plugins/plugins/controllers + + # API + - from: api/1/controller-(.+) + to: core/1/api/controllers/$1 + + - from: api/1/essentials + to: core/1/api/essentials + + # Guides + - from: guide/1/datavalidation + to: core/1/guides/cookbooks/datavalidation + + - from: guide/1/dbsearch + to: core/1/guides/code-examples/dbsearch + + - from: guide/1/elasticsearch + to: core/1/guides/cookbooks/elasticsearch + + - from: guide/1/essentials + to: core/1/guides/essentials + + - from: guide/1/geofencing + to: core/1/guides/code-examples/geofencing + + - from: guide/1/getting-started + to: core/1/guides/getting-started + + - from: guide/1/iot + to: core/1/guides/code-examples/iot + + - from: guide/1/kuzzle-depth + to: core/1/guides/kuzzle-depth + + - from: guide/1/pubsub + to: core/1/guides/code-examples/pubsub + + # Koncorde + - from: koncorde/1/essentials + to: core/1/koncorde/essentials + + # Plugin essentials + - from: plugins/1/essentials/available-plugins + to: core/1/plugins/essentials/available-plugins + + - from: plugins/1/essentials/getting-started + to: core/1/plugins/essentials/getting-started + + - from: plugins/1/essentials/introduction + to: core/1/plugins/essentials/introduction + + # Plugin guides + - from: plugins/1/controllers + to: core/1/plugins/guides/controllers + + - from: plugins/1/events + to: core/1/plugins/guides/events + + - from: plugins/1/hooks + to: core/1/plugins/guides/hooks + + - from: plugins/1/manual-setup + to: core/1/plugins/guides/manual-setup + + - from: plugins/1/pipes + to: core/1/plugins/guides/pipes + + - from: plugins/1/strategies + to: core/1/plugins/guides/strategies + + # Plugin context + - from: plugins/1/accessors + to: core/1/plugins/plugin-context/accessors + + - from: plugins/1/constructors + to: core/1/plugins/plugin-context/constructors + + - from: plugins/1/errors + to: core/1/plugins/plugin-context/errors + + - from: plugins/1/log + to: core/1/plugins/plugin-context/log + + # Protocols essentials + - from: protocols/1/essentials/getting-started + to: core/1/protocols/essentials/getting-started + + # Protocols api + - from: protocols/1/context + to: core/1/protocols/api/context + + - from: protocols/1/entrypoint + to: core/1/protocols/api/entrypoint + + - from: protocols/1/methods + to: core/1/protocols/api/methods + + # Protocols native protocols + - from: protocols/1/native-protocols + to: core/1/protocols/native-protocols + + # JS 6 essentials + - from: sdk-reference/js/6/getting-started + to: sdk/js/6/essentials/getting-started + + - from: sdk-reference/js/6/error-handling + to: sdk/js/6/essentials/error-handling + + - from: sdk-reference/js/6/events + to: sdk/js/6/essentials/events + + - from: sdk-reference/js/6/realtime-notifications + to: sdk/js/6/essentials/realtime-notifications + + - from: sdk-reference/js/6/offline-tools + to: sdk/js/6/essentials/offline-tools + + - from: sdk-reference/js/6/extend-sdk + to: sdk/js/6/essentials/extend-sdk + + # JS 6 core classes + - from: sdk-reference/js/6/base-controller + to: sdk/js/6/core-classes/base-controller + + - from: sdk-reference/js/6/kuzzle + to: sdk/js/6/core-classes/kuzzle + + - from: sdk-reference/js/6/kuzzle-error + to: sdk/js/6/core-classes/kuzzle-error + + - from: sdk-reference/js/6/kuzzle-event-emitter + to: sdk/js/6/core-classes/kuzzle-event-emitter + + - from: sdk-reference/js/6/profile + to: sdk/js/6/core-classes/profile + + - from: sdk-reference/js/6/role + to: sdk/js/6/core-classes/role + + - from: sdk-reference/js/6/search-result + to: sdk/js/6/core-classes/search-result + + - from: sdk-reference/js/6/user + to: sdk/js/6/core-classes/user + + # JS 6 protocols + - from: sdk-reference/js/6/http + to: sdk/js/6/protocols/http + + - from: sdk-reference/js/6/websocket + to: sdk/js/6/protocols/websocket + + - from: sdk-reference/js/6/socketio + to: sdk/js/6/protocols/socketio + + # JS 6 Controllers + - from: sdk-reference/js/6/auth + to: sdk/js/6/controllers/auth + + - from: sdk-reference/js/6/bulk + to: sdk/js/6/controllers/bulk + + - from: sdk-reference/js/6/collection + to: sdk/js/6/controllers/collection + + - from: sdk-reference/js/6/document + to: sdk/js/6/controllers/document + + - from: sdk-reference/js/6/index + to: sdk/js/6/controllers/index + + - from: sdk-reference/js/6/ms + to: sdk/js/6/controllers/ms + + - from: sdk-reference/js/6/realtime + to: sdk/js/6/controllers/realtime + + - from: sdk-reference/js/6/server + to: sdk/js/6/controllers/server + + # JS 5 essentials + - from: sdk-reference/js/5/handling-errors + to: sdk/js/5/essentials/error-handling + + - from: sdk-reference/js/5/events + to: sdk/js/5/essentials/events + + - from: sdk-reference/js/5/offline-first + to: sdk/js/5/essentials/offline-tools + + - from: sdk-reference/js/5/notifications + to: sdk/js/5/essentials/realtime-notifications + + # JS 5 core classes + - from: sdk-reference/js/5/collection + to: sdk/js/5/core-classes/collection + + - from: sdk-reference/js/5/collection-mapping + to: sdk/js/5/core-classes/collection-mapping + + - from: sdk-reference/js/5/document + to: sdk/js/5/core-classes/document + + - from: sdk-reference/js/5/kuzzle + to: sdk/js/5/core-classes/kuzzle + + - from: sdk-reference/js/5/memory-storage + to: sdk/js/5/core-classes/memory-storage + + - from: sdk-reference/js/5/profile + to: sdk/js/5/core-classes/profile + + - from: sdk-reference/js/5/role + to: sdk/js/5/core-classes/role + + - from: sdk-reference/js/5/room + to: sdk/js/5/core-classes/room + + - from: sdk-reference/js/5/search-result + to: sdk/js/5/core-classes/search-result + + - from: sdk-reference/js/5/security + to: sdk/js/5/core-classes/security + + - from: sdk-reference/js/5/user + to: sdk/js/5/core-classes/user + + # Java 1 essentials + - from: sdk-reference/java/1/error-handling + to: sdk/java/1/essentials/error-handling + + - from: sdk-reference/java/1/events + to: sdk/java/1/essentials/events + + - from: sdk-reference/java/1/getting-started + to: sdk/java/1/essentials/getting-started + + - from: sdk-reference/java/1/offline-tools + to: sdk/java/1/essentials/offline-tools + + - from: sdk-reference/java/1/realtime-notifications + to: sdk/java/1/essentials/realtime-notifications + + # Java 1 core classes + - from: sdk-reference/java/1/kuzzle + to: sdk/java/1/core-classes/kuzzle + + - from: sdk-reference/java/1/search-result + to: sdk/java/1/core-classes/search-result + + # Java 1 protocols + - from: sdk-reference/java/1/http + to: sdk/java/1/protocols/http + + - from: sdk-reference/java/1/websocket + to: sdk/java/1/protocols/websocket + + - from: sdk-reference/java/1/socketio + to: sdk/java/1/protocols/socketio + + # Java 1 controllers + - from: sdk-reference/java/1/auth + to: sdk/java/1/controllers/auth + + - from: sdk-reference/java/1/collection + to: sdk/java/1/controllers/collection + + - from: sdk-reference/java/1/document + to: sdk/java/1/controllers/document + + - from: sdk-reference/java/1/index + to: sdk/java/1/controllers/index + + - from: sdk-reference/java/1/realtime + to: sdk/java/1/controllers/realtime + + - from: sdk-reference/java/1/server + to: sdk/java/1/controllers/server + + # Go 1 essentials + - from: sdk-reference/go/1/error-handling + to: sdk/go/1/essentials/error-handling + + - from: sdk-reference/go/1/events + to: sdk/go/1/essentials/events + + - from: sdk-reference/go/1/getting-started + to: sdk/go/1/essentials/getting-started + + - from: sdk-reference/go/1/offline-tools + to: sdk/go/1/essentials/offline-tools + + - from: sdk-reference/go/1/realtime-notifications + to: sdk/go/1/essentials/realtime-notifications + + # Go 1 core structs + - from: sdk-reference/go/1/kuzzle + to: sdk/go/1/core-structs/kuzzle + + - from: sdk-reference/go/1/search-result + to: sdk/go/1/core-structs/search-result + + - from: sdk-reference/go/1/kuzzle-event-emitter + to: sdk/go/1/core-structs/kuzzle-event-emitter + + # Go 1 protocols + - from: sdk-reference/go/1/http + to: sdk/go/1/protocols/http + + - from: sdk-reference/go/1/websocket + to: sdk/go/1/protocols/websocket + + - from: sdk-reference/go/1/socketio + to: sdk/go/1/protocols/socketio + + # Go 1 controllers + - from: sdk-reference/go/1/auth + to: sdk/go/1/controllers/auth + + - from: sdk-reference/go/1/collection + to: sdk/go/1/controllers/collection + + - from: sdk-reference/go/1/document + to: sdk/go/1/controllers/document + + - from: sdk-reference/go/1/index + to: sdk/go/1/controllers/index + + - from: sdk-reference/go/1/realtime + to: sdk/go/1/controllers/realtime + + - from: sdk-reference/go/1/server + to: sdk/go/1/controllers/server + + # Cpp 1 essentials + - from: sdk-reference/cpp/1/error-handling + to: sdk/cpp/1/essentials/error-handling + + - from: sdk-reference/cpp/1/events + to: sdk/cpp/1/essentials/events + + - from: sdk-reference/cpp/1/getting-started + to: sdk/cpp/1/essentials/getting-started + + - from: sdk-reference/cpp/1/offline-tools + to: sdk/cpp/1/essentials/offline-tools + + - from: sdk-reference/cpp/1/realtime-notifications + to: sdk/cpp/1/essentials/realtime-notifications + + # Cpp 1 core classes + - from: sdk-reference/cpp/1/kuzzle + to: sdk/cpp/1/core-classes/kuzzle + + - from: sdk-reference/cpp/1/search-result + to: sdk/cpp/1/core-classes/search-result + + - from: sdk-reference/cpp/1/user + to: sdk/cpp/1/core-classes/user + + - from: sdk-reference/cpp/1/user-right + to: sdk/cpp/1/core-classes/user-right + + # Cpp 1 virtual classes + - from: sdk-reference/cpp/1/protocol + to: sdk/cpp/1/virtual-classes/protocol + + # Cpp 1 protocols + - from: sdk-reference/cpp/1/websocket + to: sdk/cpp/1/protocols/websocket + + # Cpp 1 controllers + - from: sdk-reference/cpp/1/auth + to: sdk/cpp/1/controllers/auth + + - from: sdk-reference/cpp/1/collection + to: sdk/cpp/1/controllers/collection + + - from: sdk-reference/cpp/1/document + to: sdk/cpp/1/controllers/document + + - from: sdk-reference/cpp/1/index + to: sdk/cpp/1/controllers/index + + - from: sdk-reference/cpp/1/realtime + to: sdk/cpp/1/controllers/realtime + + - from: sdk-reference/cpp/1/server + to: sdk/cpp/1/controllers/server + + # Android 3 essentials + - from: sdk-reference/android/3/handling-errors + to: sdk/android/3/essentials/error-handling + + - from: sdk-reference/android/3/events + to: sdk/android/3/essentials/events + + - from: sdk-reference/android/3/offline-first + to: sdk/android/3/essentials/offline-tools + + - from: sdk-reference/android/3/notifications + to: sdk/android/3/essentials/realtime-notifications + + # Android 3 core classes + - from: sdk-reference/android/3/collection + to: sdk/android/3/core-classes/collection + + - from: sdk-reference/android/3/collection-mapping + to: sdk/android/3/core-classes/collection-mapping + + - from: sdk-reference/android/3/document + to: sdk/android/3/core-classes/document + + - from: sdk-reference/android/3/kuzzle + to: sdk/android/3/core-classes/kuzzle + + - from: sdk-reference/android/3/memory-storage + to: sdk/android/3/core-classes/memory-storage + + - from: sdk-reference/android/3/profile + to: sdk/android/3/core-classes/profile + + - from: sdk-reference/android/3/role + to: sdk/android/3/core-classes/role + + - from: sdk-reference/android/3/room + to: sdk/android/3/core-classes/room + + - from: sdk-reference/android/3/search-result + to: sdk/android/3/core-classes/search-result + + - from: sdk-reference/android/3/security + to: sdk/android/3/core-classes/security + + - from: sdk-reference/android/3/user + to: sdk/android/3/core-classes/user diff --git a/src/core/1/api/api-reference/controller-admin/dump/index.md b/src/core/1/api/controllers/admin/dump/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/dump/index.md rename to src/core/1/api/controllers/admin/dump/index.md diff --git a/src/core/1/api/api-reference/controller-admin/index.md b/src/core/1/api/controllers/admin/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/index.md rename to src/core/1/api/controllers/admin/index.md diff --git a/src/core/1/api/api-reference/controller-admin/reset-cache/index.md b/src/core/1/api/controllers/admin/reset-cache/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/reset-cache/index.md rename to src/core/1/api/controllers/admin/reset-cache/index.md diff --git a/src/core/1/api/api-reference/controller-admin/reset-database/index.md b/src/core/1/api/controllers/admin/reset-database/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/reset-database/index.md rename to src/core/1/api/controllers/admin/reset-database/index.md diff --git a/src/core/1/api/api-reference/controller-admin/reset-kuzzle-data/index.md b/src/core/1/api/controllers/admin/reset-kuzzle-data/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/reset-kuzzle-data/index.md rename to src/core/1/api/controllers/admin/reset-kuzzle-data/index.md diff --git a/src/core/1/api/api-reference/controller-admin/reset-security/index.md b/src/core/1/api/controllers/admin/reset-security/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/reset-security/index.md rename to src/core/1/api/controllers/admin/reset-security/index.md diff --git a/src/core/1/api/api-reference/controller-admin/shutdown/index.md b/src/core/1/api/controllers/admin/shutdown/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-admin/shutdown/index.md rename to src/core/1/api/controllers/admin/shutdown/index.md diff --git a/src/core/1/api/api-reference/controller-auth/check-token/index.md b/src/core/1/api/controllers/auth/check-token/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/check-token/index.md rename to src/core/1/api/controllers/auth/check-token/index.md diff --git a/src/core/1/api/api-reference/controller-auth/create-my-credentials/index.md b/src/core/1/api/controllers/auth/create-my-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/create-my-credentials/index.md rename to src/core/1/api/controllers/auth/create-my-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-auth/credentials-exists/index.md b/src/core/1/api/controllers/auth/credentials-exists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/credentials-exists/index.md rename to src/core/1/api/controllers/auth/credentials-exists/index.md diff --git a/src/core/1/api/api-reference/controller-auth/delete-my-credentials/index.md b/src/core/1/api/controllers/auth/delete-my-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/delete-my-credentials/index.md rename to src/core/1/api/controllers/auth/delete-my-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-auth/get-current-user/index.md b/src/core/1/api/controllers/auth/get-current-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/get-current-user/index.md rename to src/core/1/api/controllers/auth/get-current-user/index.md diff --git a/src/core/1/api/api-reference/controller-auth/get-my-credentials/index.md b/src/core/1/api/controllers/auth/get-my-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/get-my-credentials/index.md rename to src/core/1/api/controllers/auth/get-my-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-auth/get-my-rights/index.md b/src/core/1/api/controllers/auth/get-my-rights/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/get-my-rights/index.md rename to src/core/1/api/controllers/auth/get-my-rights/index.md diff --git a/src/core/1/api/api-reference/controller-auth/get-strategies/index.md b/src/core/1/api/controllers/auth/get-strategies/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/get-strategies/index.md rename to src/core/1/api/controllers/auth/get-strategies/index.md diff --git a/src/core/1/api/api-reference/controller-auth/index.md b/src/core/1/api/controllers/auth/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/index.md rename to src/core/1/api/controllers/auth/index.md diff --git a/src/core/1/api/api-reference/controller-auth/login/index.md b/src/core/1/api/controllers/auth/login/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/login/index.md rename to src/core/1/api/controllers/auth/login/index.md diff --git a/src/core/1/api/api-reference/controller-auth/logout/index.md b/src/core/1/api/controllers/auth/logout/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/logout/index.md rename to src/core/1/api/controllers/auth/logout/index.md diff --git a/src/core/1/api/api-reference/controller-auth/update-my-credentials/index.md b/src/core/1/api/controllers/auth/update-my-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/update-my-credentials/index.md rename to src/core/1/api/controllers/auth/update-my-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-auth/update-self/index.md b/src/core/1/api/controllers/auth/update-self/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/update-self/index.md rename to src/core/1/api/controllers/auth/update-self/index.md diff --git a/src/core/1/api/api-reference/controller-auth/validate-my-credentials/index.md b/src/core/1/api/controllers/auth/validate-my-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-auth/validate-my-credentials/index.md rename to src/core/1/api/controllers/auth/validate-my-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-bulk/import/index.md b/src/core/1/api/controllers/bulk/import/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-bulk/import/index.md rename to src/core/1/api/controllers/bulk/import/index.md diff --git a/src/core/1/api/api-reference/controller-bulk/index.md b/src/core/1/api/controllers/bulk/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-bulk/index.md rename to src/core/1/api/controllers/bulk/index.md diff --git a/src/core/1/api/api-reference/controller-collection/create/index.md b/src/core/1/api/controllers/collection/create/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/create/index.md rename to src/core/1/api/controllers/collection/create/index.md diff --git a/src/core/1/api/api-reference/controller-collection/delete-specifications/index.md b/src/core/1/api/controllers/collection/delete-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/delete-specifications/index.md rename to src/core/1/api/controllers/collection/delete-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-collection/exists/index.md b/src/core/1/api/controllers/collection/exists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/exists/index.md rename to src/core/1/api/controllers/collection/exists/index.md diff --git a/src/core/1/api/api-reference/controller-collection/get-mapping/index.md b/src/core/1/api/controllers/collection/get-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/get-mapping/index.md rename to src/core/1/api/controllers/collection/get-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-collection/get-specifications/index.md b/src/core/1/api/controllers/collection/get-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/get-specifications/index.md rename to src/core/1/api/controllers/collection/get-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-collection/index.md b/src/core/1/api/controllers/collection/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/index.md rename to src/core/1/api/controllers/collection/index.md diff --git a/src/core/1/api/api-reference/controller-collection/list/index.md b/src/core/1/api/controllers/collection/list/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/list/index.md rename to src/core/1/api/controllers/collection/list/index.md diff --git a/src/core/1/api/api-reference/controller-collection/scroll-specifications/index.md b/src/core/1/api/controllers/collection/scroll-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/scroll-specifications/index.md rename to src/core/1/api/controllers/collection/scroll-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-collection/search-specifications/index.md b/src/core/1/api/controllers/collection/search-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/search-specifications/index.md rename to src/core/1/api/controllers/collection/search-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-collection/truncate/index.md b/src/core/1/api/controllers/collection/truncate/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/truncate/index.md rename to src/core/1/api/controllers/collection/truncate/index.md diff --git a/src/core/1/api/api-reference/controller-collection/update-mapping/index.md b/src/core/1/api/controllers/collection/update-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/update-mapping/index.md rename to src/core/1/api/controllers/collection/update-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-collection/update-specifications/index.md b/src/core/1/api/controllers/collection/update-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/update-specifications/index.md rename to src/core/1/api/controllers/collection/update-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-collection/validate-specifications/index.md b/src/core/1/api/controllers/collection/validate-specifications/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-collection/validate-specifications/index.md rename to src/core/1/api/controllers/collection/validate-specifications/index.md diff --git a/src/core/1/api/api-reference/controller-document/count/index.md b/src/core/1/api/controllers/document/count/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/count/index.md rename to src/core/1/api/controllers/document/count/index.md diff --git a/src/core/1/api/api-reference/controller-document/create-or-replace/index.md b/src/core/1/api/controllers/document/create-or-replace/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/create-or-replace/index.md rename to src/core/1/api/controllers/document/create-or-replace/index.md diff --git a/src/core/1/api/api-reference/controller-document/create/index.md b/src/core/1/api/controllers/document/create/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/create/index.md rename to src/core/1/api/controllers/document/create/index.md diff --git a/src/core/1/api/api-reference/controller-document/delete-by-query/index.md b/src/core/1/api/controllers/document/delete-by-query/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/delete-by-query/index.md rename to src/core/1/api/controllers/document/delete-by-query/index.md diff --git a/src/core/1/api/api-reference/controller-document/delete/index.md b/src/core/1/api/controllers/document/delete/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/delete/index.md rename to src/core/1/api/controllers/document/delete/index.md diff --git a/src/core/1/api/api-reference/controller-document/get/index.md b/src/core/1/api/controllers/document/get/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/get/index.md rename to src/core/1/api/controllers/document/get/index.md diff --git a/src/core/1/api/api-reference/controller-document/index.md b/src/core/1/api/controllers/document/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/index.md rename to src/core/1/api/controllers/document/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-create-or-replace/index.md b/src/core/1/api/controllers/document/m-create-or-replace/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-create-or-replace/index.md rename to src/core/1/api/controllers/document/m-create-or-replace/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-create/index.md b/src/core/1/api/controllers/document/m-create/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-create/index.md rename to src/core/1/api/controllers/document/m-create/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-delete/index.md b/src/core/1/api/controllers/document/m-delete/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-delete/index.md rename to src/core/1/api/controllers/document/m-delete/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-get/index.md b/src/core/1/api/controllers/document/m-get/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-get/index.md rename to src/core/1/api/controllers/document/m-get/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-replace/index.md b/src/core/1/api/controllers/document/m-replace/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-replace/index.md rename to src/core/1/api/controllers/document/m-replace/index.md diff --git a/src/core/1/api/api-reference/controller-document/m-update/index.md b/src/core/1/api/controllers/document/m-update/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/m-update/index.md rename to src/core/1/api/controllers/document/m-update/index.md diff --git a/src/core/1/api/api-reference/controller-document/replace/index.md b/src/core/1/api/controllers/document/replace/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/replace/index.md rename to src/core/1/api/controllers/document/replace/index.md diff --git a/src/core/1/api/api-reference/controller-document/scroll/index.md b/src/core/1/api/controllers/document/scroll/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/scroll/index.md rename to src/core/1/api/controllers/document/scroll/index.md diff --git a/src/core/1/api/api-reference/controller-document/search/index.md b/src/core/1/api/controllers/document/search/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/search/index.md rename to src/core/1/api/controllers/document/search/index.md diff --git a/src/core/1/api/api-reference/controller-document/update/index.md b/src/core/1/api/controllers/document/update/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/update/index.md rename to src/core/1/api/controllers/document/update/index.md diff --git a/src/core/1/api/api-reference/controller-document/validate/index.md b/src/core/1/api/controllers/document/validate/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-document/validate/index.md rename to src/core/1/api/controllers/document/validate/index.md diff --git a/src/core/1/api/api-reference/index.md b/src/core/1/api/controllers/index.md similarity index 100% rename from src/core/1/api/api-reference/index.md rename to src/core/1/api/controllers/index.md diff --git a/src/core/1/api/api-reference/controller-index/create/index.md b/src/core/1/api/controllers/index/create/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/create/index.md rename to src/core/1/api/controllers/index/create/index.md diff --git a/src/core/1/api/api-reference/controller-index/delete/index.md b/src/core/1/api/controllers/index/delete/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/delete/index.md rename to src/core/1/api/controllers/index/delete/index.md diff --git a/src/core/1/api/api-reference/controller-index/exists/index.md b/src/core/1/api/controllers/index/exists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/exists/index.md rename to src/core/1/api/controllers/index/exists/index.md diff --git a/src/core/1/api/api-reference/controller-index/get-auto-refresh/index.md b/src/core/1/api/controllers/index/get-auto-refresh/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/get-auto-refresh/index.md rename to src/core/1/api/controllers/index/get-auto-refresh/index.md diff --git a/src/core/1/api/api-reference/controller-index/index.md b/src/core/1/api/controllers/index/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/index.md rename to src/core/1/api/controllers/index/index.md diff --git a/src/core/1/api/api-reference/controller-index/list/index.md b/src/core/1/api/controllers/index/list/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/list/index.md rename to src/core/1/api/controllers/index/list/index.md diff --git a/src/core/1/api/api-reference/controller-index/m-delete/index.md b/src/core/1/api/controllers/index/m-delete/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/m-delete/index.md rename to src/core/1/api/controllers/index/m-delete/index.md diff --git a/src/core/1/api/api-reference/controller-index/refresh-internal/index.md b/src/core/1/api/controllers/index/refresh-internal/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/refresh-internal/index.md rename to src/core/1/api/controllers/index/refresh-internal/index.md diff --git a/src/core/1/api/api-reference/controller-index/refresh/index.md b/src/core/1/api/controllers/index/refresh/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/refresh/index.md rename to src/core/1/api/controllers/index/refresh/index.md diff --git a/src/core/1/api/api-reference/controller-index/set-auto-refresh/index.md b/src/core/1/api/controllers/index/set-auto-refresh/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-index/set-auto-refresh/index.md rename to src/core/1/api/controllers/index/set-auto-refresh/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/append/index.md b/src/core/1/api/controllers/memory-storage/append/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/append/index.md rename to src/core/1/api/controllers/memory-storage/append/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/bitcount/index.md b/src/core/1/api/controllers/memory-storage/bitcount/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/bitcount/index.md rename to src/core/1/api/controllers/memory-storage/bitcount/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/bitop/index.md b/src/core/1/api/controllers/memory-storage/bitop/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/bitop/index.md rename to src/core/1/api/controllers/memory-storage/bitop/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/bitpos/index.md b/src/core/1/api/controllers/memory-storage/bitpos/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/bitpos/index.md rename to src/core/1/api/controllers/memory-storage/bitpos/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/dbsize/index.md b/src/core/1/api/controllers/memory-storage/dbsize/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/dbsize/index.md rename to src/core/1/api/controllers/memory-storage/dbsize/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/decr/index.md b/src/core/1/api/controllers/memory-storage/decr/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/decr/index.md rename to src/core/1/api/controllers/memory-storage/decr/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/decrby/index.md b/src/core/1/api/controllers/memory-storage/decrby/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/decrby/index.md rename to src/core/1/api/controllers/memory-storage/decrby/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/del/index.md b/src/core/1/api/controllers/memory-storage/del/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/del/index.md rename to src/core/1/api/controllers/memory-storage/del/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/exists/index.md b/src/core/1/api/controllers/memory-storage/exists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/exists/index.md rename to src/core/1/api/controllers/memory-storage/exists/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/expire/index.md b/src/core/1/api/controllers/memory-storage/expire/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/expire/index.md rename to src/core/1/api/controllers/memory-storage/expire/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/expireat/index.md b/src/core/1/api/controllers/memory-storage/expireat/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/expireat/index.md rename to src/core/1/api/controllers/memory-storage/expireat/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/flushdb/index.md b/src/core/1/api/controllers/memory-storage/flushdb/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/flushdb/index.md rename to src/core/1/api/controllers/memory-storage/flushdb/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/geoadd/index.md b/src/core/1/api/controllers/memory-storage/geoadd/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/geoadd/index.md rename to src/core/1/api/controllers/memory-storage/geoadd/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/geodist/index.md b/src/core/1/api/controllers/memory-storage/geodist/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/geodist/index.md rename to src/core/1/api/controllers/memory-storage/geodist/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/geohash/index.md b/src/core/1/api/controllers/memory-storage/geohash/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/geohash/index.md rename to src/core/1/api/controllers/memory-storage/geohash/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/geopos/index.md b/src/core/1/api/controllers/memory-storage/geopos/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/geopos/index.md rename to src/core/1/api/controllers/memory-storage/geopos/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/georadius/index.md b/src/core/1/api/controllers/memory-storage/georadius/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/georadius/index.md rename to src/core/1/api/controllers/memory-storage/georadius/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/georadiusbymember/index.md b/src/core/1/api/controllers/memory-storage/georadiusbymember/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/georadiusbymember/index.md rename to src/core/1/api/controllers/memory-storage/georadiusbymember/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/get/index.md b/src/core/1/api/controllers/memory-storage/get/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/get/index.md rename to src/core/1/api/controllers/memory-storage/get/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/getbit/index.md b/src/core/1/api/controllers/memory-storage/getbit/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/getbit/index.md rename to src/core/1/api/controllers/memory-storage/getbit/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/getrange/index.md b/src/core/1/api/controllers/memory-storage/getrange/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/getrange/index.md rename to src/core/1/api/controllers/memory-storage/getrange/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/getset/index.md b/src/core/1/api/controllers/memory-storage/getset/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/getset/index.md rename to src/core/1/api/controllers/memory-storage/getset/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hdel/index.md b/src/core/1/api/controllers/memory-storage/hdel/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hdel/index.md rename to src/core/1/api/controllers/memory-storage/hdel/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hexists/index.md b/src/core/1/api/controllers/memory-storage/hexists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hexists/index.md rename to src/core/1/api/controllers/memory-storage/hexists/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hget/index.md b/src/core/1/api/controllers/memory-storage/hget/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hget/index.md rename to src/core/1/api/controllers/memory-storage/hget/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hgetall/index.md b/src/core/1/api/controllers/memory-storage/hgetall/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hgetall/index.md rename to src/core/1/api/controllers/memory-storage/hgetall/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hincrby/index.md b/src/core/1/api/controllers/memory-storage/hincrby/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hincrby/index.md rename to src/core/1/api/controllers/memory-storage/hincrby/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hincrbyfloat/index.md b/src/core/1/api/controllers/memory-storage/hincrbyfloat/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hincrbyfloat/index.md rename to src/core/1/api/controllers/memory-storage/hincrbyfloat/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hkeys/index.md b/src/core/1/api/controllers/memory-storage/hkeys/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hkeys/index.md rename to src/core/1/api/controllers/memory-storage/hkeys/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hlen/index.md b/src/core/1/api/controllers/memory-storage/hlen/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hlen/index.md rename to src/core/1/api/controllers/memory-storage/hlen/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hmget/index.md b/src/core/1/api/controllers/memory-storage/hmget/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hmget/index.md rename to src/core/1/api/controllers/memory-storage/hmget/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hmset/index.md b/src/core/1/api/controllers/memory-storage/hmset/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hmset/index.md rename to src/core/1/api/controllers/memory-storage/hmset/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hscan/index.md b/src/core/1/api/controllers/memory-storage/hscan/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hscan/index.md rename to src/core/1/api/controllers/memory-storage/hscan/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hset/index.md b/src/core/1/api/controllers/memory-storage/hset/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hset/index.md rename to src/core/1/api/controllers/memory-storage/hset/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hsetnx/index.md b/src/core/1/api/controllers/memory-storage/hsetnx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hsetnx/index.md rename to src/core/1/api/controllers/memory-storage/hsetnx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hstrlen/index.md b/src/core/1/api/controllers/memory-storage/hstrlen/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hstrlen/index.md rename to src/core/1/api/controllers/memory-storage/hstrlen/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/hvals/index.md b/src/core/1/api/controllers/memory-storage/hvals/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/hvals/index.md rename to src/core/1/api/controllers/memory-storage/hvals/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/incr/index.md b/src/core/1/api/controllers/memory-storage/incr/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/incr/index.md rename to src/core/1/api/controllers/memory-storage/incr/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/incrby/index.md b/src/core/1/api/controllers/memory-storage/incrby/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/incrby/index.md rename to src/core/1/api/controllers/memory-storage/incrby/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/incrbyfloat/index.md b/src/core/1/api/controllers/memory-storage/incrbyfloat/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/incrbyfloat/index.md rename to src/core/1/api/controllers/memory-storage/incrbyfloat/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/index.md b/src/core/1/api/controllers/memory-storage/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/index.md rename to src/core/1/api/controllers/memory-storage/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/keys/index.md b/src/core/1/api/controllers/memory-storage/keys/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/keys/index.md rename to src/core/1/api/controllers/memory-storage/keys/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lindex/index.md b/src/core/1/api/controllers/memory-storage/lindex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lindex/index.md rename to src/core/1/api/controllers/memory-storage/lindex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/linsert/index.md b/src/core/1/api/controllers/memory-storage/linsert/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/linsert/index.md rename to src/core/1/api/controllers/memory-storage/linsert/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/llen/index.md b/src/core/1/api/controllers/memory-storage/llen/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/llen/index.md rename to src/core/1/api/controllers/memory-storage/llen/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lpop/index.md b/src/core/1/api/controllers/memory-storage/lpop/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lpop/index.md rename to src/core/1/api/controllers/memory-storage/lpop/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lpush/index.md b/src/core/1/api/controllers/memory-storage/lpush/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lpush/index.md rename to src/core/1/api/controllers/memory-storage/lpush/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lpushx/index.md b/src/core/1/api/controllers/memory-storage/lpushx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lpushx/index.md rename to src/core/1/api/controllers/memory-storage/lpushx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lrange/index.md b/src/core/1/api/controllers/memory-storage/lrange/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lrange/index.md rename to src/core/1/api/controllers/memory-storage/lrange/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lrem/index.md b/src/core/1/api/controllers/memory-storage/lrem/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lrem/index.md rename to src/core/1/api/controllers/memory-storage/lrem/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/lset/index.md b/src/core/1/api/controllers/memory-storage/lset/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/lset/index.md rename to src/core/1/api/controllers/memory-storage/lset/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/ltrim/index.md b/src/core/1/api/controllers/memory-storage/ltrim/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/ltrim/index.md rename to src/core/1/api/controllers/memory-storage/ltrim/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/mget/index.md b/src/core/1/api/controllers/memory-storage/mget/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/mget/index.md rename to src/core/1/api/controllers/memory-storage/mget/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/mset/index.md b/src/core/1/api/controllers/memory-storage/mset/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/mset/index.md rename to src/core/1/api/controllers/memory-storage/mset/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/msetnx/index.md b/src/core/1/api/controllers/memory-storage/msetnx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/msetnx/index.md rename to src/core/1/api/controllers/memory-storage/msetnx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/object/index.md b/src/core/1/api/controllers/memory-storage/object/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/object/index.md rename to src/core/1/api/controllers/memory-storage/object/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/persist/index.md b/src/core/1/api/controllers/memory-storage/persist/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/persist/index.md rename to src/core/1/api/controllers/memory-storage/persist/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pexpire/index.md b/src/core/1/api/controllers/memory-storage/pexpire/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pexpire/index.md rename to src/core/1/api/controllers/memory-storage/pexpire/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pexpireat/index.md b/src/core/1/api/controllers/memory-storage/pexpireat/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pexpireat/index.md rename to src/core/1/api/controllers/memory-storage/pexpireat/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pfadd/index.md b/src/core/1/api/controllers/memory-storage/pfadd/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pfadd/index.md rename to src/core/1/api/controllers/memory-storage/pfadd/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pfcount/index.md b/src/core/1/api/controllers/memory-storage/pfcount/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pfcount/index.md rename to src/core/1/api/controllers/memory-storage/pfcount/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pfmerge/index.md b/src/core/1/api/controllers/memory-storage/pfmerge/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pfmerge/index.md rename to src/core/1/api/controllers/memory-storage/pfmerge/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/ping/index.md b/src/core/1/api/controllers/memory-storage/ping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/ping/index.md rename to src/core/1/api/controllers/memory-storage/ping/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/psetex/index.md b/src/core/1/api/controllers/memory-storage/psetex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/psetex/index.md rename to src/core/1/api/controllers/memory-storage/psetex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/pttl/index.md b/src/core/1/api/controllers/memory-storage/pttl/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/pttl/index.md rename to src/core/1/api/controllers/memory-storage/pttl/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/randomkey/index.md b/src/core/1/api/controllers/memory-storage/randomkey/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/randomkey/index.md rename to src/core/1/api/controllers/memory-storage/randomkey/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/rename/index.md b/src/core/1/api/controllers/memory-storage/rename/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/rename/index.md rename to src/core/1/api/controllers/memory-storage/rename/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/renamenx/index.md b/src/core/1/api/controllers/memory-storage/renamenx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/renamenx/index.md rename to src/core/1/api/controllers/memory-storage/renamenx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/rpop/index.md b/src/core/1/api/controllers/memory-storage/rpop/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/rpop/index.md rename to src/core/1/api/controllers/memory-storage/rpop/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/rpoplpush/index.md b/src/core/1/api/controllers/memory-storage/rpoplpush/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/rpoplpush/index.md rename to src/core/1/api/controllers/memory-storage/rpoplpush/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/rpush/index.md b/src/core/1/api/controllers/memory-storage/rpush/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/rpush/index.md rename to src/core/1/api/controllers/memory-storage/rpush/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/rpushx/index.md b/src/core/1/api/controllers/memory-storage/rpushx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/rpushx/index.md rename to src/core/1/api/controllers/memory-storage/rpushx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sadd/index.md b/src/core/1/api/controllers/memory-storage/sadd/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sadd/index.md rename to src/core/1/api/controllers/memory-storage/sadd/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/scan/index.md b/src/core/1/api/controllers/memory-storage/scan/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/scan/index.md rename to src/core/1/api/controllers/memory-storage/scan/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/scard/index.md b/src/core/1/api/controllers/memory-storage/scard/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/scard/index.md rename to src/core/1/api/controllers/memory-storage/scard/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sdiff/index.md b/src/core/1/api/controllers/memory-storage/sdiff/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sdiff/index.md rename to src/core/1/api/controllers/memory-storage/sdiff/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sdiffstore/index.md b/src/core/1/api/controllers/memory-storage/sdiffstore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sdiffstore/index.md rename to src/core/1/api/controllers/memory-storage/sdiffstore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/set/index.md b/src/core/1/api/controllers/memory-storage/set/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/set/index.md rename to src/core/1/api/controllers/memory-storage/set/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/setex/index.md b/src/core/1/api/controllers/memory-storage/setex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/setex/index.md rename to src/core/1/api/controllers/memory-storage/setex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/setnx/index.md b/src/core/1/api/controllers/memory-storage/setnx/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/setnx/index.md rename to src/core/1/api/controllers/memory-storage/setnx/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sinter/index.md b/src/core/1/api/controllers/memory-storage/sinter/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sinter/index.md rename to src/core/1/api/controllers/memory-storage/sinter/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sinterstore/index.md b/src/core/1/api/controllers/memory-storage/sinterstore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sinterstore/index.md rename to src/core/1/api/controllers/memory-storage/sinterstore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sismember/index.md b/src/core/1/api/controllers/memory-storage/sismember/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sismember/index.md rename to src/core/1/api/controllers/memory-storage/sismember/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/smembers/index.md b/src/core/1/api/controllers/memory-storage/smembers/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/smembers/index.md rename to src/core/1/api/controllers/memory-storage/smembers/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/smove/index.md b/src/core/1/api/controllers/memory-storage/smove/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/smove/index.md rename to src/core/1/api/controllers/memory-storage/smove/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sort/index.md b/src/core/1/api/controllers/memory-storage/sort/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sort/index.md rename to src/core/1/api/controllers/memory-storage/sort/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/spop/index.md b/src/core/1/api/controllers/memory-storage/spop/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/spop/index.md rename to src/core/1/api/controllers/memory-storage/spop/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/srandmember/index.md b/src/core/1/api/controllers/memory-storage/srandmember/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/srandmember/index.md rename to src/core/1/api/controllers/memory-storage/srandmember/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/srem/index.md b/src/core/1/api/controllers/memory-storage/srem/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/srem/index.md rename to src/core/1/api/controllers/memory-storage/srem/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sscan/index.md b/src/core/1/api/controllers/memory-storage/sscan/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sscan/index.md rename to src/core/1/api/controllers/memory-storage/sscan/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/strlen/index.md b/src/core/1/api/controllers/memory-storage/strlen/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/strlen/index.md rename to src/core/1/api/controllers/memory-storage/strlen/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sunion/index.md b/src/core/1/api/controllers/memory-storage/sunion/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sunion/index.md rename to src/core/1/api/controllers/memory-storage/sunion/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/sunionstore/index.md b/src/core/1/api/controllers/memory-storage/sunionstore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/sunionstore/index.md rename to src/core/1/api/controllers/memory-storage/sunionstore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/time/index.md b/src/core/1/api/controllers/memory-storage/time/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/time/index.md rename to src/core/1/api/controllers/memory-storage/time/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/touch/index.md b/src/core/1/api/controllers/memory-storage/touch/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/touch/index.md rename to src/core/1/api/controllers/memory-storage/touch/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/ttl/index.md b/src/core/1/api/controllers/memory-storage/ttl/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/ttl/index.md rename to src/core/1/api/controllers/memory-storage/ttl/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/type/index.md b/src/core/1/api/controllers/memory-storage/type/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/type/index.md rename to src/core/1/api/controllers/memory-storage/type/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zadd/index.md b/src/core/1/api/controllers/memory-storage/zadd/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zadd/index.md rename to src/core/1/api/controllers/memory-storage/zadd/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zcard/index.md b/src/core/1/api/controllers/memory-storage/zcard/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zcard/index.md rename to src/core/1/api/controllers/memory-storage/zcard/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zcount/index.md b/src/core/1/api/controllers/memory-storage/zcount/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zcount/index.md rename to src/core/1/api/controllers/memory-storage/zcount/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zincrby/index.md b/src/core/1/api/controllers/memory-storage/zincrby/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zincrby/index.md rename to src/core/1/api/controllers/memory-storage/zincrby/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zinterstore/index.md b/src/core/1/api/controllers/memory-storage/zinterstore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zinterstore/index.md rename to src/core/1/api/controllers/memory-storage/zinterstore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zlexcount/index.md b/src/core/1/api/controllers/memory-storage/zlexcount/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zlexcount/index.md rename to src/core/1/api/controllers/memory-storage/zlexcount/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrange/index.md b/src/core/1/api/controllers/memory-storage/zrange/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrange/index.md rename to src/core/1/api/controllers/memory-storage/zrange/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrangebylex/index.md b/src/core/1/api/controllers/memory-storage/zrangebylex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrangebylex/index.md rename to src/core/1/api/controllers/memory-storage/zrangebylex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrangebyscore/index.md b/src/core/1/api/controllers/memory-storage/zrangebyscore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrangebyscore/index.md rename to src/core/1/api/controllers/memory-storage/zrangebyscore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrank/index.md b/src/core/1/api/controllers/memory-storage/zrank/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrank/index.md rename to src/core/1/api/controllers/memory-storage/zrank/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrem/index.md b/src/core/1/api/controllers/memory-storage/zrem/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrem/index.md rename to src/core/1/api/controllers/memory-storage/zrem/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zremrangebylex/index.md b/src/core/1/api/controllers/memory-storage/zremrangebylex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zremrangebylex/index.md rename to src/core/1/api/controllers/memory-storage/zremrangebylex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zremrangebyrank/index.md b/src/core/1/api/controllers/memory-storage/zremrangebyrank/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zremrangebyrank/index.md rename to src/core/1/api/controllers/memory-storage/zremrangebyrank/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zremrangebyscore/index.md b/src/core/1/api/controllers/memory-storage/zremrangebyscore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zremrangebyscore/index.md rename to src/core/1/api/controllers/memory-storage/zremrangebyscore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrevrange/index.md b/src/core/1/api/controllers/memory-storage/zrevrange/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrevrange/index.md rename to src/core/1/api/controllers/memory-storage/zrevrange/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrevrangebylex/index.md b/src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrevrangebylex/index.md rename to src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrevrangebyscore/index.md b/src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrevrangebyscore/index.md rename to src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zrevrank/index.md b/src/core/1/api/controllers/memory-storage/zrevrank/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zrevrank/index.md rename to src/core/1/api/controllers/memory-storage/zrevrank/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zscan/index.md b/src/core/1/api/controllers/memory-storage/zscan/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zscan/index.md rename to src/core/1/api/controllers/memory-storage/zscan/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zscore/index.md b/src/core/1/api/controllers/memory-storage/zscore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zscore/index.md rename to src/core/1/api/controllers/memory-storage/zscore/index.md diff --git a/src/core/1/api/api-reference/controller-memory-storage/zunionstore/index.md b/src/core/1/api/controllers/memory-storage/zunionstore/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-memory-storage/zunionstore/index.md rename to src/core/1/api/controllers/memory-storage/zunionstore/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/count/index.md b/src/core/1/api/controllers/realtime/count/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/count/index.md rename to src/core/1/api/controllers/realtime/count/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/index.md b/src/core/1/api/controllers/realtime/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/index.md rename to src/core/1/api/controllers/realtime/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/join/index.md b/src/core/1/api/controllers/realtime/join/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/join/index.md rename to src/core/1/api/controllers/realtime/join/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/list/index.md b/src/core/1/api/controllers/realtime/list/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/list/index.md rename to src/core/1/api/controllers/realtime/list/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/publish/index.md b/src/core/1/api/controllers/realtime/publish/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/publish/index.md rename to src/core/1/api/controllers/realtime/publish/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/subscribe/index.md b/src/core/1/api/controllers/realtime/subscribe/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/subscribe/index.md rename to src/core/1/api/controllers/realtime/subscribe/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/unsubscribe/index.md b/src/core/1/api/controllers/realtime/unsubscribe/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/unsubscribe/index.md rename to src/core/1/api/controllers/realtime/unsubscribe/index.md diff --git a/src/core/1/api/api-reference/controller-realtime/validate/index.md b/src/core/1/api/controllers/realtime/validate/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-realtime/validate/index.md rename to src/core/1/api/controllers/realtime/validate/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-credentials/index.md b/src/core/1/api/controllers/security/create-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-credentials/index.md rename to src/core/1/api/controllers/security/create-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-first-admin/index.md b/src/core/1/api/controllers/security/create-first-admin/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-first-admin/index.md rename to src/core/1/api/controllers/security/create-first-admin/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-or-replace-profile/index.md b/src/core/1/api/controllers/security/create-or-replace-profile/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-or-replace-profile/index.md rename to src/core/1/api/controllers/security/create-or-replace-profile/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-or-replace-role/index.md b/src/core/1/api/controllers/security/create-or-replace-role/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-or-replace-role/index.md rename to src/core/1/api/controllers/security/create-or-replace-role/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-profile/index.md b/src/core/1/api/controllers/security/create-profile/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-profile/index.md rename to src/core/1/api/controllers/security/create-profile/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-restricted-user/index.md b/src/core/1/api/controllers/security/create-restricted-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-restricted-user/index.md rename to src/core/1/api/controllers/security/create-restricted-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-role/index.md b/src/core/1/api/controllers/security/create-role/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-role/index.md rename to src/core/1/api/controllers/security/create-role/index.md diff --git a/src/core/1/api/api-reference/controller-security/create-user/index.md b/src/core/1/api/controllers/security/create-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/create-user/index.md rename to src/core/1/api/controllers/security/create-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/delete-credentials/index.md b/src/core/1/api/controllers/security/delete-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/delete-credentials/index.md rename to src/core/1/api/controllers/security/delete-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-security/delete-profile/index.md b/src/core/1/api/controllers/security/delete-profile/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/delete-profile/index.md rename to src/core/1/api/controllers/security/delete-profile/index.md diff --git a/src/core/1/api/api-reference/controller-security/delete-role/index.md b/src/core/1/api/controllers/security/delete-role/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/delete-role/index.md rename to src/core/1/api/controllers/security/delete-role/index.md diff --git a/src/core/1/api/api-reference/controller-security/delete-user/index.md b/src/core/1/api/controllers/security/delete-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/delete-user/index.md rename to src/core/1/api/controllers/security/delete-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-all-credential-fields/index.md b/src/core/1/api/controllers/security/get-all-credential-fields/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-all-credential-fields/index.md rename to src/core/1/api/controllers/security/get-all-credential-fields/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-credential-fields/index.md b/src/core/1/api/controllers/security/get-credential-fields/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-credential-fields/index.md rename to src/core/1/api/controllers/security/get-credential-fields/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-credentials-by-id/index.md b/src/core/1/api/controllers/security/get-credentials-by-id/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-credentials-by-id/index.md rename to src/core/1/api/controllers/security/get-credentials-by-id/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-credentials/index.md b/src/core/1/api/controllers/security/get-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-credentials/index.md rename to src/core/1/api/controllers/security/get-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-profile-mapping/index.md b/src/core/1/api/controllers/security/get-profile-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-profile-mapping/index.md rename to src/core/1/api/controllers/security/get-profile-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-profile-rights/index.md b/src/core/1/api/controllers/security/get-profile-rights/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-profile-rights/index.md rename to src/core/1/api/controllers/security/get-profile-rights/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-profile/index.md b/src/core/1/api/controllers/security/get-profile/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-profile/index.md rename to src/core/1/api/controllers/security/get-profile/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-role-mapping/index.md b/src/core/1/api/controllers/security/get-role-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-role-mapping/index.md rename to src/core/1/api/controllers/security/get-role-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-role/index.md b/src/core/1/api/controllers/security/get-role/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-role/index.md rename to src/core/1/api/controllers/security/get-role/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-user-mapping/index.md b/src/core/1/api/controllers/security/get-user-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-user-mapping/index.md rename to src/core/1/api/controllers/security/get-user-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-user-rights/index.md b/src/core/1/api/controllers/security/get-user-rights/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-user-rights/index.md rename to src/core/1/api/controllers/security/get-user-rights/index.md diff --git a/src/core/1/api/api-reference/controller-security/get-user/index.md b/src/core/1/api/controllers/security/get-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/get-user/index.md rename to src/core/1/api/controllers/security/get-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/has-credentials/index.md b/src/core/1/api/controllers/security/has-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/has-credentials/index.md rename to src/core/1/api/controllers/security/has-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-security/index.md b/src/core/1/api/controllers/security/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/index.md rename to src/core/1/api/controllers/security/index.md diff --git a/src/core/1/api/api-reference/controller-security/m-delete-profiles/index.md b/src/core/1/api/controllers/security/m-delete-profiles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/m-delete-profiles/index.md rename to src/core/1/api/controllers/security/m-delete-profiles/index.md diff --git a/src/core/1/api/api-reference/controller-security/m-delete-roles/index.md b/src/core/1/api/controllers/security/m-delete-roles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/m-delete-roles/index.md rename to src/core/1/api/controllers/security/m-delete-roles/index.md diff --git a/src/core/1/api/api-reference/controller-security/m-delete-users/index.md b/src/core/1/api/controllers/security/m-delete-users/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/m-delete-users/index.md rename to src/core/1/api/controllers/security/m-delete-users/index.md diff --git a/src/core/1/api/api-reference/controller-security/m-get-profiles/index.md b/src/core/1/api/controllers/security/m-get-profiles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/m-get-profiles/index.md rename to src/core/1/api/controllers/security/m-get-profiles/index.md diff --git a/src/core/1/api/api-reference/controller-security/m-get-roles/index.md b/src/core/1/api/controllers/security/m-get-roles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/m-get-roles/index.md rename to src/core/1/api/controllers/security/m-get-roles/index.md diff --git a/src/core/1/api/api-reference/controller-security/replace-user/index.md b/src/core/1/api/controllers/security/replace-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/replace-user/index.md rename to src/core/1/api/controllers/security/replace-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/scroll-profiles/index.md b/src/core/1/api/controllers/security/scroll-profiles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/scroll-profiles/index.md rename to src/core/1/api/controllers/security/scroll-profiles/index.md diff --git a/src/core/1/api/api-reference/controller-security/scroll-users/index.md b/src/core/1/api/controllers/security/scroll-users/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/scroll-users/index.md rename to src/core/1/api/controllers/security/scroll-users/index.md diff --git a/src/core/1/api/api-reference/controller-security/search-profiles/index.md b/src/core/1/api/controllers/security/search-profiles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/search-profiles/index.md rename to src/core/1/api/controllers/security/search-profiles/index.md diff --git a/src/core/1/api/api-reference/controller-security/search-roles/index.md b/src/core/1/api/controllers/security/search-roles/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/search-roles/index.md rename to src/core/1/api/controllers/security/search-roles/index.md diff --git a/src/core/1/api/api-reference/controller-security/search-users/index.md b/src/core/1/api/controllers/security/search-users/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/search-users/index.md rename to src/core/1/api/controllers/security/search-users/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-credentials/index.md b/src/core/1/api/controllers/security/update-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-credentials/index.md rename to src/core/1/api/controllers/security/update-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-profile-mapping/index.md b/src/core/1/api/controllers/security/update-profile-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-profile-mapping/index.md rename to src/core/1/api/controllers/security/update-profile-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-profile/index.md b/src/core/1/api/controllers/security/update-profile/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-profile/index.md rename to src/core/1/api/controllers/security/update-profile/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-role-mapping/index.md b/src/core/1/api/controllers/security/update-role-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-role-mapping/index.md rename to src/core/1/api/controllers/security/update-role-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-role/index.md b/src/core/1/api/controllers/security/update-role/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-role/index.md rename to src/core/1/api/controllers/security/update-role/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-user-mapping/index.md b/src/core/1/api/controllers/security/update-user-mapping/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-user-mapping/index.md rename to src/core/1/api/controllers/security/update-user-mapping/index.md diff --git a/src/core/1/api/api-reference/controller-security/update-user/index.md b/src/core/1/api/controllers/security/update-user/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/update-user/index.md rename to src/core/1/api/controllers/security/update-user/index.md diff --git a/src/core/1/api/api-reference/controller-security/validate-credentials/index.md b/src/core/1/api/controllers/security/validate-credentials/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-security/validate-credentials/index.md rename to src/core/1/api/controllers/security/validate-credentials/index.md diff --git a/src/core/1/api/api-reference/controller-server/admin-exists/index.md b/src/core/1/api/controllers/server/admin-exists/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/admin-exists/index.md rename to src/core/1/api/controllers/server/admin-exists/index.md diff --git a/src/core/1/api/api-reference/controller-server/get-all-stats/index.md b/src/core/1/api/controllers/server/get-all-stats/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/get-all-stats/index.md rename to src/core/1/api/controllers/server/get-all-stats/index.md diff --git a/src/core/1/api/api-reference/controller-server/get-config/index.md b/src/core/1/api/controllers/server/get-config/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/get-config/index.md rename to src/core/1/api/controllers/server/get-config/index.md diff --git a/src/core/1/api/api-reference/controller-server/get-last-stats/index.md b/src/core/1/api/controllers/server/get-last-stats/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/get-last-stats/index.md rename to src/core/1/api/controllers/server/get-last-stats/index.md diff --git a/src/core/1/api/api-reference/controller-server/get-stats/index.md b/src/core/1/api/controllers/server/get-stats/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/get-stats/index.md rename to src/core/1/api/controllers/server/get-stats/index.md diff --git a/src/core/1/api/api-reference/controller-server/index.md b/src/core/1/api/controllers/server/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/index.md rename to src/core/1/api/controllers/server/index.md diff --git a/src/core/1/api/api-reference/controller-server/info/index.md b/src/core/1/api/controllers/server/info/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/info/index.md rename to src/core/1/api/controllers/server/info/index.md diff --git a/src/core/1/api/api-reference/controller-server/now/index.md b/src/core/1/api/controllers/server/now/index.md similarity index 100% rename from src/core/1/api/api-reference/controller-server/now/index.md rename to src/core/1/api/controllers/server/now/index.md diff --git a/src/core/1/guide/guides/index.md b/src/core/1/guide/guides/index.md deleted file mode 100644 index 03f1a02a6..000000000 --- a/src/core/1/guide/guides/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -code: false -type: branch -order: 0 -title: Guides -description: Guides ---- diff --git a/src/core/1/guide/code-examples/dbsearch/android/androidstudio_project_databasesearch.png b/src/core/1/guides/code-examples/dbsearch/android/androidstudio_project_databasesearch.png similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/android/androidstudio_project_databasesearch.png rename to src/core/1/guides/code-examples/dbsearch/android/androidstudio_project_databasesearch.png diff --git a/src/core/1/guide/code-examples/dbsearch/android/androidstudio_project_noactivity.png b/src/core/1/guides/code-examples/dbsearch/android/androidstudio_project_noactivity.png similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/android/androidstudio_project_noactivity.png rename to src/core/1/guides/code-examples/dbsearch/android/androidstudio_project_noactivity.png diff --git a/src/core/1/guide/code-examples/dbsearch/android/index.md b/src/core/1/guides/code-examples/dbsearch/android/index.md similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/android/index.md rename to src/core/1/guides/code-examples/dbsearch/android/index.md diff --git a/src/core/1/guide/code-examples/dbsearch/go/index.md b/src/core/1/guides/code-examples/dbsearch/go/index.md similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/go/index.md rename to src/core/1/guides/code-examples/dbsearch/go/index.md diff --git a/src/core/1/guide/code-examples/dbsearch/index.md b/src/core/1/guides/code-examples/dbsearch/index.md similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/index.md rename to src/core/1/guides/code-examples/dbsearch/index.md diff --git a/src/core/1/guide/code-examples/dbsearch/introduction/index.md b/src/core/1/guides/code-examples/dbsearch/introduction/index.md similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/introduction/index.md rename to src/core/1/guides/code-examples/dbsearch/introduction/index.md diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/index.md b/src/core/1/guides/code-examples/dbsearch/javascript/index.md similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/index.md rename to src/core/1/guides/code-examples/dbsearch/javascript/index.md diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/connect.js b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/connect.js similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/connect.js rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/connect.js diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/connect.test.yml b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/connect.test.yml similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/connect.test.yml rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/connect.test.yml diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/create.js b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/create.js similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/create.js rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/create.js diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/create.test.yml b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/create.test.yml similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/create.test.yml rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/create.test.yml diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/final.js b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/final.js similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/final.js rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/final.js diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/final.test.yml b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/final.test.yml similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/final.test.yml rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/final.test.yml diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/load-sdk.js b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/load-sdk.js similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/load-sdk.js rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/load-sdk.js diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/load-sdk.test.yml b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/load-sdk.test.yml similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/load-sdk.test.yml rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/load-sdk.test.yml diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/search.js b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/search.js similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/search.js rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/search.js diff --git a/src/core/1/guide/code-examples/dbsearch/javascript/snippets/search.test.yml b/src/core/1/guides/code-examples/dbsearch/javascript/snippets/search.test.yml similarity index 100% rename from src/core/1/guide/code-examples/dbsearch/javascript/snippets/search.test.yml rename to src/core/1/guides/code-examples/dbsearch/javascript/snippets/search.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/android/androidstudio_project_geofencing.png b/src/core/1/guides/code-examples/geofencing/android/androidstudio_project_geofencing.png similarity index 100% rename from src/core/1/guide/code-examples/geofencing/android/androidstudio_project_geofencing.png rename to src/core/1/guides/code-examples/geofencing/android/androidstudio_project_geofencing.png diff --git a/src/core/1/guide/code-examples/geofencing/android/androidstudio_project_noactivity.png b/src/core/1/guides/code-examples/geofencing/android/androidstudio_project_noactivity.png similarity index 100% rename from src/core/1/guide/code-examples/geofencing/android/androidstudio_project_noactivity.png rename to src/core/1/guides/code-examples/geofencing/android/androidstudio_project_noactivity.png diff --git a/src/core/1/guide/code-examples/geofencing/android/index.md b/src/core/1/guides/code-examples/geofencing/android/index.md similarity index 100% rename from src/core/1/guide/code-examples/geofencing/android/index.md rename to src/core/1/guides/code-examples/geofencing/android/index.md diff --git a/src/core/1/guide/code-examples/geofencing/go/index.md b/src/core/1/guides/code-examples/geofencing/go/index.md similarity index 100% rename from src/core/1/guide/code-examples/geofencing/go/index.md rename to src/core/1/guides/code-examples/geofencing/go/index.md diff --git a/src/core/1/guide/code-examples/geofencing/index.md b/src/core/1/guides/code-examples/geofencing/index.md similarity index 100% rename from src/core/1/guide/code-examples/geofencing/index.md rename to src/core/1/guides/code-examples/geofencing/index.md diff --git a/src/core/1/guide/code-examples/geofencing/introduction/index.md b/src/core/1/guides/code-examples/geofencing/introduction/index.md similarity index 100% rename from src/core/1/guide/code-examples/geofencing/introduction/index.md rename to src/core/1/guides/code-examples/geofencing/introduction/index.md diff --git a/src/core/1/guide/code-examples/geofencing/javascript/index.md b/src/core/1/guides/code-examples/geofencing/javascript/index.md similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/index.md rename to src/core/1/guides/code-examples/geofencing/javascript/index.md diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/createdoc.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/createdoc.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/createdoc.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/createdoc.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/createdoc.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/createdoc.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/createdoc.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/createdoc.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/definearea.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/definearea.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/definearea.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/definearea.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/definearea.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/definearea.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/definearea.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/definearea.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/geofenc.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/geofenc.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/geofenc.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/geofenc.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/geofenc.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/geofenc.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/geofenc.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/geofenc.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/load-sdk.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/load-sdk.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/load-sdk.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/load-sdk.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/load-sdk.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/load-sdk.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/load-sdk.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/load-sdk.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/location.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/location.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/location.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/location.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/location.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/location.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/location.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/location.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/subscribe.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/subscribe.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/subscribe.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/subscribe.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/subscribe.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/subscribe.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/subscribe.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/subscribe.test.yml diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/updatedoc.js b/src/core/1/guides/code-examples/geofencing/javascript/snippets/updatedoc.js similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/updatedoc.js rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/updatedoc.js diff --git a/src/core/1/guide/code-examples/geofencing/javascript/snippets/updatedoc.test.yml b/src/core/1/guides/code-examples/geofencing/javascript/snippets/updatedoc.test.yml similarity index 100% rename from src/core/1/guide/code-examples/geofencing/javascript/snippets/updatedoc.test.yml rename to src/core/1/guides/code-examples/geofencing/javascript/snippets/updatedoc.test.yml diff --git a/src/core/1/guide/code-examples/index.md b/src/core/1/guides/code-examples/index.md similarity index 88% rename from src/core/1/guide/code-examples/index.md rename to src/core/1/guides/code-examples/index.md index 9d3dcda04..530c227ab 100644 --- a/src/core/1/guide/code-examples/index.md +++ b/src/core/1/guides/code-examples/index.md @@ -1,7 +1,7 @@ --- code: false type: branch -order: 20 +order: 300 title: Code Examples description: Code Examples --- diff --git a/src/core/1/guide/code-examples/iot/android/androidstudio_project_iot.png b/src/core/1/guides/code-examples/iot/android/androidstudio_project_iot.png similarity index 100% rename from src/core/1/guide/code-examples/iot/android/androidstudio_project_iot.png rename to src/core/1/guides/code-examples/iot/android/androidstudio_project_iot.png diff --git a/src/core/1/guide/code-examples/iot/android/androidstudio_project_noactivity.png b/src/core/1/guides/code-examples/iot/android/androidstudio_project_noactivity.png similarity index 100% rename from src/core/1/guide/code-examples/iot/android/androidstudio_project_noactivity.png rename to src/core/1/guides/code-examples/iot/android/androidstudio_project_noactivity.png diff --git a/src/core/1/guide/code-examples/iot/android/index.md b/src/core/1/guides/code-examples/iot/android/index.md similarity index 100% rename from src/core/1/guide/code-examples/iot/android/index.md rename to src/core/1/guides/code-examples/iot/android/index.md diff --git a/src/core/1/guide/code-examples/iot/go/index.md b/src/core/1/guides/code-examples/iot/go/index.md similarity index 100% rename from src/core/1/guide/code-examples/iot/go/index.md rename to src/core/1/guides/code-examples/iot/go/index.md diff --git a/src/core/1/guide/code-examples/iot/index.md b/src/core/1/guides/code-examples/iot/index.md similarity index 100% rename from src/core/1/guide/code-examples/iot/index.md rename to src/core/1/guides/code-examples/iot/index.md diff --git a/src/core/1/guide/code-examples/iot/introduction/index.md b/src/core/1/guides/code-examples/iot/introduction/index.md similarity index 100% rename from src/core/1/guide/code-examples/iot/introduction/index.md rename to src/core/1/guides/code-examples/iot/introduction/index.md diff --git a/src/core/1/guide/code-examples/iot/javascript/index.md b/src/core/1/guides/code-examples/iot/javascript/index.md similarity index 100% rename from src/core/1/guide/code-examples/iot/javascript/index.md rename to src/core/1/guides/code-examples/iot/javascript/index.md diff --git a/src/core/1/guide/code-examples/iot/javascript/snippets/publish.js b/src/core/1/guides/code-examples/iot/javascript/snippets/publish.js similarity index 100% rename from src/core/1/guide/code-examples/iot/javascript/snippets/publish.js rename to src/core/1/guides/code-examples/iot/javascript/snippets/publish.js diff --git a/src/core/1/guide/code-examples/iot/javascript/snippets/publish.test.yml b/src/core/1/guides/code-examples/iot/javascript/snippets/publish.test.yml similarity index 100% rename from src/core/1/guide/code-examples/iot/javascript/snippets/publish.test.yml rename to src/core/1/guides/code-examples/iot/javascript/snippets/publish.test.yml diff --git a/src/core/1/guide/code-examples/iot/javascript/snippets/subscribe.js b/src/core/1/guides/code-examples/iot/javascript/snippets/subscribe.js similarity index 100% rename from src/core/1/guide/code-examples/iot/javascript/snippets/subscribe.js rename to src/core/1/guides/code-examples/iot/javascript/snippets/subscribe.js diff --git a/src/core/1/guide/code-examples/iot/javascript/snippets/subscribe.test.yml b/src/core/1/guides/code-examples/iot/javascript/snippets/subscribe.test.yml similarity index 100% rename from src/core/1/guide/code-examples/iot/javascript/snippets/subscribe.test.yml rename to src/core/1/guides/code-examples/iot/javascript/snippets/subscribe.test.yml diff --git a/src/core/1/guide/code-examples/pubsub/android/androidstudio_project_noactivity.png b/src/core/1/guides/code-examples/pubsub/android/androidstudio_project_noactivity.png similarity index 100% rename from src/core/1/guide/code-examples/pubsub/android/androidstudio_project_noactivity.png rename to src/core/1/guides/code-examples/pubsub/android/androidstudio_project_noactivity.png diff --git a/src/core/1/guide/code-examples/pubsub/android/androidstudio_project_pubsub.png b/src/core/1/guides/code-examples/pubsub/android/androidstudio_project_pubsub.png similarity index 100% rename from src/core/1/guide/code-examples/pubsub/android/androidstudio_project_pubsub.png rename to src/core/1/guides/code-examples/pubsub/android/androidstudio_project_pubsub.png diff --git a/src/core/1/guide/code-examples/pubsub/android/index.md b/src/core/1/guides/code-examples/pubsub/android/index.md similarity index 100% rename from src/core/1/guide/code-examples/pubsub/android/index.md rename to src/core/1/guides/code-examples/pubsub/android/index.md diff --git a/src/core/1/guide/code-examples/pubsub/go/index.md b/src/core/1/guides/code-examples/pubsub/go/index.md similarity index 100% rename from src/core/1/guide/code-examples/pubsub/go/index.md rename to src/core/1/guides/code-examples/pubsub/go/index.md diff --git a/src/core/1/guide/code-examples/pubsub/index.md b/src/core/1/guides/code-examples/pubsub/index.md similarity index 100% rename from src/core/1/guide/code-examples/pubsub/index.md rename to src/core/1/guides/code-examples/pubsub/index.md diff --git a/src/core/1/guide/code-examples/pubsub/introduction/index.md b/src/core/1/guides/code-examples/pubsub/introduction/index.md similarity index 100% rename from src/core/1/guide/code-examples/pubsub/introduction/index.md rename to src/core/1/guides/code-examples/pubsub/introduction/index.md diff --git a/src/core/1/guide/code-examples/pubsub/javascript/index.md b/src/core/1/guides/code-examples/pubsub/javascript/index.md similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/index.md rename to src/core/1/guides/code-examples/pubsub/javascript/index.md diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/load-sdk.js b/src/core/1/guides/code-examples/pubsub/javascript/snippets/load-sdk.js similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/load-sdk.js rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/load-sdk.js diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/load-sdk.test.yml b/src/core/1/guides/code-examples/pubsub/javascript/snippets/load-sdk.test.yml similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/load-sdk.test.yml rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/load-sdk.test.yml diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/publish.js b/src/core/1/guides/code-examples/pubsub/javascript/snippets/publish.js similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/publish.js rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/publish.js diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/publish.test.yml b/src/core/1/guides/code-examples/pubsub/javascript/snippets/publish.test.yml similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/publish.test.yml rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/publish.test.yml diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/pubsubjs.js b/src/core/1/guides/code-examples/pubsub/javascript/snippets/pubsubjs.js similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/pubsubjs.js rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/pubsubjs.js diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/pubsubjs.test.yml b/src/core/1/guides/code-examples/pubsub/javascript/snippets/pubsubjs.test.yml similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/pubsubjs.test.yml rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/pubsubjs.test.yml diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/subscribe.js b/src/core/1/guides/code-examples/pubsub/javascript/snippets/subscribe.js similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/subscribe.js rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/subscribe.js diff --git a/src/core/1/guide/code-examples/pubsub/javascript/snippets/subscribe.test.yml b/src/core/1/guides/code-examples/pubsub/javascript/snippets/subscribe.test.yml similarity index 100% rename from src/core/1/guide/code-examples/pubsub/javascript/snippets/subscribe.test.yml rename to src/core/1/guides/code-examples/pubsub/javascript/snippets/subscribe.test.yml diff --git a/src/core/1/guide/cookbooks/datavalidation/fields/index.md b/src/core/1/guides/cookbooks/datavalidation/fields/index.md similarity index 100% rename from src/core/1/guide/cookbooks/datavalidation/fields/index.md rename to src/core/1/guides/cookbooks/datavalidation/fields/index.md diff --git a/src/core/1/guide/cookbooks/datavalidation/index.md b/src/core/1/guides/cookbooks/datavalidation/index.md similarity index 100% rename from src/core/1/guide/cookbooks/datavalidation/index.md rename to src/core/1/guides/cookbooks/datavalidation/index.md diff --git a/src/core/1/guide/cookbooks/datavalidation/introduction/index.md b/src/core/1/guides/cookbooks/datavalidation/introduction/index.md similarity index 100% rename from src/core/1/guide/cookbooks/datavalidation/introduction/index.md rename to src/core/1/guides/cookbooks/datavalidation/introduction/index.md diff --git a/src/core/1/guide/cookbooks/datavalidation/schema/index.md b/src/core/1/guides/cookbooks/datavalidation/schema/index.md similarity index 100% rename from src/core/1/guide/cookbooks/datavalidation/schema/index.md rename to src/core/1/guides/cookbooks/datavalidation/schema/index.md diff --git a/src/core/1/guide/cookbooks/datavalidation/validators/index.md b/src/core/1/guides/cookbooks/datavalidation/validators/index.md similarity index 100% rename from src/core/1/guide/cookbooks/datavalidation/validators/index.md rename to src/core/1/guides/cookbooks/datavalidation/validators/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/basic-queries/index.md b/src/core/1/guides/cookbooks/elasticsearch/basic-queries/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/basic-queries/index.md rename to src/core/1/guides/cookbooks/elasticsearch/basic-queries/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/bool-query/index.md b/src/core/1/guides/cookbooks/elasticsearch/bool-query/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/bool-query/index.md rename to src/core/1/guides/cookbooks/elasticsearch/bool-query/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/data-insertion/index.md b/src/core/1/guides/cookbooks/elasticsearch/data-insertion/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/data-insertion/index.md rename to src/core/1/guides/cookbooks/elasticsearch/data-insertion/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/index.md b/src/core/1/guides/cookbooks/elasticsearch/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/index.md rename to src/core/1/guides/cookbooks/elasticsearch/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/installation/index.md b/src/core/1/guides/cookbooks/elasticsearch/installation/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/installation/index.md rename to src/core/1/guides/cookbooks/elasticsearch/installation/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/introduction/index.md b/src/core/1/guides/cookbooks/elasticsearch/introduction/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/introduction/index.md rename to src/core/1/guides/cookbooks/elasticsearch/introduction/index.md diff --git a/src/core/1/guide/cookbooks/elasticsearch/useful-commands/index.md b/src/core/1/guides/cookbooks/elasticsearch/useful-commands/index.md similarity index 100% rename from src/core/1/guide/cookbooks/elasticsearch/useful-commands/index.md rename to src/core/1/guides/cookbooks/elasticsearch/useful-commands/index.md diff --git a/src/core/1/guide/cookbooks/index.md b/src/core/1/guides/cookbooks/index.md similarity index 86% rename from src/core/1/guide/cookbooks/index.md rename to src/core/1/guides/cookbooks/index.md index 62df9282b..e8c75cc22 100644 --- a/src/core/1/guide/cookbooks/index.md +++ b/src/core/1/guides/cookbooks/index.md @@ -1,7 +1,7 @@ --- code: false type: branch -order: 10 +order: 400 title: Cookbooks description: Cookbooks --- diff --git a/src/core/1/guide/guides/essentials/cli/index.md b/src/core/1/guides/essentials/cli/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/cli/index.md rename to src/core/1/guides/essentials/cli/index.md diff --git a/src/core/1/guide/guides/essentials/configuration/index.md b/src/core/1/guides/essentials/configuration/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/configuration/index.md rename to src/core/1/guides/essentials/configuration/index.md diff --git a/src/core/1/guide/guides/essentials/data-validation/index.md b/src/core/1/guides/essentials/data-validation/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/data-validation/index.md rename to src/core/1/guides/essentials/data-validation/index.md diff --git a/src/core/1/guide/guides/essentials/database-mappings/index.md b/src/core/1/guides/essentials/database-mappings/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/database-mappings/index.md rename to src/core/1/guides/essentials/database-mappings/index.md diff --git a/src/core/1/guide/guides/essentials/document-metadata/index.md b/src/core/1/guides/essentials/document-metadata/index.md similarity index 96% rename from src/core/1/guide/guides/essentials/document-metadata/index.md rename to src/core/1/guides/essentials/document-metadata/index.md index fbdb046b1..9a5c43cff 100644 --- a/src/core/1/guide/guides/essentials/document-metadata/index.md +++ b/src/core/1/guides/essentials/document-metadata/index.md @@ -78,7 +78,7 @@ Here is an example of a Kuzzle response, containing a document's `_id` and `_sou ## How metadata are physically stored -Documents metadata are managed by Kuzzle and cannot be changed using the API. +Documents metadata are managed by Kuzzle and cannot be changed using the API. Metadata are stored in the `_kuzzle_info` field of each document in Elasticsearch. Elasticsearch might contain documents that don't have metadata. This can be the case for documents that were not inserted through Kuzzle. Such documents will automatically obtain metadata when they are updated through Kuzzle. @@ -118,4 +118,4 @@ Documents in the `trashcan` cannot be accessed, searched or counted, unless the Kuzzle will routinely search and permanently delete the oldest documents in the `trashcan`. This garbage collecting can be configured using the `services.garbageCollector` property in the Kuzzle [configuration file](/core/1/guide/guides/essentials/configuration/). In general, garbage collection works as follows: - When Kuzzle is started, it will check the `services.garbageCollector` property and wait the configured delay before running the garbage collection for the first time. -- If Kuzzle is in [overload](/core/1/plugins/events/core-overload) the garbage collecting will be postponed until the load is reduced. +- If Kuzzle is in [overload](/core/1/plugins/guides/events/core-overload) the garbage collecting will be postponed until the load is reduced. diff --git a/src/core/1/guide/guides/essentials/index.md b/src/core/1/guides/essentials/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/index.md rename to src/core/1/guides/essentials/index.md diff --git a/src/core/1/guide/guides/essentials/installing-console/index.md b/src/core/1/guides/essentials/installing-console/index.md similarity index 97% rename from src/core/1/guide/guides/essentials/installing-console/index.md rename to src/core/1/guides/essentials/installing-console/index.md index 57cf4e9e9..aed419cff 100644 --- a/src/core/1/guide/guides/essentials/installing-console/index.md +++ b/src/core/1/guides/essentials/installing-console/index.md @@ -1,11 +1,11 @@ --- code: false type: page -title: Install Kuzzle Admin Console +title: Kuzzle Admin Console order: 100 --- -# Installing Kuzzle Admin Console +# Kuzzle Admin Console The Kuzzle Admin Console is a web application that lets you manage Kuzzle, including **data**, **real-time notifications** and **security**. diff --git a/src/core/1/guide/guides/essentials/installing-console/kuzbo-connecting.png b/src/core/1/guides/essentials/installing-console/kuzbo-connecting.png similarity index 100% rename from src/core/1/guide/guides/essentials/installing-console/kuzbo-connecting.png rename to src/core/1/guides/essentials/installing-console/kuzbo-connecting.png diff --git a/src/core/1/guide/guides/essentials/installing-console/kuzbo-firstadmin.png b/src/core/1/guides/essentials/installing-console/kuzbo-firstadmin.png similarity index 100% rename from src/core/1/guide/guides/essentials/installing-console/kuzbo-firstadmin.png rename to src/core/1/guides/essentials/installing-console/kuzbo-firstadmin.png diff --git a/src/core/1/guide/guides/essentials/installing-kuzzle/index.md b/src/core/1/guides/essentials/installing-kuzzle/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/installing-kuzzle/index.md rename to src/core/1/guides/essentials/installing-kuzzle/index.md diff --git a/src/core/1/guide/guides/essentials/introduction/index.md b/src/core/1/guides/essentials/introduction/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/introduction/index.md rename to src/core/1/guides/essentials/introduction/index.md diff --git a/src/core/1/guide/guides/essentials/persisted/index.md b/src/core/1/guides/essentials/persisted/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/persisted/index.md rename to src/core/1/guides/essentials/persisted/index.md diff --git a/src/core/1/guide/guides/essentials/plugins/index.md b/src/core/1/guides/essentials/plugins/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/plugins/index.md rename to src/core/1/guides/essentials/plugins/index.md diff --git a/src/core/1/guide/guides/essentials/real-time/index.md b/src/core/1/guides/essentials/real-time/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/index.md rename to src/core/1/guides/essentials/real-time/index.md diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-filter.js b/src/core/1/guides/essentials/real-time/snippets/subscribe-filter.js similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-filter.js rename to src/core/1/guides/essentials/real-time/snippets/subscribe-filter.js diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-filter.test.yml b/src/core/1/guides/essentials/real-time/snippets/subscribe-filter.test.yml similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-filter.test.yml rename to src/core/1/guides/essentials/real-time/snippets/subscribe-filter.test.yml diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-no-filter.js b/src/core/1/guides/essentials/real-time/snippets/subscribe-no-filter.js similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-no-filter.js rename to src/core/1/guides/essentials/real-time/snippets/subscribe-no-filter.js diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-no-filter.test.yml b/src/core/1/guides/essentials/real-time/snippets/subscribe-no-filter.test.yml similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-no-filter.test.yml rename to src/core/1/guides/essentials/real-time/snippets/subscribe-no-filter.test.yml diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-options.js b/src/core/1/guides/essentials/real-time/snippets/subscribe-options.js similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-options.js rename to src/core/1/guides/essentials/real-time/snippets/subscribe-options.js diff --git a/src/core/1/guide/guides/essentials/real-time/snippets/subscribe-options.test.yml b/src/core/1/guides/essentials/real-time/snippets/subscribe-options.test.yml similarity index 100% rename from src/core/1/guide/guides/essentials/real-time/snippets/subscribe-options.test.yml rename to src/core/1/guides/essentials/real-time/snippets/subscribe-options.test.yml diff --git a/src/core/1/guide/guides/essentials/request-and-response-format/index.md b/src/core/1/guides/essentials/request-and-response-format/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/request-and-response-format/index.md rename to src/core/1/guides/essentials/request-and-response-format/index.md diff --git a/src/core/1/guide/guides/essentials/security/index.md b/src/core/1/guides/essentials/security/index.md similarity index 95% rename from src/core/1/guide/guides/essentials/security/index.md rename to src/core/1/guides/essentials/security/index.md index 239bf733f..7f29f6281 100644 --- a/src/core/1/guide/guides/essentials/security/index.md +++ b/src/core/1/guides/essentials/security/index.md @@ -208,6 +208,6 @@ For instance, suppose you have a chat application and you want the users to only There are multiple ways of adding a business logic layer on top of the standard Kuzzle security one: -* With a [Pipe Plugin](/core/1/plugins/plugins/essentials/pipes), you can listen to one or multiple [API events](/core/1/plugins/plugins/events/), and decide whether you accept a query or document according to your business rules (you can see an example on [Github](https://github.com/kuzzleio/kuzzle-plugin-sample-custom-policies)) +* With a [Pipe Plugin](/core/1/plugins/essentials/pipes), you can listen to one or multiple [API events](/core/1/plugins/guides/events/), and decide whether you accept a query or document according to your business rules (you can see an example on [Github](https://github.com/kuzzleio/kuzzle-plugin-sample-custom-policies)) * If all you need is to make sure that submitted documents follow a strict set of formatting rules, you can add [document validators](/core/1/guide/cookbooks/datavalidation/) * Using Permission Closures, you can add functions directly into role definitions \ No newline at end of file diff --git a/src/core/1/guide/guides/essentials/security/profiles-roles.png b/src/core/1/guides/essentials/security/profiles-roles.png similarity index 100% rename from src/core/1/guide/guides/essentials/security/profiles-roles.png rename to src/core/1/guides/essentials/security/profiles-roles.png diff --git a/src/core/1/guide/guides/essentials/signal-handling/index.md b/src/core/1/guides/essentials/signal-handling/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/signal-handling/index.md rename to src/core/1/guides/essentials/signal-handling/index.md diff --git a/src/core/1/guide/guides/essentials/user-authentication/index.md b/src/core/1/guides/essentials/user-authentication/index.md similarity index 100% rename from src/core/1/guide/guides/essentials/user-authentication/index.md rename to src/core/1/guides/essentials/user-authentication/index.md diff --git a/src/core/1/guide/guides/essentials/user-authentication/snippets/login.js b/src/core/1/guides/essentials/user-authentication/snippets/login.js similarity index 100% rename from src/core/1/guide/guides/essentials/user-authentication/snippets/login.js rename to src/core/1/guides/essentials/user-authentication/snippets/login.js diff --git a/src/core/1/guide/guides/essentials/user-authentication/snippets/login.test.yml b/src/core/1/guides/essentials/user-authentication/snippets/login.test.yml similarity index 100% rename from src/core/1/guide/guides/essentials/user-authentication/snippets/login.test.yml rename to src/core/1/guides/essentials/user-authentication/snippets/login.test.yml diff --git a/src/core/1/guide/guides/getting-started/first-steps/index.md b/src/core/1/guides/getting-started/first-steps/index.md similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/index.md rename to src/core/1/guides/getting-started/first-steps/index.md diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/create.js b/src/core/1/guides/getting-started/first-steps/snippets/create.js similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/create.js rename to src/core/1/guides/getting-started/first-steps/snippets/create.js diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/create.test.yml b/src/core/1/guides/getting-started/first-steps/snippets/create.test.yml similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/create.test.yml rename to src/core/1/guides/getting-started/first-steps/snippets/create.test.yml diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/init-sample.js b/src/core/1/guides/getting-started/first-steps/snippets/init-sample.js similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/init-sample.js rename to src/core/1/guides/getting-started/first-steps/snippets/init-sample.js diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/init-sample.test.yml b/src/core/1/guides/getting-started/first-steps/snippets/init-sample.test.yml similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/init-sample.test.yml rename to src/core/1/guides/getting-started/first-steps/snippets/init-sample.test.yml diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/init.js b/src/core/1/guides/getting-started/first-steps/snippets/init.js similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/init.js rename to src/core/1/guides/getting-started/first-steps/snippets/init.js diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/init.test.yml b/src/core/1/guides/getting-started/first-steps/snippets/init.test.yml similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/init.test.yml rename to src/core/1/guides/getting-started/first-steps/snippets/init.test.yml diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/load-sdk.js b/src/core/1/guides/getting-started/first-steps/snippets/load-sdk.js similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/load-sdk.js rename to src/core/1/guides/getting-started/first-steps/snippets/load-sdk.js diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/load-sdk.test.yml b/src/core/1/guides/getting-started/first-steps/snippets/load-sdk.test.yml similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/load-sdk.test.yml rename to src/core/1/guides/getting-started/first-steps/snippets/load-sdk.test.yml diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/subscribe.js b/src/core/1/guides/getting-started/first-steps/snippets/subscribe.js similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/subscribe.js rename to src/core/1/guides/getting-started/first-steps/snippets/subscribe.js diff --git a/src/core/1/guide/guides/getting-started/first-steps/snippets/subscribe.test.yml b/src/core/1/guides/getting-started/first-steps/snippets/subscribe.test.yml similarity index 100% rename from src/core/1/guide/guides/getting-started/first-steps/snippets/subscribe.test.yml rename to src/core/1/guides/getting-started/first-steps/snippets/subscribe.test.yml diff --git a/src/core/1/guide/guides/getting-started/index.md b/src/core/1/guides/getting-started/index.md similarity index 100% rename from src/core/1/guide/guides/getting-started/index.md rename to src/core/1/guides/getting-started/index.md diff --git a/src/core/1/guide/guides/getting-started/running-kuzzle/index.md b/src/core/1/guides/getting-started/running-kuzzle/index.md similarity index 100% rename from src/core/1/guide/guides/getting-started/running-kuzzle/index.md rename to src/core/1/guides/getting-started/running-kuzzle/index.md diff --git a/src/core/1/guide/index.md b/src/core/1/guides/index.md similarity index 100% rename from src/core/1/guide/index.md rename to src/core/1/guides/index.md diff --git a/src/core/1/guide/guides/kuzzle-depth/architecture/Kuzzle_Server_Architecture.png b/src/core/1/guides/kuzzle-depth/architecture/Kuzzle_Server_Architecture.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/architecture/Kuzzle_Server_Architecture.png rename to src/core/1/guides/kuzzle-depth/architecture/Kuzzle_Server_Architecture.png diff --git a/src/core/1/guide/guides/kuzzle-depth/architecture/index.md b/src/core/1/guides/kuzzle-depth/architecture/index.md similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/architecture/index.md rename to src/core/1/guides/kuzzle-depth/architecture/index.md diff --git a/src/core/1/guide/guides/kuzzle-depth/authentication/Authentication_Overview.png b/src/core/1/guides/kuzzle-depth/authentication/Authentication_Overview.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/authentication/Authentication_Overview.png rename to src/core/1/guides/kuzzle-depth/authentication/Authentication_Overview.png diff --git a/src/core/1/guide/guides/kuzzle-depth/authentication/details-local.png b/src/core/1/guides/kuzzle-depth/authentication/details-local.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/authentication/details-local.png rename to src/core/1/guides/kuzzle-depth/authentication/details-local.png diff --git a/src/core/1/guide/guides/kuzzle-depth/authentication/details-oauth2.png b/src/core/1/guides/kuzzle-depth/authentication/details-oauth2.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/authentication/details-oauth2.png rename to src/core/1/guides/kuzzle-depth/authentication/details-oauth2.png diff --git a/src/core/1/guide/guides/kuzzle-depth/authentication/index.md b/src/core/1/guides/kuzzle-depth/authentication/index.md similarity index 98% rename from src/core/1/guide/guides/kuzzle-depth/authentication/index.md rename to src/core/1/guides/kuzzle-depth/authentication/index.md index 0747185bd..2da248b44 100644 --- a/src/core/1/guide/guides/kuzzle-depth/authentication/index.md +++ b/src/core/1/guides/kuzzle-depth/authentication/index.md @@ -55,7 +55,7 @@ The Local Authentication Strategy, implemented in the [Passport Local Plugin](ht - The _Passport Wrapper_ calls the `verify()` method in the _Local Authentication Plugin_. -- The _Local Authentication Plugin_ validates the credentials against the [local storage](/core/1/plugins/constructors/repository) and returns the user's `kuid` if the credentials are valid. +- The _Local Authentication Plugin_ validates the credentials against the [local storage](/core/1/plugins/plugin-context/constructors/repository) and returns the user's `kuid` if the credentials are valid. - The _Passport Wrapper_ calls the _User Repository_ to get the profile data for the user with the given `kuid`. diff --git a/src/core/1/guide/guides/kuzzle-depth/index.md b/src/core/1/guides/kuzzle-depth/index.md similarity index 88% rename from src/core/1/guide/guides/kuzzle-depth/index.md rename to src/core/1/guides/kuzzle-depth/index.md index 9ac786c72..1da2eba84 100644 --- a/src/core/1/guide/guides/kuzzle-depth/index.md +++ b/src/core/1/guides/kuzzle-depth/index.md @@ -2,7 +2,7 @@ code: false type: branch title: Kuzzle in Depth -order: 300 +order: 500 --- diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Overview.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Overview.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Overview.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Overview.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Directly.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Directly.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Directly.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Directly.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Indirectly.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Indirectly.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Indirectly.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Publishing_Indirectly.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Subscription.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Subscription.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Subscription.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Asynchronous_Communication_Subscription.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Overview.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Overview.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Overview.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Overview.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Sequence.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Sequence.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Sequence.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_HTTP_Protocol_Sequence.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Overview.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Overview.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Overview.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Overview.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Sequence.png b/src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Sequence.png similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Sequence.png rename to src/core/1/guides/kuzzle-depth/request-life-cycle/Synchronous_Request_Websocket_Protocol_Sequence.png diff --git a/src/core/1/guide/guides/kuzzle-depth/request-life-cycle/index.md b/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/request-life-cycle/index.md rename to src/core/1/guides/kuzzle-depth/request-life-cycle/index.md diff --git a/src/core/1/guide/guides/kuzzle-depth/roles-definitions/index.md b/src/core/1/guides/kuzzle-depth/roles-definitions/index.md similarity index 100% rename from src/core/1/guide/guides/kuzzle-depth/roles-definitions/index.md rename to src/core/1/guides/kuzzle-depth/roles-definitions/index.md diff --git a/src/core/1/koncorde/essentials/index.md b/src/core/1/koncorde/essentials/index.md index 146b73a4f..08c9357e3 100644 --- a/src/core/1/koncorde/essentials/index.md +++ b/src/core/1/koncorde/essentials/index.md @@ -2,6 +2,6 @@ code: false type: branch title: Essentials -description: Introduction to the plugin engine +description: Data percolation engine order: 0 --- diff --git a/src/core/1/plugins/plugins/essentials/available-plugins/index.md b/src/core/1/plugins/essentials/available-plugins/index.md similarity index 100% rename from src/core/1/plugins/plugins/essentials/available-plugins/index.md rename to src/core/1/plugins/essentials/available-plugins/index.md diff --git a/src/core/1/plugins/plugins/essentials/getting-started/index.md b/src/core/1/plugins/essentials/getting-started/index.md similarity index 89% rename from src/core/1/plugins/plugins/essentials/getting-started/index.md rename to src/core/1/plugins/essentials/getting-started/index.md index 3be8cd54e..4f325340f 100644 --- a/src/core/1/plugins/plugins/essentials/getting-started/index.md +++ b/src/core/1/plugins/essentials/getting-started/index.md @@ -32,10 +32,10 @@ The provided `docker-compose.yml` file launches a Kuzzle stack with the `pm2` mo The main Plugin class is defined in the `index.js`. You can start edit it adding: -- [Hooks](/core/1/plugins/hooks/) -- [Pipes](/core/1/plugins/pipes/) -- [Controllers](/core/1/plugins/controllers/) -- [Authentication Strategies](/core/1/plugins/strategies/overview/) +- [Hooks](/core/1/plugins/guides/hooks/) +- [Pipes](/core/1/plugins/guides/pipes/) +- [Controllers](/core/1/plugins/guides/controllers/) +- [Authentication Strategies](/core/1/plugins/guides/strategies/overview/) We need to provide the `configuration` and the `context` to plugins. In that purpose, plugins must have an `init` function which will have them as parameters : this `init` function is the very first one to be called by Kuzzle and is mandatory to start a plugin. You can now write your own functions and your own routes as described inside the `index.js`. You can also write unit tests : see `steps.js`. diff --git a/src/core/1/plugins/plugins/essentials/index.md b/src/core/1/plugins/essentials/index.md similarity index 100% rename from src/core/1/plugins/plugins/essentials/index.md rename to src/core/1/plugins/essentials/index.md diff --git a/src/core/1/plugins/plugins/essentials/introduction/index.md b/src/core/1/plugins/essentials/introduction/index.md similarity index 64% rename from src/core/1/plugins/plugins/essentials/introduction/index.md rename to src/core/1/plugins/essentials/introduction/index.md index df326b93b..90fcda687 100644 --- a/src/core/1/plugins/plugins/essentials/introduction/index.md +++ b/src/core/1/plugins/essentials/introduction/index.md @@ -12,9 +12,9 @@ Kuzzle can be customized and extended using plugins. This page explains how to install and configure a plugin. The other pages cover the four plugin interfaces exposed by Kuzzle: -- [Hooks](/core/1/plugins/hooks/) -- [Pipes](/core/1/plugins/pipes/) -- [Controllers](/core/1/plugins/controllers/) -- [Authentication Strategies](/core/1/plugins/strategies/overview/) +- [Hooks](/core/1/plugins/guides/hooks/) +- [Pipes](/core/1/plugins/guides/pipes/) +- [Controllers](/core/1/plugins/guides/controllers/) +- [Authentication Strategies](/core/1/plugins/guides/strategies/overview/) A single plugin can implement as many of those interfaces as necessary. diff --git a/src/core/1/plugins/plugins/controllers/index.md b/src/core/1/plugins/guides/controllers/index.md similarity index 96% rename from src/core/1/plugins/plugins/controllers/index.md rename to src/core/1/plugins/guides/controllers/index.md index 67f88df8b..87329cc96 100644 --- a/src/core/1/plugins/plugins/controllers/index.md +++ b/src/core/1/plugins/guides/controllers/index.md @@ -44,13 +44,13 @@ In order to create a new controller, the plugin must expose the following proper - A `controllers` object, describing the controller(s) to add. It will automatically be made available to any network protocol, except for HTTP - A `routes` objects, describing how the controller(s) should be exposed to the HTTP protocol -- The controller's actions, which are functions taking a `Request` object as an argument. These functions must return a promise, resolved with the action's result, or rejected with a [KuzzleError](/core/1/plugins/errors/kuzzleerror) object. +- The controller's actions, which are functions taking a `Request` object as an argument. These functions must return a promise, resolved with the action's result, or rejected with a [KuzzleError](/core/1/plugins/plugin-context/errors/kuzzleerror) object. --- ## Query normalization -Kuzzle normalizes [queries](/core/1/api/essentials/query-syntax) into [Request](/core/1/plugins/constructors/request) objects. +Kuzzle normalizes [queries](/core/1/api/essentials/query-syntax) into [Request](/core/1/plugins/plugin-context/constructors/request) objects. Quick summary of how queries are normalized: @@ -72,7 +72,7 @@ Quick summary of how queries are normalized: Kuzzle triggers events on all controller routes, including those added by plugins. -Read more about these automatic controller events [here](/core/1/plugins/events/). +Read more about these automatic controller events [here](/core/1/plugins/guides/events/). --- @@ -114,7 +114,7 @@ module.exports = class ControllerPlugin { - url: HTTP address. Any parameter starting with a ':' will be made dynamic by Kuzzle (its value is stored in request.input.args) - controller: plugin controller name, as exposed in the "this.controllers" object - - action: controller action to execute + - action: controller action to execute The first route exposes the following GET URL: http://:/_plugin//foo/ diff --git a/src/core/1/plugins/plugins/events/api-events/index.md b/src/core/1/plugins/guides/events/api-events/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/api-events/index.md rename to src/core/1/plugins/guides/events/api-events/index.md diff --git a/src/core/1/plugins/plugins/events/auth-strategy-authenticated/index.md b/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md similarity index 96% rename from src/core/1/plugins/plugins/events/auth-strategy-authenticated/index.md rename to src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md index 4932c86e8..ef1c9bd72 100644 --- a/src/core/1/plugins/plugins/events/auth-strategy-authenticated/index.md +++ b/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md @@ -15,7 +15,7 @@ title: auth:strategyAuthenticated This event is triggered after a successful user authentication, but before a token is generated. -It is also triggered before the [auth:afterLogin](/core/1/plugins/events/api-events/#after-default) event. +It is also triggered before the [auth:afterLogin](/core/1/plugins/guides/events/api-events/#after-default) event. --- diff --git a/src/core/1/plugins/plugins/events/core-auth-strategy-added/index.md b/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md similarity index 95% rename from src/core/1/plugins/plugins/events/core-auth-strategy-added/index.md rename to src/core/1/plugins/guides/events/core-auth-strategy-added/index.md index dc27629a5..aa6b6f792 100644 --- a/src/core/1/plugins/plugins/events/core-auth-strategy-added/index.md +++ b/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md @@ -12,7 +12,7 @@ title: core:auth:strategyAdded | ---------- | ----------------- | ----------------------------------- | | `strategy` | 
object
| Authentication strategy information | -Triggered whenever a plugin [dynamically registers](/core/1/plugins/accessors/strategies/) an authentication strategy. +Triggered whenever a plugin [dynamically registers](/core/1/plugins/plugin-context/accessors/strategies/) an authentication strategy.
Pipes cannot listen to that event, only hooks can.
diff --git a/src/core/1/plugins/plugins/events/core-auth-strategy-removed/index.md b/src/core/1/plugins/guides/events/core-auth-strategy-removed/index.md similarity index 94% rename from src/core/1/plugins/plugins/events/core-auth-strategy-removed/index.md rename to src/core/1/plugins/guides/events/core-auth-strategy-removed/index.md index d6fa82a5c..abb87310f 100644 --- a/src/core/1/plugins/plugins/events/core-auth-strategy-removed/index.md +++ b/src/core/1/plugins/guides/events/core-auth-strategy-removed/index.md @@ -12,7 +12,7 @@ title: core:auth:strategyRemoved | ---------- | ----------------- | ----------------------------------- | | `strategy` | 
object
| Authentication strategy information | -Triggered whenever a plugin [dynamically removes](/core/1/plugins/accessors/strategies/) an authentication strategy. +Triggered whenever a plugin [dynamically removes](/core/1/plugins/plugin-context/accessors/strategies/) an authentication strategy.
Pipes cannot listen to that event, only hooks can.
diff --git a/src/core/1/plugins/plugins/events/core-kuzzle-start/index.md b/src/core/1/plugins/guides/events/core-kuzzle-start/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/core-kuzzle-start/index.md rename to src/core/1/plugins/guides/events/core-kuzzle-start/index.md diff --git a/src/core/1/plugins/plugins/events/core-overload/index.md b/src/core/1/plugins/guides/events/core-overload/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/core-overload/index.md rename to src/core/1/plugins/guides/events/core-overload/index.md diff --git a/src/core/1/plugins/plugins/events/http-delete/index.md b/src/core/1/plugins/guides/events/http-delete/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-delete/index.md rename to src/core/1/plugins/guides/events/http-delete/index.md diff --git a/src/core/1/plugins/plugins/events/http-get/index.md b/src/core/1/plugins/guides/events/http-get/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-get/index.md rename to src/core/1/plugins/guides/events/http-get/index.md diff --git a/src/core/1/plugins/plugins/events/http-head/index.md b/src/core/1/plugins/guides/events/http-head/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-head/index.md rename to src/core/1/plugins/guides/events/http-head/index.md diff --git a/src/core/1/plugins/plugins/events/http-options/index.md b/src/core/1/plugins/guides/events/http-options/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-options/index.md rename to src/core/1/plugins/guides/events/http-options/index.md diff --git a/src/core/1/plugins/plugins/events/http-patch/index.md b/src/core/1/plugins/guides/events/http-patch/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-patch/index.md rename to src/core/1/plugins/guides/events/http-patch/index.md diff --git a/src/core/1/plugins/plugins/events/http-post/index.md b/src/core/1/plugins/guides/events/http-post/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-post/index.md rename to src/core/1/plugins/guides/events/http-post/index.md diff --git a/src/core/1/plugins/plugins/events/http-put/index.md b/src/core/1/plugins/guides/events/http-put/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/http-put/index.md rename to src/core/1/plugins/guides/events/http-put/index.md diff --git a/src/core/1/plugins/plugins/events/index.md b/src/core/1/plugins/guides/events/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/index.md rename to src/core/1/plugins/guides/events/index.md diff --git a/src/core/1/plugins/plugins/events/intro/index.md b/src/core/1/plugins/guides/events/intro/index.md similarity index 57% rename from src/core/1/plugins/plugins/events/intro/index.md rename to src/core/1/plugins/guides/events/intro/index.md index 197c19181..ad36576ba 100644 --- a/src/core/1/plugins/plugins/events/intro/index.md +++ b/src/core/1/plugins/guides/events/intro/index.md @@ -12,4 +12,4 @@ Kuzzle emits numerous events, especially for API requests. Plugins can [listen](/core/1/plugins/essentials/) to events. -And if a plugin adds new API [controllers](/core/1/plugins/controllers), then Kuzzle automatically triggers [dedicated events](/core/1/plugins/events/plugin-events). +And if a plugin adds new API [controllers](/core/1/plugins/guides/controllers), then Kuzzle automatically triggers [dedicated events](/core/1/plugins/guides/events/plugin-events). diff --git a/src/core/1/plugins/plugins/events/notify-dispatch/index.md b/src/core/1/plugins/guides/events/notify-dispatch/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/notify-dispatch/index.md rename to src/core/1/plugins/guides/events/notify-dispatch/index.md diff --git a/src/core/1/plugins/plugins/events/notify-document/index.md b/src/core/1/plugins/guides/events/notify-document/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/notify-document/index.md rename to src/core/1/plugins/guides/events/notify-document/index.md diff --git a/src/core/1/plugins/plugins/events/notify-server/index.md b/src/core/1/plugins/guides/events/notify-server/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/notify-server/index.md rename to src/core/1/plugins/guides/events/notify-server/index.md diff --git a/src/core/1/plugins/plugins/events/notify-user/index.md b/src/core/1/plugins/guides/events/notify-user/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/notify-user/index.md rename to src/core/1/plugins/guides/events/notify-user/index.md diff --git a/src/core/1/plugins/plugins/events/plugin-events/index.md b/src/core/1/plugins/guides/events/plugin-events/index.md similarity index 98% rename from src/core/1/plugins/plugins/events/plugin-events/index.md rename to src/core/1/plugins/guides/events/plugin-events/index.md index 6440f66f5..07b8c7c0e 100644 --- a/src/core/1/plugins/plugins/events/plugin-events/index.md +++ b/src/core/1/plugins/guides/events/plugin-events/index.md @@ -11,7 +11,7 @@ order: 200 Plugins can [add new controllers](/core/1/plugins/essentials/controllers) to the Kuzzle API. -These new controllers and actions behave exactly like [native API actions](/core/1/plugins/events/api-events/). +These new controllers and actions behave exactly like [native API actions](/core/1/plugins/guides/events/api-events/). All calls to plugins API actions trigger two of these three events: - before the action starts diff --git a/src/core/1/plugins/plugins/events/request-on-authorized/index.md b/src/core/1/plugins/guides/events/request-on-authorized/index.md similarity index 83% rename from src/core/1/plugins/plugins/events/request-on-authorized/index.md rename to src/core/1/plugins/guides/events/request-on-authorized/index.md index 885fcb284..71de9afd6 100644 --- a/src/core/1/plugins/plugins/events/request-on-authorized/index.md +++ b/src/core/1/plugins/guides/events/request-on-authorized/index.md @@ -14,4 +14,4 @@ title: request:onAuthorized Triggered whenever a request passes authorization checks and is ready to be processed. -This event occurs before [before events](/core/1/plugins/events/api-events/#before-default). +This event occurs before [before events](/core/1/plugins/guides/events/api-events/#before-default). diff --git a/src/core/1/plugins/plugins/events/request-on-error/index.md b/src/core/1/plugins/guides/events/request-on-error/index.md similarity index 82% rename from src/core/1/plugins/plugins/events/request-on-error/index.md rename to src/core/1/plugins/guides/events/request-on-error/index.md index d87735fbd..b064c750e 100644 --- a/src/core/1/plugins/plugins/events/request-on-error/index.md +++ b/src/core/1/plugins/guides/events/request-on-error/index.md @@ -14,4 +14,4 @@ title: request:onError Triggered whenever a request execution fails. -This event occurs after [error events](/core/1/plugins/events/api-events/#error-default). +This event occurs after [error events](/core/1/plugins/guides/events/api-events/#error-default). diff --git a/src/core/1/plugins/plugins/events/request-on-success/index.md b/src/core/1/plugins/guides/events/request-on-success/index.md similarity index 82% rename from src/core/1/plugins/plugins/events/request-on-success/index.md rename to src/core/1/plugins/guides/events/request-on-success/index.md index 9c5c2508e..d8c6b40f8 100644 --- a/src/core/1/plugins/plugins/events/request-on-success/index.md +++ b/src/core/1/plugins/guides/events/request-on-success/index.md @@ -14,4 +14,4 @@ title: request:onSuccess Triggered whenever a request execution succeeds. -This event occurs after [after events](/core/1/plugins/events/api-events/#after-default). +This event occurs after [after events](/core/1/plugins/guides/events/api-events/#after-default). diff --git a/src/core/1/plugins/plugins/events/request-on-unauthorized/index.md b/src/core/1/plugins/guides/events/request-on-unauthorized/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/request-on-unauthorized/index.md rename to src/core/1/plugins/guides/events/request-on-unauthorized/index.md diff --git a/src/core/1/plugins/plugins/events/room-new/index.md b/src/core/1/plugins/guides/events/room-new/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/room-new/index.md rename to src/core/1/plugins/guides/events/room-new/index.md diff --git a/src/core/1/plugins/plugins/events/room-remove/index.md b/src/core/1/plugins/guides/events/room-remove/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/room-remove/index.md rename to src/core/1/plugins/guides/events/room-remove/index.md diff --git a/src/core/1/plugins/plugins/events/security-format-user-for-serialization/index.md b/src/core/1/plugins/guides/events/security-format-user-for-serialization/index.md similarity index 100% rename from src/core/1/plugins/plugins/events/security-format-user-for-serialization/index.md rename to src/core/1/plugins/guides/events/security-format-user-for-serialization/index.md diff --git a/src/core/1/plugins/plugins/hooks/index.md b/src/core/1/plugins/guides/hooks/index.md similarity index 81% rename from src/core/1/plugins/plugins/hooks/index.md rename to src/core/1/plugins/guides/hooks/index.md index c753b8be5..90bfaf3f0 100644 --- a/src/core/1/plugins/plugins/hooks/index.md +++ b/src/core/1/plugins/guides/hooks/index.md @@ -7,7 +7,7 @@ order: 200 # Hooks -Hooks are asynchronous listeners, plugged to [events](/core/1/plugins/events), and receiving information regarding that event. +Hooks are asynchronous listeners, plugged to [events](/core/1/plugins/guides/events), and receiving information regarding that event. Hooks can only listen: the received information cannot be changed. And Kuzzle doesn't wait for their execution either, so hooks cannot change the outcome of whatever triggered the listened event. @@ -15,7 +15,7 @@ Hooks can only listen: the received information cannot be changed. And Kuzzle do ## Usage -Plugins can register hooks by exposing a `hooks` object: keys are listened [events](/core/1/plugins/events), and values are either a function to execute whenever that event is triggered, or an array of functions. +Plugins can register hooks by exposing a `hooks` object: keys are listened [events](/core/1/plugins/guides/events), and values are either a function to execute whenever that event is triggered, or an array of functions. ```javascript this.hooks = { @@ -48,7 +48,7 @@ module.exports = class HookPlugin { } /* - Called whenever the "document:afterCreate" event + Called whenever the "document:afterCreate" event is triggered */ myFunctionOnCreate(request, event) { diff --git a/src/core/1/plugins/plugins/index.md b/src/core/1/plugins/guides/index.md similarity index 54% rename from src/core/1/plugins/plugins/index.md rename to src/core/1/plugins/guides/index.md index 2c58c1682..79f939dcf 100644 --- a/src/core/1/plugins/plugins/index.md +++ b/src/core/1/plugins/guides/index.md @@ -3,5 +3,5 @@ code: false type: branch order: 0 title: Plugins -description: General notions on Kuzzle Plugins +description: Kuzzle Plugins guides --- diff --git a/src/core/1/plugins/plugins/manual-setup/config/index.md b/src/core/1/plugins/guides/manual-setup/config/index.md similarity index 100% rename from src/core/1/plugins/plugins/manual-setup/config/index.md rename to src/core/1/plugins/guides/manual-setup/config/index.md diff --git a/src/core/1/plugins/plugins/manual-setup/index.md b/src/core/1/plugins/guides/manual-setup/index.md similarity index 100% rename from src/core/1/plugins/plugins/manual-setup/index.md rename to src/core/1/plugins/guides/manual-setup/index.md diff --git a/src/core/1/plugins/plugins/manual-setup/init-function/index.md b/src/core/1/plugins/guides/manual-setup/init-function/index.md similarity index 100% rename from src/core/1/plugins/plugins/manual-setup/init-function/index.md rename to src/core/1/plugins/guides/manual-setup/init-function/index.md diff --git a/src/core/1/plugins/plugins/manual-setup/prerequisites/index.md b/src/core/1/plugins/guides/manual-setup/prerequisites/index.md similarity index 100% rename from src/core/1/plugins/plugins/manual-setup/prerequisites/index.md rename to src/core/1/plugins/guides/manual-setup/prerequisites/index.md diff --git a/src/core/1/plugins/plugins/pipes/index.md b/src/core/1/plugins/guides/pipes/index.md similarity index 87% rename from src/core/1/plugins/plugins/pipes/index.md rename to src/core/1/plugins/guides/pipes/index.md index ea330cd52..247b95670 100644 --- a/src/core/1/plugins/plugins/pipes/index.md +++ b/src/core/1/plugins/guides/pipes/index.md @@ -7,7 +7,7 @@ order: 300 # Pipes -Pipes are functions plugged to [events](/core/1/plugins/events/), called synchronously by Kuzzle, and receiving information regarding that event. +Pipes are functions plugged to [events](/core/1/plugins/guides/events/), called synchronously by Kuzzle, and receiving information regarding that event. Pipes can: @@ -20,7 +20,7 @@ Pipes can: ## Usage -Plugins can register pipes by exposing a `pipes` object: keys are listened [events](/core/1/plugins/events/), and values are either a function to execute whenever that event is triggered, or an array of functions. +Plugins can register pipes by exposing a `pipes` object: keys are listened [events](/core/1/plugins/guides/events/), and values are either a function to execute whenever that event is triggered, or an array of functions. ```javascript this.pipes = { @@ -38,7 +38,7 @@ Pipes must notify Kuzzle about their completion by one of these two means:
You must either call the callback with a valid Request or return a promise resolving to one.
-If a pipe throws an error, it is advised to throw one of the available [KuzzleError](/core/1/plugins/errors/kuzzleerror) object. Otherwise, Kuzzle will reject the task with a `PluginImplementationError` error. +If a pipe throws an error, it is advised to throw one of the available [KuzzleError](/core/1/plugins/plugin-context/errors/kuzzleerror) object. Otherwise, Kuzzle will reject the task with a `PluginImplementationError` error. --- diff --git a/src/core/1/plugins/plugins/strategies/auth-functions/index.md b/src/core/1/plugins/guides/strategies/auth-functions/index.md similarity index 99% rename from src/core/1/plugins/plugins/strategies/auth-functions/index.md rename to src/core/1/plugins/guides/strategies/auth-functions/index.md index 5e6be2570..c5253c308 100644 --- a/src/core/1/plugins/plugins/strategies/auth-functions/index.md +++ b/src/core/1/plugins/guides/strategies/auth-functions/index.md @@ -31,7 +31,7 @@ The `create` function adds credentials to a user. For security reasons, plugins are entirely responsible of how credentials are managed, storage included: Kuzzle does not read, modify, or store credentials. -If needed, Kuzzle exposes a secure and isolated storage space for each plugin. It can be accessed using the [Repository](/core/1/plugins/constructors/repository) constructor. +If needed, Kuzzle exposes a secure and isolated storage space for each plugin. It can be accessed using the [Repository](/core/1/plugins/plugin-context/constructors/repository) constructor. ### Arguments @@ -161,7 +161,7 @@ The function `validate` must return a promise. The resolved value, if there is o The [verify](http://passportjs.org/docs/configure) function authenticates a user. -The number of arguments taken by the `verify` function depends on the authentication strategy. +The number of arguments taken by the `verify` function depends on the authentication strategy. For instance, a `local` authentication strategy requires that the `verify` function validates both a user name and a password, so these two arguments will have to be provided to the `verify` function. ### Arguments diff --git a/src/core/1/plugins/plugins/strategies/index.md b/src/core/1/plugins/guides/strategies/index.md similarity index 100% rename from src/core/1/plugins/plugins/strategies/index.md rename to src/core/1/plugins/guides/strategies/index.md diff --git a/src/core/1/plugins/plugins/strategies/overview/index.md b/src/core/1/plugins/guides/strategies/overview/index.md similarity index 93% rename from src/core/1/plugins/plugins/strategies/overview/index.md rename to src/core/1/plugins/guides/strategies/overview/index.md index e9697c860..681209af1 100644 --- a/src/core/1/plugins/plugins/strategies/overview/index.md +++ b/src/core/1/plugins/guides/strategies/overview/index.md @@ -7,7 +7,7 @@ order: 0 # Strategies -Plugins can add new authentication strategies to Kuzzle. +Plugins can add new authentication strategies to Kuzzle. For example, our official [OAUTH2 Authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth) adds OAUTH2 support to Kuzzle. All authentication strategies supported by [Passport.js](http://passportjs.org/) can be integrated to Kuzzle. @@ -16,7 +16,7 @@ All authentication strategies supported by [Passport.js](http://passportjs.org/) ## Registering authentication strategies -[Passport.js](http://passportjs.org) provides a wide range of authentication strategies. +[Passport.js](http://passportjs.org) provides a wide range of authentication strategies. Custom authentication strategies can also be implemented by subclassing the abstract [Passport Strategy](https://github.com/jaredhanson/passport-strategy) class. To register strategies to Kuzzle, a `authenticators` object property must be exposed by the plugin, for instance: @@ -32,7 +32,7 @@ this.authenticators = { ## Credentials security -User credentials are very sensitive data, and these must be properly isolated to prevent security vulnerabilities. +User credentials are very sensitive data, and these must be properly isolated to prevent security vulnerabilities. To do so, Kuzzle guarantees that it never interprets, modifies, or stores credentials information. Instead, Kuzzle: @@ -47,7 +47,7 @@ Instead, Kuzzle: There are two ways of interfacing credentials management: - statically, by exposing a `strategies` object -- dynamically, by using the dedicated [strategy accessors](/core/1/plugins/accessors/strategies) +- dynamically, by using the dedicated [strategy accessors](/core/1/plugins/plugin-context/accessors/strategies) Whether strategies are added statically or dynamically, the `strategies` object must expose the following properties: @@ -63,7 +63,7 @@ The `config` part of the `strategies` object can contain the following propertie | Arguments | Type | Description | | --------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `authenticator` | 
string
| One of the exposed [authenticators](/core/1/plugins/essentials/strategies/#registering-authentication-strategies-default) name | -| `constructor` | 
object
| (use the `authenticator` property instead)
The constructor of the Passport.js strategy. Does not support [dynamic strategy registration](/core/1/plugins/accessors/strategies) | +| `constructor` | 
object
| (use the `authenticator` property instead)
The constructor of the Passport.js strategy. Does not support [dynamic strategy registration](/core/1/plugins/plugin-context/accessors/strategies) | | `authenticateOptions` | 
object
| (optional) Additional options to be provided to the Passport's [authenticate method](http://passportjs.org/docs/authenticate) | | `fields` | 
string[]
| (optional) The list of accepted field names by the strategy credentials.
The list is informative only, meant to be used by the [getAllCredentialFields](/core/1/api/api-reference/controller-security/get-all-credential-fields/) and the [getCredentialFields](/core/1/api/api-reference/controller-security/get-credential-fields/) API methods | | `strategyOptions` | 
object
| (optional) Options provided to the Passport.js strategy constructor | diff --git a/src/core/1/plugins/plugin-context/accessors/execute/index.md b/src/core/1/plugins/plugin-context/accessors/execute/index.md index 2b1b2a157..22f337b3e 100644 --- a/src/core/1/plugins/plugin-context/accessors/execute/index.md +++ b/src/core/1/plugins/plugin-context/accessors/execute/index.md @@ -29,7 +29,7 @@ execute(request, [callback]); ## Return -The `execute` function resolves to an updated Request object, with its [response part](/core/1/plugins/constructors/request) set. +The `execute` function resolves to an updated Request object, with its [response part](/core/1/plugins/plugin-context/constructors/request) set. How the response is returned depends whether a callback argument is provided: diff --git a/src/core/1/plugins/plugin-context/accessors/sdk/index.md b/src/core/1/plugins/plugin-context/accessors/sdk/index.md index 7891f2231..4dea0e7ed 100644 --- a/src/core/1/plugins/plugin-context/accessors/sdk/index.md +++ b/src/core/1/plugins/plugin-context/accessors/sdk/index.md @@ -12,7 +12,7 @@ Accessor to the embedded SDK. The embedded SDK is a custom version of our [Javascript SDK](/sdk/js/6) that uses a custom protocol plugged directly into Kuzzle core. -All the documented controllers can be used, except the `realtime` one. +All the documented controllers can be used, except the `realtime` one. Also, the low-level [query](/sdk/js/6/core-classes/kuzzle/query/) method is available for use. ### Request context @@ -21,9 +21,9 @@ By default, when using the embedded SDK, requests made to Kuzzle API don't have Typically, the `request.context.user` property is not set and thus [Kuzzle metadata](/core/1/guide/guides/essentials/document-metadata/) will not be set when creating or updating documents. -It is possible to use the same user context as the original request with the embedded SDK, for this purpose it is necessary to use the [as()](/core/1/plugins/accessors/sdk/#as) impersonation method. +It is possible to use the same user context as the original request with the embedded SDK, for this purpose it is necessary to use the [as()](/core/1/plugins/plugin-context/accessors/sdk/#as) impersonation method. -When the complete original context is needed to execute your request, plugin developers can use the [accessors.execute](/core/1/plugins/accessors/execute) method. +When the complete original context is needed to execute your request, plugin developers can use the [accessors.execute](/core/1/plugins/plugin-context/accessors/execute) method. --- @@ -64,7 +64,7 @@ async myAwesomePipe (request) { -Accessor to the [query method](/sdk/js/6/core-classes/kuzzle/query/). +Accessor to the [query method](/sdk/js/6/core-classes/kuzzle/query/). This can be useful to call plugins custom controller action. ### Example diff --git a/src/core/1/plugins/plugin-context/accessors/storage/index.md b/src/core/1/plugins/plugin-context/accessors/storage/index.md index 2667d1686..755a74926 100644 --- a/src/core/1/plugins/plugin-context/accessors/storage/index.md +++ b/src/core/1/plugins/plugin-context/accessors/storage/index.md @@ -8,7 +8,7 @@ title: storage Initializes the plugin's private data storage. -Data stored in this space can only be accessed by their proprietary plugin, using the [Repository](/core/1/plugins/constructors/repository) constructor. +Data stored in this space can only be accessed by their proprietary plugin, using the [Repository](/core/1/plugins/plugin-context/constructors/repository) constructor. The only way documents stored in this space can be accessed using Kuzzle is if the plugin voluntarily exposes that data by [adding new API routes](/core/1/plugins/essentials/controllers/). diff --git a/src/core/1/plugins/plugin-context/accessors/trigger/index.md b/src/core/1/plugins/plugin-context/accessors/trigger/index.md index 1b5726867..f03da1093 100644 --- a/src/core/1/plugins/plugin-context/accessors/trigger/index.md +++ b/src/core/1/plugins/plugin-context/accessors/trigger/index.md @@ -10,7 +10,7 @@ title: trigger Triggers a custom event. -This allows interactions with other plugins using [hooks](/core/1/plugins/hooks/) or [pipes](/core/1/plugins/pipes/). +This allows interactions with other plugins using [hooks](/core/1/plugins/guides/hooks/) or [pipes](/core/1/plugins/guides/pipes/). ## Arguments diff --git a/src/core/1/plugins/plugin-context/accessors/validation/index.md b/src/core/1/plugins/plugin-context/accessors/validation/index.md index b3de6c4ff..fa5e91edf 100644 --- a/src/core/1/plugins/plugin-context/accessors/validation/index.md +++ b/src/core/1/plugins/plugin-context/accessors/validation/index.md @@ -26,7 +26,7 @@ addType(Type); | Arguments | Type | Description | | --------- | ----------------- | ------------------------------------------------------------------------------------------------------------- | -| `Type` | 
object
| A class implementing the abstract [BaseValidationType](/core/1/plugins/constructors/basevalidationtype) class | +| `Type` | 
object
| A class implementing the abstract [BaseValidationType](/core/1/plugins/plugin-context/constructors/basevalidationtype) class | --- diff --git a/src/core/1/plugins/plugin-context/constructors/basevalidationtype/index.md b/src/core/1/plugins/plugin-context/constructors/basevalidationtype/index.md index ffc74c7f9..7d6fbb881 100644 --- a/src/core/1/plugins/plugin-context/constructors/basevalidationtype/index.md +++ b/src/core/1/plugins/plugin-context/constructors/basevalidationtype/index.md @@ -8,7 +8,7 @@ title: BaseValidationType -Abstract class, used to create custom validation types (see the [validation](/core/1/plugins/accessors/validation) accessor). +Abstract class, used to create custom validation types (see the [validation](/core/1/plugins/plugin-context/accessors/validation) accessor). --- @@ -76,4 +76,4 @@ validateFieldSpecification(opts); The `validateFieldSpecification` returns a copy of the `opts` object, updated with interpreted values. -If the provided options are not valid, this function is expected to throw a [KuzzleError](/core/1/plugins/errors) error. +If the provided options are not valid, this function is expected to throw a [KuzzleError](/core/1/plugins/plugin-context/errors) error. diff --git a/src/core/1/plugins/plugin-context/constructors/dsl/index.md b/src/core/1/plugins/plugin-context/constructors/dsl/index.md index a5bf346c7..981b2022d 100644 --- a/src/core/1/plugins/plugin-context/constructors/dsl/index.md +++ b/src/core/1/plugins/plugin-context/constructors/dsl/index.md @@ -10,6 +10,6 @@ title: Dsl Instantiates a new [Koncorde](/core/1/koncorde) engine. -This constructor is still present for backward compatibility only: it is now named [Koncorde](/core/1/plugins/constructors/koncorde). +This constructor is still present for backward compatibility only: it is now named [Koncorde](/core/1/plugins/plugin-context/constructors/koncorde). --- diff --git a/src/core/1/plugins/plugin-context/constructors/repository/index.md b/src/core/1/plugins/plugin-context/constructors/repository/index.md index 6afca25d5..de7c5eeea 100644 --- a/src/core/1/plugins/plugin-context/constructors/repository/index.md +++ b/src/core/1/plugins/plugin-context/constructors/repository/index.md @@ -10,7 +10,7 @@ title: Repository Provides access to a collection inside the plugin's dedicated and secure storage. -If this is not already the case, the collection must first be created, using the [storage](/core/1/plugins/accessors/storage) accessor. +If this is not already the case, the collection must first be created, using the [storage](/core/1/plugins/plugin-context/accessors/storage) accessor. --- diff --git a/src/core/1/plugins/plugin-context/constructors/request/index.md b/src/core/1/plugins/plugin-context/constructors/request/index.md index 08b2ddf34..305c77964 100644 --- a/src/core/1/plugins/plugin-context/constructors/request/index.md +++ b/src/core/1/plugins/plugin-context/constructors/request/index.md @@ -20,7 +20,7 @@ For more information about this object, refer to its [technical documentation](h Network protocol specific headers can be added to the response. If the protocol supports it, these headers are forwarded in the response sent to the client. -As Kuzzle supports the HTTP protocol natively, the Request object handles HTTP headers special cases. +As Kuzzle supports the HTTP protocol natively, the Request object handles HTTP headers special cases. Other network protocols headers are stored in raw format, and protocols have to handle their own specific headers manually. @@ -132,7 +132,7 @@ setError(error); If a `KuzzleError` object is provided, the request's status attribute is set to the error one. -Otherwise, the provided error is embedded into a [InternalError](/core/1/plugins/errors/internalerror) object, and the request status is set to 500. +Otherwise, the provided error is embedded into a [InternalError](/core/1/plugins/plugin-context/errors/internalerror) object, and the request status is set to 500. --- diff --git a/src/core/1/plugins/plugin-context/errors/intro/index.md b/src/core/1/plugins/plugin-context/errors/intro/index.md index 2f3b41f8e..19b2fc9b8 100644 --- a/src/core/1/plugins/plugin-context/errors/intro/index.md +++ b/src/core/1/plugins/plugin-context/errors/intro/index.md @@ -7,9 +7,9 @@ order: 0 # Introduction -Whenever a plugin returns, rejects or throws an error, Kuzzle intercepts it and, by default, rethrows it as a [PluginImplementationError](/core/1/plugins/errors/pluginimplementationerror) error. +Whenever a plugin returns, rejects or throws an error, Kuzzle intercepts it and, by default, rethrows it as a [PluginImplementationError](/core/1/plugins/plugin-context/errors/pluginimplementationerror) error. -To prevent this, plugins have error constructors at their disposal. Plugins can also create their own errors by inheriting from the abstract [KuzzleError](/core/1/plugins/errors/kuzzleerror) object. +To prevent this, plugins have error constructors at their disposal. Plugins can also create their own errors by inheriting from the abstract [KuzzleError](/core/1/plugins/plugin-context/errors/kuzzleerror) object. This section details the error constructors made available in the plugin context, an object containing a set of constructors, accessors and various other helpers, allowing plugins to interact with Kuzzle. diff --git a/src/core/1/plugins/plugin-context/errors/parseerror/index.md b/src/core/1/plugins/plugin-context/errors/parseerror/index.md index dabf0d47f..3b996ba8b 100644 --- a/src/core/1/plugins/plugin-context/errors/parseerror/index.md +++ b/src/core/1/plugins/plugin-context/errors/parseerror/index.md @@ -8,7 +8,7 @@ title: ParseError / -Parse error. Use [BadRequestError](/core/1/plugins/errors/badrequesterror) instead. +Parse error. Use [BadRequestError](/core/1/plugins/plugin-context/errors/badrequesterror) instead. ## Status Code diff --git a/src/core/1/protocols/protocols/context/clientconnection/index.md b/src/core/1/protocols/api/context/clientconnection/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/clientconnection/index.md rename to src/core/1/protocols/api/context/clientconnection/index.md diff --git a/src/core/1/protocols/protocols/context/debug/index.md b/src/core/1/protocols/api/context/debug/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/debug/index.md rename to src/core/1/protocols/api/context/debug/index.md diff --git a/src/core/1/protocols/protocols/context/errors/index.md b/src/core/1/protocols/api/context/errors/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/errors/index.md rename to src/core/1/protocols/api/context/errors/index.md diff --git a/src/core/1/protocols/protocols/context/index.md b/src/core/1/protocols/api/context/index.md similarity index 86% rename from src/core/1/protocols/protocols/context/index.md rename to src/core/1/protocols/api/context/index.md index 4d5c1141d..d30cae232 100644 --- a/src/core/1/protocols/protocols/context/index.md +++ b/src/core/1/protocols/api/context/index.md @@ -1,5 +1,5 @@ --- -code: true +code: false type: branch title: Context description: Protocol context diff --git a/src/core/1/protocols/protocols/context/intro/index.md b/src/core/1/protocols/api/context/intro/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/intro/index.md rename to src/core/1/protocols/api/context/intro/index.md diff --git a/src/core/1/protocols/protocols/context/log/index.md b/src/core/1/protocols/api/context/log/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/log/index.md rename to src/core/1/protocols/api/context/log/index.md diff --git a/src/core/1/protocols/protocols/context/request/index.md b/src/core/1/protocols/api/context/request/index.md similarity index 91% rename from src/core/1/protocols/protocols/context/request/index.md rename to src/core/1/protocols/api/context/request/index.md index ca4279e3b..84090270b 100644 --- a/src/core/1/protocols/protocols/context/request/index.md +++ b/src/core/1/protocols/api/context/request/index.md @@ -45,9 +45,9 @@ The `options` object can contain the following properties: | -------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `connection` | `object` | Connection information (see the connection object documentation) | | `connectionId` | `string` | Connection unique identifier | -| `error` | `KuzzleError,
Error` | Sets the request response with the provided error | +| `error` | KuzzleError,
Error | Sets the request response with the provided error | | `requestId` | `string` | User-defined request identifier | -| `result` | `\*` | Sets the request response with the provided result, and the request status is set to `200` | +| `result` | `*` | Sets the request response with the provided result, and the request status is set to `200` | | `status` | `integer` | Request status, following the [HTTP error code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) standard | --- @@ -62,7 +62,7 @@ Read-only: | `error` | `KuzzleError | Request error | | `input` | `RequestInput` | Input request representation | | `response` | `RequestResponse` | Serialized [request response](/core/1/api/essentials/kuzzle-response) | -| `result` | `\*` | Request result | +| `result` | `*` | Request result | | `timestamp` | `integer` | Request creation timestamp, in Epoch-millis format | Writable: @@ -139,7 +139,7 @@ setResult(result, [options]); | Arguments | Type | Description | | --------- | ------------------ | ----------------------------- | -| `result` | `\*` | Request result | +| `result` | `*` | Request result | | `options` | `optional, object` | Optional result configuration | #### options diff --git a/src/core/1/protocols/protocols/context/requestcontext/index.md b/src/core/1/protocols/api/context/requestcontext/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/requestcontext/index.md rename to src/core/1/protocols/api/context/requestcontext/index.md diff --git a/src/core/1/protocols/protocols/context/requestinput/index.md b/src/core/1/protocols/api/context/requestinput/index.md similarity index 100% rename from src/core/1/protocols/protocols/context/requestinput/index.md rename to src/core/1/protocols/api/context/requestinput/index.md diff --git a/src/core/1/protocols/protocols/entrypoint/execute/index.md b/src/core/1/protocols/api/entrypoint/execute/index.md similarity index 100% rename from src/core/1/protocols/protocols/entrypoint/execute/index.md rename to src/core/1/protocols/api/entrypoint/execute/index.md diff --git a/src/core/1/protocols/protocols/entrypoint/index.md b/src/core/1/protocols/api/entrypoint/index.md similarity index 87% rename from src/core/1/protocols/protocols/entrypoint/index.md rename to src/core/1/protocols/api/entrypoint/index.md index 32bbdf376..33187e65e 100644 --- a/src/core/1/protocols/protocols/entrypoint/index.md +++ b/src/core/1/protocols/api/entrypoint/index.md @@ -1,5 +1,5 @@ --- -code: true +code: false type: branch title: EntryPoint description: Protocol Entry Point diff --git a/src/core/1/protocols/protocols/entrypoint/intro/index.md b/src/core/1/protocols/api/entrypoint/intro/index.md similarity index 100% rename from src/core/1/protocols/protocols/entrypoint/intro/index.md rename to src/core/1/protocols/api/entrypoint/intro/index.md diff --git a/src/core/1/protocols/protocols/entrypoint/newconnection/index.md b/src/core/1/protocols/api/entrypoint/newconnection/index.md similarity index 100% rename from src/core/1/protocols/protocols/entrypoint/newconnection/index.md rename to src/core/1/protocols/api/entrypoint/newconnection/index.md diff --git a/src/core/1/protocols/protocols/entrypoint/removeconnection/index.md b/src/core/1/protocols/api/entrypoint/removeconnection/index.md similarity index 100% rename from src/core/1/protocols/protocols/entrypoint/removeconnection/index.md rename to src/core/1/protocols/api/entrypoint/removeconnection/index.md diff --git a/src/core/1/protocols/protocols/index.md b/src/core/1/protocols/api/index.md similarity index 75% rename from src/core/1/protocols/protocols/index.md rename to src/core/1/protocols/api/index.md index e9e9be571..8f3461b29 100644 --- a/src/core/1/protocols/protocols/index.md +++ b/src/core/1/protocols/api/index.md @@ -1,7 +1,7 @@ --- code: false type: branch -order: 0 -title: Protocols +order: 10 +title: API description: Kuzzle v1.x Protocols documentation --- diff --git a/src/core/1/protocols/protocols/methods/broadcast/index.md b/src/core/1/protocols/api/methods/broadcast/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/broadcast/index.md rename to src/core/1/protocols/api/methods/broadcast/index.md diff --git a/src/core/1/protocols/protocols/methods/disconnect/index.md b/src/core/1/protocols/api/methods/disconnect/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/disconnect/index.md rename to src/core/1/protocols/api/methods/disconnect/index.md diff --git a/src/core/1/protocols/protocols/methods/index.md b/src/core/1/protocols/api/methods/index.md similarity index 90% rename from src/core/1/protocols/protocols/methods/index.md rename to src/core/1/protocols/api/methods/index.md index 6742845b5..07764539d 100644 --- a/src/core/1/protocols/protocols/methods/index.md +++ b/src/core/1/protocols/api/methods/index.md @@ -1,6 +1,6 @@ --- type: branch -code: true +code: false title: Protocol Methods description: Extend Kuzzle communication capabilities order: 0 diff --git a/src/core/1/protocols/protocols/methods/init/index.md b/src/core/1/protocols/api/methods/init/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/init/index.md rename to src/core/1/protocols/api/methods/init/index.md diff --git a/src/core/1/protocols/protocols/methods/joinchannel/index.md b/src/core/1/protocols/api/methods/joinchannel/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/joinchannel/index.md rename to src/core/1/protocols/api/methods/joinchannel/index.md diff --git a/src/core/1/protocols/protocols/methods/leavechannel/index.md b/src/core/1/protocols/api/methods/leavechannel/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/leavechannel/index.md rename to src/core/1/protocols/api/methods/leavechannel/index.md diff --git a/src/core/1/protocols/protocols/methods/notify/index.md b/src/core/1/protocols/api/methods/notify/index.md similarity index 100% rename from src/core/1/protocols/protocols/methods/notify/index.md rename to src/core/1/protocols/api/methods/notify/index.md diff --git a/src/core/1/protocols/protocols/essentials/getting-started/index.md b/src/core/1/protocols/essentials/getting-started/index.md similarity index 100% rename from src/core/1/protocols/protocols/essentials/getting-started/index.md rename to src/core/1/protocols/essentials/getting-started/index.md diff --git a/src/core/1/protocols/protocols/essentials/index.md b/src/core/1/protocols/essentials/index.md similarity index 100% rename from src/core/1/protocols/protocols/essentials/index.md rename to src/core/1/protocols/essentials/index.md diff --git a/src/core/1/protocols/protocols/native-protocols/http/index.md b/src/core/1/protocols/native-protocols/http/index.md similarity index 100% rename from src/core/1/protocols/protocols/native-protocols/http/index.md rename to src/core/1/protocols/native-protocols/http/index.md diff --git a/src/core/1/protocols/protocols/native-protocols/index.md b/src/core/1/protocols/native-protocols/index.md similarity index 91% rename from src/core/1/protocols/protocols/native-protocols/index.md rename to src/core/1/protocols/native-protocols/index.md index 87e2a67e9..293555fd1 100644 --- a/src/core/1/protocols/protocols/native-protocols/index.md +++ b/src/core/1/protocols/native-protocols/index.md @@ -3,5 +3,5 @@ code: false type: branch title: Native Protocols description: Extend Kuzzle communication capabilities -order: 0 +order: 30 --- diff --git a/src/core/1/protocols/protocols/native-protocols/mqtt/index.md b/src/core/1/protocols/native-protocols/mqtt/index.md similarity index 100% rename from src/core/1/protocols/protocols/native-protocols/mqtt/index.md rename to src/core/1/protocols/native-protocols/mqtt/index.md diff --git a/src/core/1/protocols/protocols/native-protocols/socketio/index.md b/src/core/1/protocols/native-protocols/socketio/index.md similarity index 100% rename from src/core/1/protocols/protocols/native-protocols/socketio/index.md rename to src/core/1/protocols/native-protocols/socketio/index.md diff --git a/src/core/1/protocols/protocols/native-protocols/websocket/index.md b/src/core/1/protocols/native-protocols/websocket/index.md similarity index 100% rename from src/core/1/protocols/protocols/native-protocols/websocket/index.md rename to src/core/1/protocols/native-protocols/websocket/index.md diff --git a/src/sdk/android/3/controllers/index.md b/src/sdk/android/3/controllers/index.md deleted file mode 100644 index aa1249518..000000000 --- a/src/sdk/android/3/controllers/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -code: true -type: branch -order: 20 -title: Controllers -description: Controllers ---- diff --git a/src/sdk/android/3/controllers/collection-mapping/apply/index.md b/src/sdk/android/3/core-classes/collection-mapping/apply/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/apply/index.md rename to src/sdk/android/3/core-classes/collection-mapping/apply/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/apply/snippets/apply-1.java b/src/sdk/android/3/core-classes/collection-mapping/apply/snippets/apply-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/apply/snippets/apply-1.java rename to src/sdk/android/3/core-classes/collection-mapping/apply/snippets/apply-1.java diff --git a/src/sdk/android/3/controllers/collection-mapping/constructor/index.md b/src/sdk/android/3/core-classes/collection-mapping/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/constructor/index.md rename to src/sdk/android/3/core-classes/collection-mapping/constructor/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/collection-mapping/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/collection-mapping/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/collection-mapping/index.md b/src/sdk/android/3/core-classes/collection-mapping/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/index.md rename to src/sdk/android/3/core-classes/collection-mapping/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/refresh/index.md b/src/sdk/android/3/core-classes/collection-mapping/refresh/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/refresh/index.md rename to src/sdk/android/3/core-classes/collection-mapping/refresh/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/refresh/snippets/refresh-1.java b/src/sdk/android/3/core-classes/collection-mapping/refresh/snippets/refresh-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/refresh/snippets/refresh-1.java rename to src/sdk/android/3/core-classes/collection-mapping/refresh/snippets/refresh-1.java diff --git a/src/sdk/android/3/controllers/collection-mapping/set-headers/index.md b/src/sdk/android/3/core-classes/collection-mapping/set-headers/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/set-headers/index.md rename to src/sdk/android/3/core-classes/collection-mapping/set-headers/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/set-headers/snippets/set-headers-1.java b/src/sdk/android/3/core-classes/collection-mapping/set-headers/snippets/set-headers-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/set-headers/snippets/set-headers-1.java rename to src/sdk/android/3/core-classes/collection-mapping/set-headers/snippets/set-headers-1.java diff --git a/src/sdk/android/3/controllers/collection-mapping/set/index.md b/src/sdk/android/3/core-classes/collection-mapping/set/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/set/index.md rename to src/sdk/android/3/core-classes/collection-mapping/set/index.md diff --git a/src/sdk/android/3/controllers/collection-mapping/set/snippets/set-1.java b/src/sdk/android/3/core-classes/collection-mapping/set/snippets/set-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection-mapping/set/snippets/set-1.java rename to src/sdk/android/3/core-classes/collection-mapping/set/snippets/set-1.java diff --git a/src/sdk/android/3/controllers/collection/collection-mapping/index.md b/src/sdk/android/3/core-classes/collection/collection-mapping/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/collection-mapping/index.md rename to src/sdk/android/3/core-classes/collection/collection-mapping/index.md diff --git a/src/sdk/android/3/controllers/collection/collection-mapping/snippets/collection-mapping-1.java b/src/sdk/android/3/core-classes/collection/collection-mapping/snippets/collection-mapping-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/collection-mapping/snippets/collection-mapping-1.java rename to src/sdk/android/3/core-classes/collection/collection-mapping/snippets/collection-mapping-1.java diff --git a/src/sdk/android/3/controllers/collection/constructor/index.md b/src/sdk/android/3/core-classes/collection/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/constructor/index.md rename to src/sdk/android/3/core-classes/collection/constructor/index.md diff --git a/src/sdk/android/3/controllers/collection/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/collection/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/collection/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/collection/count/index.md b/src/sdk/android/3/core-classes/collection/count/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/count/index.md rename to src/sdk/android/3/core-classes/collection/count/index.md diff --git a/src/sdk/android/3/controllers/collection/count/snippets/count-1.java b/src/sdk/android/3/core-classes/collection/count/snippets/count-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/count/snippets/count-1.java rename to src/sdk/android/3/core-classes/collection/count/snippets/count-1.java diff --git a/src/sdk/android/3/controllers/collection/create-document/index.md b/src/sdk/android/3/core-classes/collection/create-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/create-document/index.md rename to src/sdk/android/3/core-classes/collection/create-document/index.md diff --git a/src/sdk/android/3/controllers/collection/create-document/snippets/create-document-1.java b/src/sdk/android/3/core-classes/collection/create-document/snippets/create-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/create-document/snippets/create-document-1.java rename to src/sdk/android/3/core-classes/collection/create-document/snippets/create-document-1.java diff --git a/src/sdk/android/3/controllers/collection/create/index.md b/src/sdk/android/3/core-classes/collection/create/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/create/index.md rename to src/sdk/android/3/core-classes/collection/create/index.md diff --git a/src/sdk/android/3/controllers/collection/create/snippets/create-1.java b/src/sdk/android/3/core-classes/collection/create/snippets/create-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/create/snippets/create-1.java rename to src/sdk/android/3/core-classes/collection/create/snippets/create-1.java diff --git a/src/sdk/android/3/controllers/collection/delete-document/index.md b/src/sdk/android/3/core-classes/collection/delete-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/delete-document/index.md rename to src/sdk/android/3/core-classes/collection/delete-document/index.md diff --git a/src/sdk/android/3/controllers/collection/delete-document/snippets/delete-document-1.java b/src/sdk/android/3/core-classes/collection/delete-document/snippets/delete-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/delete-document/snippets/delete-document-1.java rename to src/sdk/android/3/core-classes/collection/delete-document/snippets/delete-document-1.java diff --git a/src/sdk/android/3/controllers/collection/delete-specifications/index.md b/src/sdk/android/3/core-classes/collection/delete-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/delete-specifications/index.md rename to src/sdk/android/3/core-classes/collection/delete-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/delete-specifications/snippets/delete-specifications-1.java b/src/sdk/android/3/core-classes/collection/delete-specifications/snippets/delete-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/delete-specifications/snippets/delete-specifications-1.java rename to src/sdk/android/3/core-classes/collection/delete-specifications/snippets/delete-specifications-1.java diff --git a/src/sdk/android/3/controllers/collection/document/index.md b/src/sdk/android/3/core-classes/collection/document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/document/index.md rename to src/sdk/android/3/core-classes/collection/document/index.md diff --git a/src/sdk/android/3/controllers/collection/document/snippets/document-1.java b/src/sdk/android/3/core-classes/collection/document/snippets/document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/document/snippets/document-1.java rename to src/sdk/android/3/core-classes/collection/document/snippets/document-1.java diff --git a/src/sdk/android/3/controllers/collection/fetch-document/index.md b/src/sdk/android/3/core-classes/collection/fetch-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/fetch-document/index.md rename to src/sdk/android/3/core-classes/collection/fetch-document/index.md diff --git a/src/sdk/android/3/controllers/collection/fetch-document/snippets/fetch-document-1.java b/src/sdk/android/3/core-classes/collection/fetch-document/snippets/fetch-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/fetch-document/snippets/fetch-document-1.java rename to src/sdk/android/3/core-classes/collection/fetch-document/snippets/fetch-document-1.java diff --git a/src/sdk/android/3/controllers/collection/get-mapping/index.md b/src/sdk/android/3/core-classes/collection/get-mapping/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/get-mapping/index.md rename to src/sdk/android/3/core-classes/collection/get-mapping/index.md diff --git a/src/sdk/android/3/controllers/collection/get-mapping/snippets/get-mapping-1.java b/src/sdk/android/3/core-classes/collection/get-mapping/snippets/get-mapping-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/get-mapping/snippets/get-mapping-1.java rename to src/sdk/android/3/core-classes/collection/get-mapping/snippets/get-mapping-1.java diff --git a/src/sdk/android/3/controllers/collection/get-specifications/index.md b/src/sdk/android/3/core-classes/collection/get-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/get-specifications/index.md rename to src/sdk/android/3/core-classes/collection/get-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/get-specifications/snippets/get-specifications-1.java b/src/sdk/android/3/core-classes/collection/get-specifications/snippets/get-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/get-specifications/snippets/get-specifications-1.java rename to src/sdk/android/3/core-classes/collection/get-specifications/snippets/get-specifications-1.java diff --git a/src/sdk/android/3/controllers/collection/index.md b/src/sdk/android/3/core-classes/collection/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/index.md rename to src/sdk/android/3/core-classes/collection/index.md diff --git a/src/sdk/android/3/controllers/collection/mcreate-document/index.md b/src/sdk/android/3/core-classes/collection/mcreate-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mcreate-document/index.md rename to src/sdk/android/3/core-classes/collection/mcreate-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mcreate-document/snippets/mcreate-document-1.java b/src/sdk/android/3/core-classes/collection/mcreate-document/snippets/mcreate-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mcreate-document/snippets/mcreate-document-1.java rename to src/sdk/android/3/core-classes/collection/mcreate-document/snippets/mcreate-document-1.java diff --git a/src/sdk/android/3/controllers/collection/mcreate-or-replace-document/index.md b/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mcreate-or-replace-document/index.md rename to src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.java b/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.java rename to src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.java diff --git a/src/sdk/android/3/controllers/collection/mdelete-document/index.md b/src/sdk/android/3/core-classes/collection/mdelete-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mdelete-document/index.md rename to src/sdk/android/3/core-classes/collection/mdelete-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mdelete-document/snippets/mdelete-document-1.java b/src/sdk/android/3/core-classes/collection/mdelete-document/snippets/mdelete-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mdelete-document/snippets/mdelete-document-1.java rename to src/sdk/android/3/core-classes/collection/mdelete-document/snippets/mdelete-document-1.java diff --git a/src/sdk/android/3/controllers/collection/mget-document/index.md b/src/sdk/android/3/core-classes/collection/mget-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mget-document/index.md rename to src/sdk/android/3/core-classes/collection/mget-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mget-document/snippets/mget-document-1.java b/src/sdk/android/3/core-classes/collection/mget-document/snippets/mget-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mget-document/snippets/mget-document-1.java rename to src/sdk/android/3/core-classes/collection/mget-document/snippets/mget-document-1.java diff --git a/src/sdk/android/3/controllers/collection/mreplace-document/index.md b/src/sdk/android/3/core-classes/collection/mreplace-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mreplace-document/index.md rename to src/sdk/android/3/core-classes/collection/mreplace-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mreplace-document/snippets/mreplace-document-1.java b/src/sdk/android/3/core-classes/collection/mreplace-document/snippets/mreplace-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mreplace-document/snippets/mreplace-document-1.java rename to src/sdk/android/3/core-classes/collection/mreplace-document/snippets/mreplace-document-1.java diff --git a/src/sdk/android/3/controllers/collection/mupdate-document/index.md b/src/sdk/android/3/core-classes/collection/mupdate-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/mupdate-document/index.md rename to src/sdk/android/3/core-classes/collection/mupdate-document/index.md diff --git a/src/sdk/android/3/controllers/collection/mupdate-document/snippets/mupdate-document-1.java b/src/sdk/android/3/core-classes/collection/mupdate-document/snippets/mupdate-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/mupdate-document/snippets/mupdate-document-1.java rename to src/sdk/android/3/core-classes/collection/mupdate-document/snippets/mupdate-document-1.java diff --git a/src/sdk/android/3/controllers/collection/publish-message/index.md b/src/sdk/android/3/core-classes/collection/publish-message/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/publish-message/index.md rename to src/sdk/android/3/core-classes/collection/publish-message/index.md diff --git a/src/sdk/android/3/controllers/collection/publish-message/snippets/publish-message-1.java b/src/sdk/android/3/core-classes/collection/publish-message/snippets/publish-message-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/publish-message/snippets/publish-message-1.java rename to src/sdk/android/3/core-classes/collection/publish-message/snippets/publish-message-1.java diff --git a/src/sdk/android/3/controllers/collection/replace-document/index.md b/src/sdk/android/3/core-classes/collection/replace-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/replace-document/index.md rename to src/sdk/android/3/core-classes/collection/replace-document/index.md diff --git a/src/sdk/android/3/controllers/collection/replace-document/snippets/replace-document-1.java b/src/sdk/android/3/core-classes/collection/replace-document/snippets/replace-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/replace-document/snippets/replace-document-1.java rename to src/sdk/android/3/core-classes/collection/replace-document/snippets/replace-document-1.java diff --git a/src/sdk/android/3/controllers/collection/room/index.md b/src/sdk/android/3/core-classes/collection/room/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/room/index.md rename to src/sdk/android/3/core-classes/collection/room/index.md diff --git a/src/sdk/android/3/controllers/collection/room/snippets/room-1.java b/src/sdk/android/3/core-classes/collection/room/snippets/room-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/room/snippets/room-1.java rename to src/sdk/android/3/core-classes/collection/room/snippets/room-1.java diff --git a/src/sdk/android/3/controllers/collection/scroll-specifications/index.md b/src/sdk/android/3/core-classes/collection/scroll-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/scroll-specifications/index.md rename to src/sdk/android/3/core-classes/collection/scroll-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/scroll-specifications/snippets/scroll-specifications-1.java b/src/sdk/android/3/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/scroll-specifications/snippets/scroll-specifications-1.java rename to src/sdk/android/3/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.java diff --git a/src/sdk/android/3/controllers/collection/scroll/index.md b/src/sdk/android/3/core-classes/collection/scroll/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/scroll/index.md rename to src/sdk/android/3/core-classes/collection/scroll/index.md diff --git a/src/sdk/android/3/controllers/collection/scroll/snippets/scroll-1.java b/src/sdk/android/3/core-classes/collection/scroll/snippets/scroll-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/scroll/snippets/scroll-1.java rename to src/sdk/android/3/core-classes/collection/scroll/snippets/scroll-1.java diff --git a/src/sdk/android/3/controllers/collection/search-specifications/index.md b/src/sdk/android/3/core-classes/collection/search-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/search-specifications/index.md rename to src/sdk/android/3/core-classes/collection/search-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/search-specifications/snippets/search-specifications-1.java b/src/sdk/android/3/core-classes/collection/search-specifications/snippets/search-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/search-specifications/snippets/search-specifications-1.java rename to src/sdk/android/3/core-classes/collection/search-specifications/snippets/search-specifications-1.java diff --git a/src/sdk/android/3/controllers/collection/search/index.md b/src/sdk/android/3/core-classes/collection/search/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/search/index.md rename to src/sdk/android/3/core-classes/collection/search/index.md diff --git a/src/sdk/android/3/controllers/collection/search/snippets/search-1.java b/src/sdk/android/3/core-classes/collection/search/snippets/search-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/search/snippets/search-1.java rename to src/sdk/android/3/core-classes/collection/search/snippets/search-1.java diff --git a/src/sdk/android/3/controllers/collection/set-headers/index.md b/src/sdk/android/3/core-classes/collection/set-headers/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/set-headers/index.md rename to src/sdk/android/3/core-classes/collection/set-headers/index.md diff --git a/src/sdk/android/3/controllers/collection/set-headers/snippets/set-headers-1.java b/src/sdk/android/3/core-classes/collection/set-headers/snippets/set-headers-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/set-headers/snippets/set-headers-1.java rename to src/sdk/android/3/core-classes/collection/set-headers/snippets/set-headers-1.java diff --git a/src/sdk/android/3/controllers/collection/subscribe/index.md b/src/sdk/android/3/core-classes/collection/subscribe/index.md similarity index 98% rename from src/sdk/android/3/controllers/collection/subscribe/index.md rename to src/sdk/android/3/core-classes/collection/subscribe/index.md index a6b7367f7..7ec49d9e7 100644 --- a/src/sdk/android/3/controllers/collection/subscribe/index.md +++ b/src/sdk/android/3/core-classes/collection/subscribe/index.md @@ -9,7 +9,7 @@ description: Collection:subscribe Subscribes to this collection with a set of filters. -The provided callback will be called everytime a [notification](/sdk/android/3/essentials/notifications/) is received from Kuzzle. +The provided callback will be called everytime a [notification](/sdk/android/3/essentials/realtime-notifications/) is received from Kuzzle. --- diff --git a/src/sdk/android/3/controllers/collection/subscribe/snippets/subscribe-1.java b/src/sdk/android/3/core-classes/collection/subscribe/snippets/subscribe-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/subscribe/snippets/subscribe-1.java rename to src/sdk/android/3/core-classes/collection/subscribe/snippets/subscribe-1.java diff --git a/src/sdk/android/3/controllers/collection/truncate/index.md b/src/sdk/android/3/core-classes/collection/truncate/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/truncate/index.md rename to src/sdk/android/3/core-classes/collection/truncate/index.md diff --git a/src/sdk/android/3/controllers/collection/truncate/snippets/truncate-1.java b/src/sdk/android/3/core-classes/collection/truncate/snippets/truncate-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/truncate/snippets/truncate-1.java rename to src/sdk/android/3/core-classes/collection/truncate/snippets/truncate-1.java diff --git a/src/sdk/android/3/controllers/collection/update-document/index.md b/src/sdk/android/3/core-classes/collection/update-document/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/update-document/index.md rename to src/sdk/android/3/core-classes/collection/update-document/index.md diff --git a/src/sdk/android/3/controllers/collection/update-document/snippets/update-document-1.java b/src/sdk/android/3/core-classes/collection/update-document/snippets/update-document-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/update-document/snippets/update-document-1.java rename to src/sdk/android/3/core-classes/collection/update-document/snippets/update-document-1.java diff --git a/src/sdk/android/3/controllers/collection/update-specifications/index.md b/src/sdk/android/3/core-classes/collection/update-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/update-specifications/index.md rename to src/sdk/android/3/core-classes/collection/update-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/update-specifications/snippets/update-specifications-1.java b/src/sdk/android/3/core-classes/collection/update-specifications/snippets/update-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/update-specifications/snippets/update-specifications-1.java rename to src/sdk/android/3/core-classes/collection/update-specifications/snippets/update-specifications-1.java diff --git a/src/sdk/android/3/controllers/collection/validate-specifications/index.md b/src/sdk/android/3/core-classes/collection/validate-specifications/index.md similarity index 100% rename from src/sdk/android/3/controllers/collection/validate-specifications/index.md rename to src/sdk/android/3/core-classes/collection/validate-specifications/index.md diff --git a/src/sdk/android/3/controllers/collection/validate-specifications/snippets/validate-specifications-1.java b/src/sdk/android/3/core-classes/collection/validate-specifications/snippets/validate-specifications-1.java similarity index 100% rename from src/sdk/android/3/controllers/collection/validate-specifications/snippets/validate-specifications-1.java rename to src/sdk/android/3/core-classes/collection/validate-specifications/snippets/validate-specifications-1.java diff --git a/src/sdk/android/3/controllers/document/constructor/index.md b/src/sdk/android/3/core-classes/document/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/constructor/index.md rename to src/sdk/android/3/core-classes/document/constructor/index.md diff --git a/src/sdk/android/3/controllers/document/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/document/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/document/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/document/delete/index.md b/src/sdk/android/3/core-classes/document/delete/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/delete/index.md rename to src/sdk/android/3/core-classes/document/delete/index.md diff --git a/src/sdk/android/3/controllers/document/delete/snippets/delete-1.java b/src/sdk/android/3/core-classes/document/delete/snippets/delete-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/delete/snippets/delete-1.java rename to src/sdk/android/3/core-classes/document/delete/snippets/delete-1.java diff --git a/src/sdk/android/3/controllers/document/exists/index.md b/src/sdk/android/3/core-classes/document/exists/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/exists/index.md rename to src/sdk/android/3/core-classes/document/exists/index.md diff --git a/src/sdk/android/3/controllers/document/exists/snippets/exists-1.java b/src/sdk/android/3/core-classes/document/exists/snippets/exists-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/exists/snippets/exists-1.java rename to src/sdk/android/3/core-classes/document/exists/snippets/exists-1.java diff --git a/src/sdk/android/3/controllers/document/index.md b/src/sdk/android/3/core-classes/document/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/index.md rename to src/sdk/android/3/core-classes/document/index.md diff --git a/src/sdk/android/3/controllers/document/publish/index.md b/src/sdk/android/3/core-classes/document/publish/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/publish/index.md rename to src/sdk/android/3/core-classes/document/publish/index.md diff --git a/src/sdk/android/3/controllers/document/publish/snippets/publish-1.java b/src/sdk/android/3/core-classes/document/publish/snippets/publish-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/publish/snippets/publish-1.java rename to src/sdk/android/3/core-classes/document/publish/snippets/publish-1.java diff --git a/src/sdk/android/3/controllers/document/refresh/index.md b/src/sdk/android/3/core-classes/document/refresh/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/refresh/index.md rename to src/sdk/android/3/core-classes/document/refresh/index.md diff --git a/src/sdk/android/3/controllers/document/refresh/snippets/refresh-1.java b/src/sdk/android/3/core-classes/document/refresh/snippets/refresh-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/refresh/snippets/refresh-1.java rename to src/sdk/android/3/core-classes/document/refresh/snippets/refresh-1.java diff --git a/src/sdk/android/3/controllers/document/save/index.md b/src/sdk/android/3/core-classes/document/save/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/save/index.md rename to src/sdk/android/3/core-classes/document/save/index.md diff --git a/src/sdk/android/3/controllers/document/save/snippets/save-1.java b/src/sdk/android/3/core-classes/document/save/snippets/save-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/save/snippets/save-1.java rename to src/sdk/android/3/core-classes/document/save/snippets/save-1.java diff --git a/src/sdk/android/3/controllers/document/set-content/index.md b/src/sdk/android/3/core-classes/document/set-content/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/set-content/index.md rename to src/sdk/android/3/core-classes/document/set-content/index.md diff --git a/src/sdk/android/3/controllers/document/set-content/snippets/set-content-1.java b/src/sdk/android/3/core-classes/document/set-content/snippets/set-content-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/set-content/snippets/set-content-1.java rename to src/sdk/android/3/core-classes/document/set-content/snippets/set-content-1.java diff --git a/src/sdk/android/3/controllers/document/set-headers/index.md b/src/sdk/android/3/core-classes/document/set-headers/index.md similarity index 100% rename from src/sdk/android/3/controllers/document/set-headers/index.md rename to src/sdk/android/3/core-classes/document/set-headers/index.md diff --git a/src/sdk/android/3/controllers/document/set-headers/snippets/set-headers-1.java b/src/sdk/android/3/core-classes/document/set-headers/snippets/set-headers-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/set-headers/snippets/set-headers-1.java rename to src/sdk/android/3/core-classes/document/set-headers/snippets/set-headers-1.java diff --git a/src/sdk/android/3/controllers/document/subscribe/index.md b/src/sdk/android/3/core-classes/document/subscribe/index.md similarity index 89% rename from src/sdk/android/3/controllers/document/subscribe/index.md rename to src/sdk/android/3/core-classes/document/subscribe/index.md index e50788c30..9186d4ecf 100644 --- a/src/sdk/android/3/controllers/document/subscribe/index.md +++ b/src/sdk/android/3/core-classes/document/subscribe/index.md @@ -10,7 +10,7 @@ description: Document:subscribe Listens to changes occuring in this document. Throws an error if this document has not yet been created in Kuzzle. -The provided callback will be called everytime a [notification](/sdk/android/3/essentials/notifications/) is received from Kuzzle. +The provided callback will be called everytime a [notification](/sdk/android/3/essentials/realtime-notifications/) is received from Kuzzle. --- @@ -31,7 +31,7 @@ Options are directly passed to the [Room](/sdk/android/3/controllers/room/) obje ## Return Value -Returns an object exposing the following method: +Returns an object exposing the following method: `onDone(callback)` The `callback` argument is called when the subscription ends, either successfully or with an error. diff --git a/src/sdk/android/3/controllers/document/subscribe/snippets/subscribe-1.java b/src/sdk/android/3/core-classes/document/subscribe/snippets/subscribe-1.java similarity index 100% rename from src/sdk/android/3/controllers/document/subscribe/snippets/subscribe-1.java rename to src/sdk/android/3/core-classes/document/subscribe/snippets/subscribe-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/append/index.md b/src/sdk/android/3/core-classes/memory-storage/append/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/append/index.md rename to src/sdk/android/3/core-classes/memory-storage/append/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/append/snippets/append-1.java b/src/sdk/android/3/core-classes/memory-storage/append/snippets/append-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/append/snippets/append-1.java rename to src/sdk/android/3/core-classes/memory-storage/append/snippets/append-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/bitcount/index.md b/src/sdk/android/3/core-classes/memory-storage/bitcount/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitcount/index.md rename to src/sdk/android/3/core-classes/memory-storage/bitcount/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/bitcount/snippets/bitcount-1.java b/src/sdk/android/3/core-classes/memory-storage/bitcount/snippets/bitcount-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitcount/snippets/bitcount-1.java rename to src/sdk/android/3/core-classes/memory-storage/bitcount/snippets/bitcount-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/bitop/index.md b/src/sdk/android/3/core-classes/memory-storage/bitop/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitop/index.md rename to src/sdk/android/3/core-classes/memory-storage/bitop/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/bitop/snippets/bitop-1.java b/src/sdk/android/3/core-classes/memory-storage/bitop/snippets/bitop-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitop/snippets/bitop-1.java rename to src/sdk/android/3/core-classes/memory-storage/bitop/snippets/bitop-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/bitpos/index.md b/src/sdk/android/3/core-classes/memory-storage/bitpos/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitpos/index.md rename to src/sdk/android/3/core-classes/memory-storage/bitpos/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/bitpos/snippets/bitpos-1.java b/src/sdk/android/3/core-classes/memory-storage/bitpos/snippets/bitpos-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/bitpos/snippets/bitpos-1.java rename to src/sdk/android/3/core-classes/memory-storage/bitpos/snippets/bitpos-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/constructor/index.md b/src/sdk/android/3/core-classes/memory-storage/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/constructor/index.md rename to src/sdk/android/3/core-classes/memory-storage/constructor/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/memory-storage/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/memory-storage/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/dbsize/index.md b/src/sdk/android/3/core-classes/memory-storage/dbsize/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/dbsize/index.md rename to src/sdk/android/3/core-classes/memory-storage/dbsize/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/dbsize/snippets/dbsize-1.java b/src/sdk/android/3/core-classes/memory-storage/dbsize/snippets/dbsize-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/dbsize/snippets/dbsize-1.java rename to src/sdk/android/3/core-classes/memory-storage/dbsize/snippets/dbsize-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/decr/index.md b/src/sdk/android/3/core-classes/memory-storage/decr/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/decr/index.md rename to src/sdk/android/3/core-classes/memory-storage/decr/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/decr/snippets/decr-1.java b/src/sdk/android/3/core-classes/memory-storage/decr/snippets/decr-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/decr/snippets/decr-1.java rename to src/sdk/android/3/core-classes/memory-storage/decr/snippets/decr-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/decrby/index.md b/src/sdk/android/3/core-classes/memory-storage/decrby/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/decrby/index.md rename to src/sdk/android/3/core-classes/memory-storage/decrby/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/decrby/snippets/decrby-1.java b/src/sdk/android/3/core-classes/memory-storage/decrby/snippets/decrby-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/decrby/snippets/decrby-1.java rename to src/sdk/android/3/core-classes/memory-storage/decrby/snippets/decrby-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/del/index.md b/src/sdk/android/3/core-classes/memory-storage/del/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/del/index.md rename to src/sdk/android/3/core-classes/memory-storage/del/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/del/snippets/del-1.java b/src/sdk/android/3/core-classes/memory-storage/del/snippets/del-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/del/snippets/del-1.java rename to src/sdk/android/3/core-classes/memory-storage/del/snippets/del-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/exists/index.md b/src/sdk/android/3/core-classes/memory-storage/exists/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/exists/index.md rename to src/sdk/android/3/core-classes/memory-storage/exists/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/exists/snippets/exists-1.java b/src/sdk/android/3/core-classes/memory-storage/exists/snippets/exists-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/exists/snippets/exists-1.java rename to src/sdk/android/3/core-classes/memory-storage/exists/snippets/exists-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/expire/index.md b/src/sdk/android/3/core-classes/memory-storage/expire/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/expire/index.md rename to src/sdk/android/3/core-classes/memory-storage/expire/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/expire/snippets/expire-1.java b/src/sdk/android/3/core-classes/memory-storage/expire/snippets/expire-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/expire/snippets/expire-1.java rename to src/sdk/android/3/core-classes/memory-storage/expire/snippets/expire-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/expireat/index.md b/src/sdk/android/3/core-classes/memory-storage/expireat/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/expireat/index.md rename to src/sdk/android/3/core-classes/memory-storage/expireat/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/expireat/snippets/expireat-1.java b/src/sdk/android/3/core-classes/memory-storage/expireat/snippets/expireat-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/expireat/snippets/expireat-1.java rename to src/sdk/android/3/core-classes/memory-storage/expireat/snippets/expireat-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/flushdb/index.md b/src/sdk/android/3/core-classes/memory-storage/flushdb/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/flushdb/index.md rename to src/sdk/android/3/core-classes/memory-storage/flushdb/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/flushdb/snippets/flushdb-1.java b/src/sdk/android/3/core-classes/memory-storage/flushdb/snippets/flushdb-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/flushdb/snippets/flushdb-1.java rename to src/sdk/android/3/core-classes/memory-storage/flushdb/snippets/flushdb-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/geoadd/index.md b/src/sdk/android/3/core-classes/memory-storage/geoadd/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geoadd/index.md rename to src/sdk/android/3/core-classes/memory-storage/geoadd/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/geoadd/snippets/geoadd-1.java b/src/sdk/android/3/core-classes/memory-storage/geoadd/snippets/geoadd-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geoadd/snippets/geoadd-1.java rename to src/sdk/android/3/core-classes/memory-storage/geoadd/snippets/geoadd-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/geodist/index.md b/src/sdk/android/3/core-classes/memory-storage/geodist/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geodist/index.md rename to src/sdk/android/3/core-classes/memory-storage/geodist/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/geodist/snippets/geodist-1.java b/src/sdk/android/3/core-classes/memory-storage/geodist/snippets/geodist-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geodist/snippets/geodist-1.java rename to src/sdk/android/3/core-classes/memory-storage/geodist/snippets/geodist-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/geohash/index.md b/src/sdk/android/3/core-classes/memory-storage/geohash/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geohash/index.md rename to src/sdk/android/3/core-classes/memory-storage/geohash/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/geohash/snippets/geohash-1.java b/src/sdk/android/3/core-classes/memory-storage/geohash/snippets/geohash-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geohash/snippets/geohash-1.java rename to src/sdk/android/3/core-classes/memory-storage/geohash/snippets/geohash-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/geopos/index.md b/src/sdk/android/3/core-classes/memory-storage/geopos/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geopos/index.md rename to src/sdk/android/3/core-classes/memory-storage/geopos/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/geopos/snippets/geopos-1.java b/src/sdk/android/3/core-classes/memory-storage/geopos/snippets/geopos-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/geopos/snippets/geopos-1.java rename to src/sdk/android/3/core-classes/memory-storage/geopos/snippets/geopos-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/georadius/index.md b/src/sdk/android/3/core-classes/memory-storage/georadius/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/georadius/index.md rename to src/sdk/android/3/core-classes/memory-storage/georadius/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/georadius/snippets/georadius-1.java b/src/sdk/android/3/core-classes/memory-storage/georadius/snippets/georadius-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/georadius/snippets/georadius-1.java rename to src/sdk/android/3/core-classes/memory-storage/georadius/snippets/georadius-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/georadiusbymember/index.md b/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/georadiusbymember/index.md rename to src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/georadiusbymember/snippets/georadiusbymember-1.java b/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/georadiusbymember/snippets/georadiusbymember-1.java rename to src/sdk/android/3/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/get/index.md b/src/sdk/android/3/core-classes/memory-storage/get/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/get/index.md rename to src/sdk/android/3/core-classes/memory-storage/get/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/get/snippets/get-1.java b/src/sdk/android/3/core-classes/memory-storage/get/snippets/get-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/get/snippets/get-1.java rename to src/sdk/android/3/core-classes/memory-storage/get/snippets/get-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/getbit/index.md b/src/sdk/android/3/core-classes/memory-storage/getbit/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getbit/index.md rename to src/sdk/android/3/core-classes/memory-storage/getbit/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/getbit/snippets/getbit-1.java b/src/sdk/android/3/core-classes/memory-storage/getbit/snippets/getbit-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getbit/snippets/getbit-1.java rename to src/sdk/android/3/core-classes/memory-storage/getbit/snippets/getbit-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/getrange/index.md b/src/sdk/android/3/core-classes/memory-storage/getrange/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getrange/index.md rename to src/sdk/android/3/core-classes/memory-storage/getrange/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/getrange/snippets/getrange-1.java b/src/sdk/android/3/core-classes/memory-storage/getrange/snippets/getrange-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getrange/snippets/getrange-1.java rename to src/sdk/android/3/core-classes/memory-storage/getrange/snippets/getrange-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/getset/index.md b/src/sdk/android/3/core-classes/memory-storage/getset/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getset/index.md rename to src/sdk/android/3/core-classes/memory-storage/getset/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/getset/snippets/getset-1.java b/src/sdk/android/3/core-classes/memory-storage/getset/snippets/getset-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/getset/snippets/getset-1.java rename to src/sdk/android/3/core-classes/memory-storage/getset/snippets/getset-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hdel/index.md b/src/sdk/android/3/core-classes/memory-storage/hdel/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hdel/index.md rename to src/sdk/android/3/core-classes/memory-storage/hdel/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hdel/snippets/hdel-1.java b/src/sdk/android/3/core-classes/memory-storage/hdel/snippets/hdel-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hdel/snippets/hdel-1.java rename to src/sdk/android/3/core-classes/memory-storage/hdel/snippets/hdel-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hexists/index.md b/src/sdk/android/3/core-classes/memory-storage/hexists/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hexists/index.md rename to src/sdk/android/3/core-classes/memory-storage/hexists/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hexists/snippets/hexists-1.java b/src/sdk/android/3/core-classes/memory-storage/hexists/snippets/hexists-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hexists/snippets/hexists-1.java rename to src/sdk/android/3/core-classes/memory-storage/hexists/snippets/hexists-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hget/index.md b/src/sdk/android/3/core-classes/memory-storage/hget/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hget/index.md rename to src/sdk/android/3/core-classes/memory-storage/hget/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hget/snippets/hget-1.java b/src/sdk/android/3/core-classes/memory-storage/hget/snippets/hget-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hget/snippets/hget-1.java rename to src/sdk/android/3/core-classes/memory-storage/hget/snippets/hget-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hgetall/index.md b/src/sdk/android/3/core-classes/memory-storage/hgetall/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hgetall/index.md rename to src/sdk/android/3/core-classes/memory-storage/hgetall/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hgetall/snippets/hgetall-1.java b/src/sdk/android/3/core-classes/memory-storage/hgetall/snippets/hgetall-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hgetall/snippets/hgetall-1.java rename to src/sdk/android/3/core-classes/memory-storage/hgetall/snippets/hgetall-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hincrby/index.md b/src/sdk/android/3/core-classes/memory-storage/hincrby/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hincrby/index.md rename to src/sdk/android/3/core-classes/memory-storage/hincrby/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hincrby/snippets/hincrby-1.java b/src/sdk/android/3/core-classes/memory-storage/hincrby/snippets/hincrby-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hincrby/snippets/hincrby-1.java rename to src/sdk/android/3/core-classes/memory-storage/hincrby/snippets/hincrby-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hincrbyfloat/index.md b/src/sdk/android/3/core-classes/memory-storage/hincrbyfloat/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hincrbyfloat/index.md rename to src/sdk/android/3/core-classes/memory-storage/hincrbyfloat/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.java b/src/sdk/android/3/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.java rename to src/sdk/android/3/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hkeys/index.md b/src/sdk/android/3/core-classes/memory-storage/hkeys/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hkeys/index.md rename to src/sdk/android/3/core-classes/memory-storage/hkeys/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hkeys/snippets/hkeys-1.java b/src/sdk/android/3/core-classes/memory-storage/hkeys/snippets/hkeys-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hkeys/snippets/hkeys-1.java rename to src/sdk/android/3/core-classes/memory-storage/hkeys/snippets/hkeys-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hlen/index.md b/src/sdk/android/3/core-classes/memory-storage/hlen/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hlen/index.md rename to src/sdk/android/3/core-classes/memory-storage/hlen/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hlen/snippets/hlen-1.java b/src/sdk/android/3/core-classes/memory-storage/hlen/snippets/hlen-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hlen/snippets/hlen-1.java rename to src/sdk/android/3/core-classes/memory-storage/hlen/snippets/hlen-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hmget/index.md b/src/sdk/android/3/core-classes/memory-storage/hmget/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hmget/index.md rename to src/sdk/android/3/core-classes/memory-storage/hmget/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hmget/snippets/hmget-1.java b/src/sdk/android/3/core-classes/memory-storage/hmget/snippets/hmget-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hmget/snippets/hmget-1.java rename to src/sdk/android/3/core-classes/memory-storage/hmget/snippets/hmget-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hmset/index.md b/src/sdk/android/3/core-classes/memory-storage/hmset/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hmset/index.md rename to src/sdk/android/3/core-classes/memory-storage/hmset/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hmset/snippets/hmset-1.java b/src/sdk/android/3/core-classes/memory-storage/hmset/snippets/hmset-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hmset/snippets/hmset-1.java rename to src/sdk/android/3/core-classes/memory-storage/hmset/snippets/hmset-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hscan/index.md b/src/sdk/android/3/core-classes/memory-storage/hscan/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hscan/index.md rename to src/sdk/android/3/core-classes/memory-storage/hscan/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hscan/snippets/hscan-1.java b/src/sdk/android/3/core-classes/memory-storage/hscan/snippets/hscan-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hscan/snippets/hscan-1.java rename to src/sdk/android/3/core-classes/memory-storage/hscan/snippets/hscan-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hset/index.md b/src/sdk/android/3/core-classes/memory-storage/hset/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hset/index.md rename to src/sdk/android/3/core-classes/memory-storage/hset/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hset/snippets/hset-1.java b/src/sdk/android/3/core-classes/memory-storage/hset/snippets/hset-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hset/snippets/hset-1.java rename to src/sdk/android/3/core-classes/memory-storage/hset/snippets/hset-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hsetnx/index.md b/src/sdk/android/3/core-classes/memory-storage/hsetnx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hsetnx/index.md rename to src/sdk/android/3/core-classes/memory-storage/hsetnx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hsetnx/snippets/hsetnx-1.java b/src/sdk/android/3/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hsetnx/snippets/hsetnx-1.java rename to src/sdk/android/3/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hstrlen/index.md b/src/sdk/android/3/core-classes/memory-storage/hstrlen/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hstrlen/index.md rename to src/sdk/android/3/core-classes/memory-storage/hstrlen/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hstrlen/snippets/hstrlen-1.java b/src/sdk/android/3/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hstrlen/snippets/hstrlen-1.java rename to src/sdk/android/3/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/hvals/index.md b/src/sdk/android/3/core-classes/memory-storage/hvals/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hvals/index.md rename to src/sdk/android/3/core-classes/memory-storage/hvals/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/hvals/snippets/hvals-1.java b/src/sdk/android/3/core-classes/memory-storage/hvals/snippets/hvals-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/hvals/snippets/hvals-1.java rename to src/sdk/android/3/core-classes/memory-storage/hvals/snippets/hvals-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/incr/index.md b/src/sdk/android/3/core-classes/memory-storage/incr/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incr/index.md rename to src/sdk/android/3/core-classes/memory-storage/incr/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/incr/snippets/incr-1.java b/src/sdk/android/3/core-classes/memory-storage/incr/snippets/incr-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incr/snippets/incr-1.java rename to src/sdk/android/3/core-classes/memory-storage/incr/snippets/incr-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/incrby/index.md b/src/sdk/android/3/core-classes/memory-storage/incrby/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incrby/index.md rename to src/sdk/android/3/core-classes/memory-storage/incrby/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/incrby/snippets/incrby-1.java b/src/sdk/android/3/core-classes/memory-storage/incrby/snippets/incrby-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incrby/snippets/incrby-1.java rename to src/sdk/android/3/core-classes/memory-storage/incrby/snippets/incrby-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/incrbyfloat/index.md b/src/sdk/android/3/core-classes/memory-storage/incrbyfloat/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incrbyfloat/index.md rename to src/sdk/android/3/core-classes/memory-storage/incrbyfloat/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/incrbyfloat/snippets/incrbyfloat-1.java b/src/sdk/android/3/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/incrbyfloat/snippets/incrbyfloat-1.java rename to src/sdk/android/3/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/index.md b/src/sdk/android/3/core-classes/memory-storage/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/index.md rename to src/sdk/android/3/core-classes/memory-storage/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/keys/index.md b/src/sdk/android/3/core-classes/memory-storage/keys/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/keys/index.md rename to src/sdk/android/3/core-classes/memory-storage/keys/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/keys/snippets/keys-1.java b/src/sdk/android/3/core-classes/memory-storage/keys/snippets/keys-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/keys/snippets/keys-1.java rename to src/sdk/android/3/core-classes/memory-storage/keys/snippets/keys-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lindex/index.md b/src/sdk/android/3/core-classes/memory-storage/lindex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lindex/index.md rename to src/sdk/android/3/core-classes/memory-storage/lindex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lindex/snippets/lindex-1.java b/src/sdk/android/3/core-classes/memory-storage/lindex/snippets/lindex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lindex/snippets/lindex-1.java rename to src/sdk/android/3/core-classes/memory-storage/lindex/snippets/lindex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/linsert/index.md b/src/sdk/android/3/core-classes/memory-storage/linsert/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/linsert/index.md rename to src/sdk/android/3/core-classes/memory-storage/linsert/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/linsert/snippets/linsert-1.java b/src/sdk/android/3/core-classes/memory-storage/linsert/snippets/linsert-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/linsert/snippets/linsert-1.java rename to src/sdk/android/3/core-classes/memory-storage/linsert/snippets/linsert-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/llen/index.md b/src/sdk/android/3/core-classes/memory-storage/llen/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/llen/index.md rename to src/sdk/android/3/core-classes/memory-storage/llen/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/llen/snippets/llen-1.java b/src/sdk/android/3/core-classes/memory-storage/llen/snippets/llen-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/llen/snippets/llen-1.java rename to src/sdk/android/3/core-classes/memory-storage/llen/snippets/llen-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lpop/index.md b/src/sdk/android/3/core-classes/memory-storage/lpop/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpop/index.md rename to src/sdk/android/3/core-classes/memory-storage/lpop/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lpop/snippets/lpop-1.java b/src/sdk/android/3/core-classes/memory-storage/lpop/snippets/lpop-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpop/snippets/lpop-1.java rename to src/sdk/android/3/core-classes/memory-storage/lpop/snippets/lpop-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lpush/index.md b/src/sdk/android/3/core-classes/memory-storage/lpush/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpush/index.md rename to src/sdk/android/3/core-classes/memory-storage/lpush/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lpush/snippets/lpush-1.java b/src/sdk/android/3/core-classes/memory-storage/lpush/snippets/lpush-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpush/snippets/lpush-1.java rename to src/sdk/android/3/core-classes/memory-storage/lpush/snippets/lpush-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lpushx/index.md b/src/sdk/android/3/core-classes/memory-storage/lpushx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpushx/index.md rename to src/sdk/android/3/core-classes/memory-storage/lpushx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lpushx/snippets/lpushx-1.java b/src/sdk/android/3/core-classes/memory-storage/lpushx/snippets/lpushx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lpushx/snippets/lpushx-1.java rename to src/sdk/android/3/core-classes/memory-storage/lpushx/snippets/lpushx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lrange/index.md b/src/sdk/android/3/core-classes/memory-storage/lrange/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lrange/index.md rename to src/sdk/android/3/core-classes/memory-storage/lrange/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lrange/snippets/lrange-1.java b/src/sdk/android/3/core-classes/memory-storage/lrange/snippets/lrange-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lrange/snippets/lrange-1.java rename to src/sdk/android/3/core-classes/memory-storage/lrange/snippets/lrange-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lrem/index.md b/src/sdk/android/3/core-classes/memory-storage/lrem/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lrem/index.md rename to src/sdk/android/3/core-classes/memory-storage/lrem/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lrem/snippets/lrem-1.java b/src/sdk/android/3/core-classes/memory-storage/lrem/snippets/lrem-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lrem/snippets/lrem-1.java rename to src/sdk/android/3/core-classes/memory-storage/lrem/snippets/lrem-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/lset/index.md b/src/sdk/android/3/core-classes/memory-storage/lset/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lset/index.md rename to src/sdk/android/3/core-classes/memory-storage/lset/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/lset/snippets/lset-1.java b/src/sdk/android/3/core-classes/memory-storage/lset/snippets/lset-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/lset/snippets/lset-1.java rename to src/sdk/android/3/core-classes/memory-storage/lset/snippets/lset-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/ltrim/index.md b/src/sdk/android/3/core-classes/memory-storage/ltrim/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ltrim/index.md rename to src/sdk/android/3/core-classes/memory-storage/ltrim/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/ltrim/snippets/ltrim-1.java b/src/sdk/android/3/core-classes/memory-storage/ltrim/snippets/ltrim-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ltrim/snippets/ltrim-1.java rename to src/sdk/android/3/core-classes/memory-storage/ltrim/snippets/ltrim-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/mget/index.md b/src/sdk/android/3/core-classes/memory-storage/mget/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/mget/index.md rename to src/sdk/android/3/core-classes/memory-storage/mget/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/mget/snippets/mget-1.java b/src/sdk/android/3/core-classes/memory-storage/mget/snippets/mget-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/mget/snippets/mget-1.java rename to src/sdk/android/3/core-classes/memory-storage/mget/snippets/mget-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/mset/index.md b/src/sdk/android/3/core-classes/memory-storage/mset/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/mset/index.md rename to src/sdk/android/3/core-classes/memory-storage/mset/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/mset/snippets/mset-1.java b/src/sdk/android/3/core-classes/memory-storage/mset/snippets/mset-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/mset/snippets/mset-1.java rename to src/sdk/android/3/core-classes/memory-storage/mset/snippets/mset-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/msetnx/index.md b/src/sdk/android/3/core-classes/memory-storage/msetnx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/msetnx/index.md rename to src/sdk/android/3/core-classes/memory-storage/msetnx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/msetnx/snippets/msetnx-1.java b/src/sdk/android/3/core-classes/memory-storage/msetnx/snippets/msetnx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/msetnx/snippets/msetnx-1.java rename to src/sdk/android/3/core-classes/memory-storage/msetnx/snippets/msetnx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/object/index.md b/src/sdk/android/3/core-classes/memory-storage/object/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/object/index.md rename to src/sdk/android/3/core-classes/memory-storage/object/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/object/snippets/object-1.java b/src/sdk/android/3/core-classes/memory-storage/object/snippets/object-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/object/snippets/object-1.java rename to src/sdk/android/3/core-classes/memory-storage/object/snippets/object-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/persist/index.md b/src/sdk/android/3/core-classes/memory-storage/persist/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/persist/index.md rename to src/sdk/android/3/core-classes/memory-storage/persist/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/persist/snippets/persist-1.java b/src/sdk/android/3/core-classes/memory-storage/persist/snippets/persist-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/persist/snippets/persist-1.java rename to src/sdk/android/3/core-classes/memory-storage/persist/snippets/persist-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pexpire/index.md b/src/sdk/android/3/core-classes/memory-storage/pexpire/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pexpire/index.md rename to src/sdk/android/3/core-classes/memory-storage/pexpire/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pexpire/snippets/pexpire-1.java b/src/sdk/android/3/core-classes/memory-storage/pexpire/snippets/pexpire-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pexpire/snippets/pexpire-1.java rename to src/sdk/android/3/core-classes/memory-storage/pexpire/snippets/pexpire-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pexpireat/index.md b/src/sdk/android/3/core-classes/memory-storage/pexpireat/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pexpireat/index.md rename to src/sdk/android/3/core-classes/memory-storage/pexpireat/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pexpireat/snippets/pexpireat-1.java b/src/sdk/android/3/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pexpireat/snippets/pexpireat-1.java rename to src/sdk/android/3/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pfadd/index.md b/src/sdk/android/3/core-classes/memory-storage/pfadd/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfadd/index.md rename to src/sdk/android/3/core-classes/memory-storage/pfadd/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pfadd/snippets/pfadd-1.java b/src/sdk/android/3/core-classes/memory-storage/pfadd/snippets/pfadd-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfadd/snippets/pfadd-1.java rename to src/sdk/android/3/core-classes/memory-storage/pfadd/snippets/pfadd-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pfcount/index.md b/src/sdk/android/3/core-classes/memory-storage/pfcount/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfcount/index.md rename to src/sdk/android/3/core-classes/memory-storage/pfcount/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pfcount/snippets/pfcount-1.java b/src/sdk/android/3/core-classes/memory-storage/pfcount/snippets/pfcount-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfcount/snippets/pfcount-1.java rename to src/sdk/android/3/core-classes/memory-storage/pfcount/snippets/pfcount-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pfmerge/index.md b/src/sdk/android/3/core-classes/memory-storage/pfmerge/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfmerge/index.md rename to src/sdk/android/3/core-classes/memory-storage/pfmerge/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pfmerge/snippets/pfmerge-1.java b/src/sdk/android/3/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pfmerge/snippets/pfmerge-1.java rename to src/sdk/android/3/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/ping/index.md b/src/sdk/android/3/core-classes/memory-storage/ping/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ping/index.md rename to src/sdk/android/3/core-classes/memory-storage/ping/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/ping/snippets/ping-1.java b/src/sdk/android/3/core-classes/memory-storage/ping/snippets/ping-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ping/snippets/ping-1.java rename to src/sdk/android/3/core-classes/memory-storage/ping/snippets/ping-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/psetex/index.md b/src/sdk/android/3/core-classes/memory-storage/psetex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/psetex/index.md rename to src/sdk/android/3/core-classes/memory-storage/psetex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/psetex/snippets/psetex-1.java b/src/sdk/android/3/core-classes/memory-storage/psetex/snippets/psetex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/psetex/snippets/psetex-1.java rename to src/sdk/android/3/core-classes/memory-storage/psetex/snippets/psetex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/pttl/index.md b/src/sdk/android/3/core-classes/memory-storage/pttl/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pttl/index.md rename to src/sdk/android/3/core-classes/memory-storage/pttl/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/pttl/snippets/pttl-1.java b/src/sdk/android/3/core-classes/memory-storage/pttl/snippets/pttl-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/pttl/snippets/pttl-1.java rename to src/sdk/android/3/core-classes/memory-storage/pttl/snippets/pttl-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/randomkey/index.md b/src/sdk/android/3/core-classes/memory-storage/randomkey/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/randomkey/index.md rename to src/sdk/android/3/core-classes/memory-storage/randomkey/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/randomkey/snippets/randomkey-1.java b/src/sdk/android/3/core-classes/memory-storage/randomkey/snippets/randomkey-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/randomkey/snippets/randomkey-1.java rename to src/sdk/android/3/core-classes/memory-storage/randomkey/snippets/randomkey-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/rename/index.md b/src/sdk/android/3/core-classes/memory-storage/rename/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rename/index.md rename to src/sdk/android/3/core-classes/memory-storage/rename/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/rename/snippets/rename-1.java b/src/sdk/android/3/core-classes/memory-storage/rename/snippets/rename-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rename/snippets/rename-1.java rename to src/sdk/android/3/core-classes/memory-storage/rename/snippets/rename-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/renamenx/index.md b/src/sdk/android/3/core-classes/memory-storage/renamenx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/renamenx/index.md rename to src/sdk/android/3/core-classes/memory-storage/renamenx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/renamenx/snippets/renamenx-1.java b/src/sdk/android/3/core-classes/memory-storage/renamenx/snippets/renamenx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/renamenx/snippets/renamenx-1.java rename to src/sdk/android/3/core-classes/memory-storage/renamenx/snippets/renamenx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/rpop/index.md b/src/sdk/android/3/core-classes/memory-storage/rpop/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpop/index.md rename to src/sdk/android/3/core-classes/memory-storage/rpop/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/rpop/snippets/rpop-1.java b/src/sdk/android/3/core-classes/memory-storage/rpop/snippets/rpop-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpop/snippets/rpop-1.java rename to src/sdk/android/3/core-classes/memory-storage/rpop/snippets/rpop-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/rpoplpush/index.md b/src/sdk/android/3/core-classes/memory-storage/rpoplpush/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpoplpush/index.md rename to src/sdk/android/3/core-classes/memory-storage/rpoplpush/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/rpoplpush/snippets/rpoplpush-1.java b/src/sdk/android/3/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpoplpush/snippets/rpoplpush-1.java rename to src/sdk/android/3/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/rpush/index.md b/src/sdk/android/3/core-classes/memory-storage/rpush/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpush/index.md rename to src/sdk/android/3/core-classes/memory-storage/rpush/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/rpush/snippets/rpush-1.java b/src/sdk/android/3/core-classes/memory-storage/rpush/snippets/rpush-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpush/snippets/rpush-1.java rename to src/sdk/android/3/core-classes/memory-storage/rpush/snippets/rpush-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/rpushx/index.md b/src/sdk/android/3/core-classes/memory-storage/rpushx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpushx/index.md rename to src/sdk/android/3/core-classes/memory-storage/rpushx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/rpushx/snippets/rpushx-1.java b/src/sdk/android/3/core-classes/memory-storage/rpushx/snippets/rpushx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/rpushx/snippets/rpushx-1.java rename to src/sdk/android/3/core-classes/memory-storage/rpushx/snippets/rpushx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sadd/index.md b/src/sdk/android/3/core-classes/memory-storage/sadd/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sadd/index.md rename to src/sdk/android/3/core-classes/memory-storage/sadd/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sadd/snippets/sadd-1.java b/src/sdk/android/3/core-classes/memory-storage/sadd/snippets/sadd-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sadd/snippets/sadd-1.java rename to src/sdk/android/3/core-classes/memory-storage/sadd/snippets/sadd-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/scan/index.md b/src/sdk/android/3/core-classes/memory-storage/scan/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/scan/index.md rename to src/sdk/android/3/core-classes/memory-storage/scan/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/scan/snippets/scan-1.java b/src/sdk/android/3/core-classes/memory-storage/scan/snippets/scan-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/scan/snippets/scan-1.java rename to src/sdk/android/3/core-classes/memory-storage/scan/snippets/scan-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/scard/index.md b/src/sdk/android/3/core-classes/memory-storage/scard/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/scard/index.md rename to src/sdk/android/3/core-classes/memory-storage/scard/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/scard/snippets/scard-1.java b/src/sdk/android/3/core-classes/memory-storage/scard/snippets/scard-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/scard/snippets/scard-1.java rename to src/sdk/android/3/core-classes/memory-storage/scard/snippets/scard-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sdiff/index.md b/src/sdk/android/3/core-classes/memory-storage/sdiff/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sdiff/index.md rename to src/sdk/android/3/core-classes/memory-storage/sdiff/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sdiff/snippets/sdiff-1.java b/src/sdk/android/3/core-classes/memory-storage/sdiff/snippets/sdiff-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sdiff/snippets/sdiff-1.java rename to src/sdk/android/3/core-classes/memory-storage/sdiff/snippets/sdiff-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sdiffstore/index.md b/src/sdk/android/3/core-classes/memory-storage/sdiffstore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sdiffstore/index.md rename to src/sdk/android/3/core-classes/memory-storage/sdiffstore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sdiffstore/snippets/sdiffstore-1.java b/src/sdk/android/3/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sdiffstore/snippets/sdiffstore-1.java rename to src/sdk/android/3/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/set/index.md b/src/sdk/android/3/core-classes/memory-storage/set/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/set/index.md rename to src/sdk/android/3/core-classes/memory-storage/set/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/set/snippets/set-1.java b/src/sdk/android/3/core-classes/memory-storage/set/snippets/set-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/set/snippets/set-1.java rename to src/sdk/android/3/core-classes/memory-storage/set/snippets/set-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/setex/index.md b/src/sdk/android/3/core-classes/memory-storage/setex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/setex/index.md rename to src/sdk/android/3/core-classes/memory-storage/setex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/setex/snippets/setex-1.java b/src/sdk/android/3/core-classes/memory-storage/setex/snippets/setex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/setex/snippets/setex-1.java rename to src/sdk/android/3/core-classes/memory-storage/setex/snippets/setex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/setnx/index.md b/src/sdk/android/3/core-classes/memory-storage/setnx/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/setnx/index.md rename to src/sdk/android/3/core-classes/memory-storage/setnx/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/setnx/snippets/setnx-1.java b/src/sdk/android/3/core-classes/memory-storage/setnx/snippets/setnx-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/setnx/snippets/setnx-1.java rename to src/sdk/android/3/core-classes/memory-storage/setnx/snippets/setnx-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sinter/index.md b/src/sdk/android/3/core-classes/memory-storage/sinter/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sinter/index.md rename to src/sdk/android/3/core-classes/memory-storage/sinter/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sinter/snippets/sinter-1.java b/src/sdk/android/3/core-classes/memory-storage/sinter/snippets/sinter-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sinter/snippets/sinter-1.java rename to src/sdk/android/3/core-classes/memory-storage/sinter/snippets/sinter-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sinterstore/index.md b/src/sdk/android/3/core-classes/memory-storage/sinterstore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sinterstore/index.md rename to src/sdk/android/3/core-classes/memory-storage/sinterstore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sinterstore/snippets/sinterstore-1.java b/src/sdk/android/3/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sinterstore/snippets/sinterstore-1.java rename to src/sdk/android/3/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sismember/index.md b/src/sdk/android/3/core-classes/memory-storage/sismember/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sismember/index.md rename to src/sdk/android/3/core-classes/memory-storage/sismember/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sismember/snippets/sismember-1.java b/src/sdk/android/3/core-classes/memory-storage/sismember/snippets/sismember-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sismember/snippets/sismember-1.java rename to src/sdk/android/3/core-classes/memory-storage/sismember/snippets/sismember-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/smembers/index.md b/src/sdk/android/3/core-classes/memory-storage/smembers/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/smembers/index.md rename to src/sdk/android/3/core-classes/memory-storage/smembers/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/smembers/snippets/smembers-1.java b/src/sdk/android/3/core-classes/memory-storage/smembers/snippets/smembers-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/smembers/snippets/smembers-1.java rename to src/sdk/android/3/core-classes/memory-storage/smembers/snippets/smembers-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/smove/index.md b/src/sdk/android/3/core-classes/memory-storage/smove/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/smove/index.md rename to src/sdk/android/3/core-classes/memory-storage/smove/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/smove/snippets/smove-1.java b/src/sdk/android/3/core-classes/memory-storage/smove/snippets/smove-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/smove/snippets/smove-1.java rename to src/sdk/android/3/core-classes/memory-storage/smove/snippets/smove-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sort/index.md b/src/sdk/android/3/core-classes/memory-storage/sort/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sort/index.md rename to src/sdk/android/3/core-classes/memory-storage/sort/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sort/snippets/sort-1.java b/src/sdk/android/3/core-classes/memory-storage/sort/snippets/sort-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sort/snippets/sort-1.java rename to src/sdk/android/3/core-classes/memory-storage/sort/snippets/sort-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/spop/index.md b/src/sdk/android/3/core-classes/memory-storage/spop/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/spop/index.md rename to src/sdk/android/3/core-classes/memory-storage/spop/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/spop/snippets/spop-1.java b/src/sdk/android/3/core-classes/memory-storage/spop/snippets/spop-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/spop/snippets/spop-1.java rename to src/sdk/android/3/core-classes/memory-storage/spop/snippets/spop-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/srandmember/index.md b/src/sdk/android/3/core-classes/memory-storage/srandmember/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/srandmember/index.md rename to src/sdk/android/3/core-classes/memory-storage/srandmember/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/srandmember/snippets/srandmember-1.java b/src/sdk/android/3/core-classes/memory-storage/srandmember/snippets/srandmember-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/srandmember/snippets/srandmember-1.java rename to src/sdk/android/3/core-classes/memory-storage/srandmember/snippets/srandmember-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/srem/index.md b/src/sdk/android/3/core-classes/memory-storage/srem/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/srem/index.md rename to src/sdk/android/3/core-classes/memory-storage/srem/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/srem/snippets/srem-1.java b/src/sdk/android/3/core-classes/memory-storage/srem/snippets/srem-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/srem/snippets/srem-1.java rename to src/sdk/android/3/core-classes/memory-storage/srem/snippets/srem-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sscan/index.md b/src/sdk/android/3/core-classes/memory-storage/sscan/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sscan/index.md rename to src/sdk/android/3/core-classes/memory-storage/sscan/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sscan/snippets/sscan-1.java b/src/sdk/android/3/core-classes/memory-storage/sscan/snippets/sscan-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sscan/snippets/sscan-1.java rename to src/sdk/android/3/core-classes/memory-storage/sscan/snippets/sscan-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/strlen/index.md b/src/sdk/android/3/core-classes/memory-storage/strlen/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/strlen/index.md rename to src/sdk/android/3/core-classes/memory-storage/strlen/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/strlen/snippets/strlen-1.java b/src/sdk/android/3/core-classes/memory-storage/strlen/snippets/strlen-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/strlen/snippets/strlen-1.java rename to src/sdk/android/3/core-classes/memory-storage/strlen/snippets/strlen-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sunion/index.md b/src/sdk/android/3/core-classes/memory-storage/sunion/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sunion/index.md rename to src/sdk/android/3/core-classes/memory-storage/sunion/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sunion/snippets/sunion-1.java b/src/sdk/android/3/core-classes/memory-storage/sunion/snippets/sunion-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sunion/snippets/sunion-1.java rename to src/sdk/android/3/core-classes/memory-storage/sunion/snippets/sunion-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/sunionstore/index.md b/src/sdk/android/3/core-classes/memory-storage/sunionstore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sunionstore/index.md rename to src/sdk/android/3/core-classes/memory-storage/sunionstore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/sunionstore/snippets/sunionstore-1.java b/src/sdk/android/3/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/sunionstore/snippets/sunionstore-1.java rename to src/sdk/android/3/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/time/index.md b/src/sdk/android/3/core-classes/memory-storage/time/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/time/index.md rename to src/sdk/android/3/core-classes/memory-storage/time/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/time/snippets/time-1.java b/src/sdk/android/3/core-classes/memory-storage/time/snippets/time-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/time/snippets/time-1.java rename to src/sdk/android/3/core-classes/memory-storage/time/snippets/time-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/touch/index.md b/src/sdk/android/3/core-classes/memory-storage/touch/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/touch/index.md rename to src/sdk/android/3/core-classes/memory-storage/touch/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/touch/snippets/touch-1.java b/src/sdk/android/3/core-classes/memory-storage/touch/snippets/touch-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/touch/snippets/touch-1.java rename to src/sdk/android/3/core-classes/memory-storage/touch/snippets/touch-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/ttl/index.md b/src/sdk/android/3/core-classes/memory-storage/ttl/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ttl/index.md rename to src/sdk/android/3/core-classes/memory-storage/ttl/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/ttl/snippets/ttl-1.java b/src/sdk/android/3/core-classes/memory-storage/ttl/snippets/ttl-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/ttl/snippets/ttl-1.java rename to src/sdk/android/3/core-classes/memory-storage/ttl/snippets/ttl-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/type/index.md b/src/sdk/android/3/core-classes/memory-storage/type/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/type/index.md rename to src/sdk/android/3/core-classes/memory-storage/type/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/type/snippets/type-1.java b/src/sdk/android/3/core-classes/memory-storage/type/snippets/type-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/type/snippets/type-1.java rename to src/sdk/android/3/core-classes/memory-storage/type/snippets/type-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zadd/index.md b/src/sdk/android/3/core-classes/memory-storage/zadd/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zadd/index.md rename to src/sdk/android/3/core-classes/memory-storage/zadd/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zadd/snippets/zadd-1.java b/src/sdk/android/3/core-classes/memory-storage/zadd/snippets/zadd-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zadd/snippets/zadd-1.java rename to src/sdk/android/3/core-classes/memory-storage/zadd/snippets/zadd-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zcard/index.md b/src/sdk/android/3/core-classes/memory-storage/zcard/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zcard/index.md rename to src/sdk/android/3/core-classes/memory-storage/zcard/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zcard/snippets/zcard-1.java b/src/sdk/android/3/core-classes/memory-storage/zcard/snippets/zcard-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zcard/snippets/zcard-1.java rename to src/sdk/android/3/core-classes/memory-storage/zcard/snippets/zcard-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zcount/index.md b/src/sdk/android/3/core-classes/memory-storage/zcount/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zcount/index.md rename to src/sdk/android/3/core-classes/memory-storage/zcount/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zcount/snippets/zcount-1.java b/src/sdk/android/3/core-classes/memory-storage/zcount/snippets/zcount-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zcount/snippets/zcount-1.java rename to src/sdk/android/3/core-classes/memory-storage/zcount/snippets/zcount-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zincrby/index.md b/src/sdk/android/3/core-classes/memory-storage/zincrby/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zincrby/index.md rename to src/sdk/android/3/core-classes/memory-storage/zincrby/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zincrby/snippets/zincrby-1.java b/src/sdk/android/3/core-classes/memory-storage/zincrby/snippets/zincrby-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zincrby/snippets/zincrby-1.java rename to src/sdk/android/3/core-classes/memory-storage/zincrby/snippets/zincrby-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zinterstore/index.md b/src/sdk/android/3/core-classes/memory-storage/zinterstore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zinterstore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zinterstore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zinterstore/snippets/zinterstore-1.java b/src/sdk/android/3/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zinterstore/snippets/zinterstore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zlexcount/index.md b/src/sdk/android/3/core-classes/memory-storage/zlexcount/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zlexcount/index.md rename to src/sdk/android/3/core-classes/memory-storage/zlexcount/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zlexcount/snippets/zlexcount-1.java b/src/sdk/android/3/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zlexcount/snippets/zlexcount-1.java rename to src/sdk/android/3/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrange/index.md b/src/sdk/android/3/core-classes/memory-storage/zrange/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrange/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrange/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrange/snippets/zrange-1.java b/src/sdk/android/3/core-classes/memory-storage/zrange/snippets/zrange-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrange/snippets/zrange-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrange/snippets/zrange-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrangebylex/index.md b/src/sdk/android/3/core-classes/memory-storage/zrangebylex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrangebylex/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrangebylex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrangebylex/snippets/zrangebylex-1.java b/src/sdk/android/3/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrangebylex/snippets/zrangebylex-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrangebyscore/index.md b/src/sdk/android/3/core-classes/memory-storage/zrangebyscore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrangebyscore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrangebyscore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrangebyscore/snippets/zrangebyscore-1.java b/src/sdk/android/3/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrangebyscore/snippets/zrangebyscore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrank/index.md b/src/sdk/android/3/core-classes/memory-storage/zrank/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrank/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrank/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrank/snippets/zrank-1.java b/src/sdk/android/3/core-classes/memory-storage/zrank/snippets/zrank-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrank/snippets/zrank-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrank/snippets/zrank-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrem/index.md b/src/sdk/android/3/core-classes/memory-storage/zrem/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrem/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrem/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrem/snippets/zrem-1.java b/src/sdk/android/3/core-classes/memory-storage/zrem/snippets/zrem-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrem/snippets/zrem-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrem/snippets/zrem-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebylex/index.md b/src/sdk/android/3/core-classes/memory-storage/zremrangebylex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebylex/index.md rename to src/sdk/android/3/core-classes/memory-storage/zremrangebylex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebylex/snippets/zremrangebylex-1.java b/src/sdk/android/3/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebylex/snippets/zremrangebylex-1.java rename to src/sdk/android/3/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebyrank/index.md b/src/sdk/android/3/core-classes/memory-storage/zremrangebyrank/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebyrank/index.md rename to src/sdk/android/3/core-classes/memory-storage/zremrangebyrank/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.java b/src/sdk/android/3/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.java rename to src/sdk/android/3/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebyscore/index.md b/src/sdk/android/3/core-classes/memory-storage/zremrangebyscore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebyscore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zremrangebyscore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.java b/src/sdk/android/3/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrange/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrange/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrange/snippets/zrevrange-1.java b/src/sdk/android/3/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrange/snippets/zrevrange-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrangebylex/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrangebylex/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.java b/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrangebyscore/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrangebyscore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.java b/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrank/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrank/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrank/index.md rename to src/sdk/android/3/core-classes/memory-storage/zrevrank/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zrevrank/snippets/zrevrank-1.java b/src/sdk/android/3/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zrevrank/snippets/zrevrank-1.java rename to src/sdk/android/3/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zscan/index.md b/src/sdk/android/3/core-classes/memory-storage/zscan/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zscan/index.md rename to src/sdk/android/3/core-classes/memory-storage/zscan/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zscan/snippets/zscan-1.java b/src/sdk/android/3/core-classes/memory-storage/zscan/snippets/zscan-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zscan/snippets/zscan-1.java rename to src/sdk/android/3/core-classes/memory-storage/zscan/snippets/zscan-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zscore/index.md b/src/sdk/android/3/core-classes/memory-storage/zscore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zscore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zscore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zscore/snippets/zscore-1.java b/src/sdk/android/3/core-classes/memory-storage/zscore/snippets/zscore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zscore/snippets/zscore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zscore/snippets/zscore-1.java diff --git a/src/sdk/android/3/controllers/memory-storage/zunionstore/index.md b/src/sdk/android/3/core-classes/memory-storage/zunionstore/index.md similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zunionstore/index.md rename to src/sdk/android/3/core-classes/memory-storage/zunionstore/index.md diff --git a/src/sdk/android/3/controllers/memory-storage/zunionstore/snippets/zunionstore-1.java b/src/sdk/android/3/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.java similarity index 100% rename from src/sdk/android/3/controllers/memory-storage/zunionstore/snippets/zunionstore-1.java rename to src/sdk/android/3/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.java diff --git a/src/sdk/android/3/controllers/profile/add-policy/index.md b/src/sdk/android/3/core-classes/profile/add-policy/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/add-policy/index.md rename to src/sdk/android/3/core-classes/profile/add-policy/index.md diff --git a/src/sdk/android/3/controllers/profile/add-policy/snippets/add-policy-1.java b/src/sdk/android/3/core-classes/profile/add-policy/snippets/add-policy-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/add-policy/snippets/add-policy-1.java rename to src/sdk/android/3/core-classes/profile/add-policy/snippets/add-policy-1.java diff --git a/src/sdk/android/3/controllers/profile/constructor/index.md b/src/sdk/android/3/core-classes/profile/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/constructor/index.md rename to src/sdk/android/3/core-classes/profile/constructor/index.md diff --git a/src/sdk/android/3/controllers/profile/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/profile/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/profile/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/profile/delete/index.md b/src/sdk/android/3/core-classes/profile/delete/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/delete/index.md rename to src/sdk/android/3/core-classes/profile/delete/index.md diff --git a/src/sdk/android/3/controllers/profile/delete/snippets/delete-1.java b/src/sdk/android/3/core-classes/profile/delete/snippets/delete-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/delete/snippets/delete-1.java rename to src/sdk/android/3/core-classes/profile/delete/snippets/delete-1.java diff --git a/src/sdk/android/3/controllers/profile/get-policies/index.md b/src/sdk/android/3/core-classes/profile/get-policies/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/get-policies/index.md rename to src/sdk/android/3/core-classes/profile/get-policies/index.md diff --git a/src/sdk/android/3/controllers/profile/get-policies/snippets/get-policies-1.java b/src/sdk/android/3/core-classes/profile/get-policies/snippets/get-policies-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/get-policies/snippets/get-policies-1.java rename to src/sdk/android/3/core-classes/profile/get-policies/snippets/get-policies-1.java diff --git a/src/sdk/android/3/controllers/profile/index.md b/src/sdk/android/3/core-classes/profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/index.md rename to src/sdk/android/3/core-classes/profile/index.md diff --git a/src/sdk/android/3/controllers/profile/save/index.md b/src/sdk/android/3/core-classes/profile/save/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/save/index.md rename to src/sdk/android/3/core-classes/profile/save/index.md diff --git a/src/sdk/android/3/controllers/profile/save/snippets/save-1.java b/src/sdk/android/3/core-classes/profile/save/snippets/save-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/save/snippets/save-1.java rename to src/sdk/android/3/core-classes/profile/save/snippets/save-1.java diff --git a/src/sdk/android/3/controllers/profile/set-content/index.md b/src/sdk/android/3/core-classes/profile/set-content/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/set-content/index.md rename to src/sdk/android/3/core-classes/profile/set-content/index.md diff --git a/src/sdk/android/3/controllers/profile/set-content/snippets/set-content-1.java b/src/sdk/android/3/core-classes/profile/set-content/snippets/set-content-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/set-content/snippets/set-content-1.java rename to src/sdk/android/3/core-classes/profile/set-content/snippets/set-content-1.java diff --git a/src/sdk/android/3/controllers/profile/set-policies/index.md b/src/sdk/android/3/core-classes/profile/set-policies/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/set-policies/index.md rename to src/sdk/android/3/core-classes/profile/set-policies/index.md diff --git a/src/sdk/android/3/controllers/profile/set-policies/snippets/set-policies-1.java b/src/sdk/android/3/core-classes/profile/set-policies/snippets/set-policies-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/set-policies/snippets/set-policies-1.java rename to src/sdk/android/3/core-classes/profile/set-policies/snippets/set-policies-1.java diff --git a/src/sdk/android/3/controllers/profile/update/index.md b/src/sdk/android/3/core-classes/profile/update/index.md similarity index 100% rename from src/sdk/android/3/controllers/profile/update/index.md rename to src/sdk/android/3/core-classes/profile/update/index.md diff --git a/src/sdk/android/3/controllers/profile/update/snippets/update-1.java b/src/sdk/android/3/core-classes/profile/update/snippets/update-1.java similarity index 100% rename from src/sdk/android/3/controllers/profile/update/snippets/update-1.java rename to src/sdk/android/3/core-classes/profile/update/snippets/update-1.java diff --git a/src/sdk/android/3/controllers/role/constructor/index.md b/src/sdk/android/3/core-classes/role/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/constructor/index.md rename to src/sdk/android/3/core-classes/role/constructor/index.md diff --git a/src/sdk/android/3/controllers/role/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/role/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/role/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/role/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/role/delete/index.md b/src/sdk/android/3/core-classes/role/delete/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/delete/index.md rename to src/sdk/android/3/core-classes/role/delete/index.md diff --git a/src/sdk/android/3/controllers/role/delete/snippets/delete-1.java b/src/sdk/android/3/core-classes/role/delete/snippets/delete-1.java similarity index 100% rename from src/sdk/android/3/controllers/role/delete/snippets/delete-1.java rename to src/sdk/android/3/core-classes/role/delete/snippets/delete-1.java diff --git a/src/sdk/android/3/controllers/role/index.md b/src/sdk/android/3/core-classes/role/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/index.md rename to src/sdk/android/3/core-classes/role/index.md diff --git a/src/sdk/android/3/controllers/role/save/index.md b/src/sdk/android/3/core-classes/role/save/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/save/index.md rename to src/sdk/android/3/core-classes/role/save/index.md diff --git a/src/sdk/android/3/controllers/role/save/snippets/save-1.java b/src/sdk/android/3/core-classes/role/save/snippets/save-1.java similarity index 100% rename from src/sdk/android/3/controllers/role/save/snippets/save-1.java rename to src/sdk/android/3/core-classes/role/save/snippets/save-1.java diff --git a/src/sdk/android/3/controllers/role/set-content/index.md b/src/sdk/android/3/core-classes/role/set-content/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/set-content/index.md rename to src/sdk/android/3/core-classes/role/set-content/index.md diff --git a/src/sdk/android/3/controllers/role/set-content/snippets/set-content-1.java b/src/sdk/android/3/core-classes/role/set-content/snippets/set-content-1.java similarity index 100% rename from src/sdk/android/3/controllers/role/set-content/snippets/set-content-1.java rename to src/sdk/android/3/core-classes/role/set-content/snippets/set-content-1.java diff --git a/src/sdk/android/3/controllers/role/update/index.md b/src/sdk/android/3/core-classes/role/update/index.md similarity index 100% rename from src/sdk/android/3/controllers/role/update/index.md rename to src/sdk/android/3/core-classes/role/update/index.md diff --git a/src/sdk/android/3/controllers/role/update/snippets/update-1.java b/src/sdk/android/3/core-classes/role/update/snippets/update-1.java similarity index 100% rename from src/sdk/android/3/controllers/role/update/snippets/update-1.java rename to src/sdk/android/3/core-classes/role/update/snippets/update-1.java diff --git a/src/sdk/android/3/controllers/room/constructor/index.md b/src/sdk/android/3/core-classes/room/constructor/index.md similarity index 79% rename from src/sdk/android/3/controllers/room/constructor/index.md rename to src/sdk/android/3/core-classes/room/constructor/index.md index e64aa5859..dc14a62ee 100644 --- a/src/sdk/android/3/controllers/room/constructor/index.md +++ b/src/sdk/android/3/core-classes/room/constructor/index.md @@ -26,10 +26,10 @@ The `Room` object is the result of a subscription request, allowing you to manip | Option | Type | Description | Default | | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `volatile` | JSON Object | Additional information passed to notifications to other users | `null` | -| `scope` | string | Filter [document notifications](/sdk/android/3/essentials/notifications/#document-notification) depending on their scope status. You may receive entering documents (scope: `in`), leaving documents (scope: `out`), all documents changes (scope: `all`) or filter these notifications completely (scope: `none`). This filter does not affect pub/sub messages or user events. | `all` | -| `state` | string | Filter [document notifications](/sdk/android/3/essentials/notifications/#document-notification) depending on the state of the modifying request. You may receive real-time notifications when a document is about to be changed (state: `pending`), or be notified when the change has been fully written in the database (state: `done`), or both (state: `all`). This filter does not affect pub/sub messages or user events. | `done` | +| `scope` | string | Filter [document notifications](/sdk/android/3/essentials/realtime-notifications/#document-notification) depending on their scope status. You may receive entering documents (scope: `in`), leaving documents (scope: `out`), all documents changes (scope: `all`) or filter these notifications completely (scope: `none`). This filter does not affect pub/sub messages or user events. | `all` | +| `state` | string | Filter [document notifications](/sdk/android/3/essentials/realtime-notifications/#document-notification) depending on the state of the modifying request. You may receive real-time notifications when a document is about to be changed (state: `pending`), or be notified when the change has been fully written in the database (state: `done`), or both (state: `all`). This filter does not affect pub/sub messages or user events. | `done` | | `subscribeToSelf` | boolean | (Don't) subscribe to notifications fired as a consequence of our own queries | `true` | -| `users` | string | Filter [user notifications](/sdk/android/3/essentials/notifications/#user-notification) triggered upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | +| `users` | string | Filter [user notifications](/sdk/android/3/essentials/realtime-notifications/#user-notification) triggered upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | --- diff --git a/src/sdk/android/3/controllers/room/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/room/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/room/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/room/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/room/count/index.md b/src/sdk/android/3/core-classes/room/count/index.md similarity index 100% rename from src/sdk/android/3/controllers/room/count/index.md rename to src/sdk/android/3/core-classes/room/count/index.md diff --git a/src/sdk/android/3/controllers/room/count/snippets/count-1.java b/src/sdk/android/3/core-classes/room/count/snippets/count-1.java similarity index 100% rename from src/sdk/android/3/controllers/room/count/snippets/count-1.java rename to src/sdk/android/3/core-classes/room/count/snippets/count-1.java diff --git a/src/sdk/android/3/controllers/room/index.md b/src/sdk/android/3/core-classes/room/index.md similarity index 100% rename from src/sdk/android/3/controllers/room/index.md rename to src/sdk/android/3/core-classes/room/index.md diff --git a/src/sdk/android/3/controllers/room/renew/index.md b/src/sdk/android/3/core-classes/room/renew/index.md similarity index 92% rename from src/sdk/android/3/controllers/room/renew/index.md rename to src/sdk/android/3/core-classes/room/renew/index.md index e8939d87d..05f98e81f 100644 --- a/src/sdk/android/3/controllers/room/renew/index.md +++ b/src/sdk/android/3/core-classes/room/renew/index.md @@ -18,7 +18,7 @@ Unsubscribes first if this `Room` object was already listening to events. | Arguments | Type | Description | | ---------------------- | ----------- | ------------------------------------------------------------------------------------------------ | | `filters` | JSON Object | [Filters](/core/1/koncorde) | -| `notificationCallback` | function | Function called each time a [notification](/sdk/android/3/essentials/notifications/) is received | +| `notificationCallback` | function | Function called each time a [notification](/sdk/android/3/essentials/realtime-notifications/) is received | | `subscriptionCallback` | function | Function called with the subscription result | ## Usage diff --git a/src/sdk/android/3/controllers/room/renew/snippets/renew-1.java b/src/sdk/android/3/core-classes/room/renew/snippets/renew-1.java similarity index 100% rename from src/sdk/android/3/controllers/room/renew/snippets/renew-1.java rename to src/sdk/android/3/core-classes/room/renew/snippets/renew-1.java diff --git a/src/sdk/android/3/controllers/room/set-headers/index.md b/src/sdk/android/3/core-classes/room/set-headers/index.md similarity index 100% rename from src/sdk/android/3/controllers/room/set-headers/index.md rename to src/sdk/android/3/core-classes/room/set-headers/index.md diff --git a/src/sdk/android/3/controllers/room/set-headers/snippets/set-headers-1.java b/src/sdk/android/3/core-classes/room/set-headers/snippets/set-headers-1.java similarity index 100% rename from src/sdk/android/3/controllers/room/set-headers/snippets/set-headers-1.java rename to src/sdk/android/3/core-classes/room/set-headers/snippets/set-headers-1.java diff --git a/src/sdk/android/3/controllers/room/unsubscribe/index.md b/src/sdk/android/3/core-classes/room/unsubscribe/index.md similarity index 100% rename from src/sdk/android/3/controllers/room/unsubscribe/index.md rename to src/sdk/android/3/core-classes/room/unsubscribe/index.md diff --git a/src/sdk/android/3/controllers/room/unsubscribe/snippets/unsubscribe-1.java b/src/sdk/android/3/core-classes/room/unsubscribe/snippets/unsubscribe-1.java similarity index 100% rename from src/sdk/android/3/controllers/room/unsubscribe/snippets/unsubscribe-1.java rename to src/sdk/android/3/core-classes/room/unsubscribe/snippets/unsubscribe-1.java diff --git a/src/sdk/android/3/controllers/search-result/constructor/index.md b/src/sdk/android/3/core-classes/search-result/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/search-result/constructor/index.md rename to src/sdk/android/3/core-classes/search-result/constructor/index.md diff --git a/src/sdk/android/3/controllers/search-result/fetch-next/index.md b/src/sdk/android/3/core-classes/search-result/fetch-next/index.md similarity index 100% rename from src/sdk/android/3/controllers/search-result/fetch-next/index.md rename to src/sdk/android/3/core-classes/search-result/fetch-next/index.md diff --git a/src/sdk/android/3/controllers/search-result/fetch-next/snippets/fetch-next-1.java b/src/sdk/android/3/core-classes/search-result/fetch-next/snippets/fetch-next-1.java similarity index 100% rename from src/sdk/android/3/controllers/search-result/fetch-next/snippets/fetch-next-1.java rename to src/sdk/android/3/core-classes/search-result/fetch-next/snippets/fetch-next-1.java diff --git a/src/sdk/android/3/controllers/search-result/fetch-next/snippets/fetch-next-2.java b/src/sdk/android/3/core-classes/search-result/fetch-next/snippets/fetch-next-2.java similarity index 100% rename from src/sdk/android/3/controllers/search-result/fetch-next/snippets/fetch-next-2.java rename to src/sdk/android/3/core-classes/search-result/fetch-next/snippets/fetch-next-2.java diff --git a/src/sdk/android/3/controllers/search-result/index.md b/src/sdk/android/3/core-classes/search-result/index.md similarity index 100% rename from src/sdk/android/3/controllers/search-result/index.md rename to src/sdk/android/3/core-classes/search-result/index.md diff --git a/src/sdk/android/3/controllers/security/constructor/index.md b/src/sdk/android/3/core-classes/security/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/constructor/index.md rename to src/sdk/android/3/core-classes/security/constructor/index.md diff --git a/src/sdk/android/3/controllers/security/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/security/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/security/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/security/create-credentials/index.md b/src/sdk/android/3/core-classes/security/create-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/create-credentials/index.md rename to src/sdk/android/3/core-classes/security/create-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/create-credentials/snippets/create-credentials-1.java b/src/sdk/android/3/core-classes/security/create-credentials/snippets/create-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/create-credentials/snippets/create-credentials-1.java rename to src/sdk/android/3/core-classes/security/create-credentials/snippets/create-credentials-1.java diff --git a/src/sdk/android/3/controllers/security/create-profile/index.md b/src/sdk/android/3/core-classes/security/create-profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/create-profile/index.md rename to src/sdk/android/3/core-classes/security/create-profile/index.md diff --git a/src/sdk/android/3/controllers/security/create-profile/snippets/create-profile-1.java b/src/sdk/android/3/core-classes/security/create-profile/snippets/create-profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/create-profile/snippets/create-profile-1.java rename to src/sdk/android/3/core-classes/security/create-profile/snippets/create-profile-1.java diff --git a/src/sdk/android/3/controllers/security/create-restricted-user/index.md b/src/sdk/android/3/core-classes/security/create-restricted-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/create-restricted-user/index.md rename to src/sdk/android/3/core-classes/security/create-restricted-user/index.md diff --git a/src/sdk/android/3/controllers/security/create-restricted-user/snippets/create-restricted-user-1.java b/src/sdk/android/3/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/create-restricted-user/snippets/create-restricted-user-1.java rename to src/sdk/android/3/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.java diff --git a/src/sdk/android/3/controllers/security/create-role/index.md b/src/sdk/android/3/core-classes/security/create-role/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/create-role/index.md rename to src/sdk/android/3/core-classes/security/create-role/index.md diff --git a/src/sdk/android/3/controllers/security/create-role/snippets/create-role-1.java b/src/sdk/android/3/core-classes/security/create-role/snippets/create-role-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/create-role/snippets/create-role-1.java rename to src/sdk/android/3/core-classes/security/create-role/snippets/create-role-1.java diff --git a/src/sdk/android/3/controllers/security/create-user/index.md b/src/sdk/android/3/core-classes/security/create-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/create-user/index.md rename to src/sdk/android/3/core-classes/security/create-user/index.md diff --git a/src/sdk/android/3/controllers/security/create-user/snippets/create-user-1.java b/src/sdk/android/3/core-classes/security/create-user/snippets/create-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/create-user/snippets/create-user-1.java rename to src/sdk/android/3/core-classes/security/create-user/snippets/create-user-1.java diff --git a/src/sdk/android/3/controllers/security/delete-credentials/index.md b/src/sdk/android/3/core-classes/security/delete-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/delete-credentials/index.md rename to src/sdk/android/3/core-classes/security/delete-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/delete-credentials/snippets/delete-credentials-1.java b/src/sdk/android/3/core-classes/security/delete-credentials/snippets/delete-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/delete-credentials/snippets/delete-credentials-1.java rename to src/sdk/android/3/core-classes/security/delete-credentials/snippets/delete-credentials-1.java diff --git a/src/sdk/android/3/controllers/security/delete-profile/index.md b/src/sdk/android/3/core-classes/security/delete-profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/delete-profile/index.md rename to src/sdk/android/3/core-classes/security/delete-profile/index.md diff --git a/src/sdk/android/3/controllers/security/delete-profile/snippets/delete-profile-1.java b/src/sdk/android/3/core-classes/security/delete-profile/snippets/delete-profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/delete-profile/snippets/delete-profile-1.java rename to src/sdk/android/3/core-classes/security/delete-profile/snippets/delete-profile-1.java diff --git a/src/sdk/android/3/controllers/security/delete-role/index.md b/src/sdk/android/3/core-classes/security/delete-role/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/delete-role/index.md rename to src/sdk/android/3/core-classes/security/delete-role/index.md diff --git a/src/sdk/android/3/controllers/security/delete-role/snippets/delete-role-1.java b/src/sdk/android/3/core-classes/security/delete-role/snippets/delete-role-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/delete-role/snippets/delete-role-1.java rename to src/sdk/android/3/core-classes/security/delete-role/snippets/delete-role-1.java diff --git a/src/sdk/android/3/controllers/security/delete-user/index.md b/src/sdk/android/3/core-classes/security/delete-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/delete-user/index.md rename to src/sdk/android/3/core-classes/security/delete-user/index.md diff --git a/src/sdk/android/3/controllers/security/delete-user/snippets/delete-user-1.java b/src/sdk/android/3/core-classes/security/delete-user/snippets/delete-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/delete-user/snippets/delete-user-1.java rename to src/sdk/android/3/core-classes/security/delete-user/snippets/delete-user-1.java diff --git a/src/sdk/android/3/controllers/security/fetch-profile/index.md b/src/sdk/android/3/core-classes/security/fetch-profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-profile/index.md rename to src/sdk/android/3/core-classes/security/fetch-profile/index.md diff --git a/src/sdk/android/3/controllers/security/fetch-profile/snippets/fetch-profile-1.java b/src/sdk/android/3/core-classes/security/fetch-profile/snippets/fetch-profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-profile/snippets/fetch-profile-1.java rename to src/sdk/android/3/core-classes/security/fetch-profile/snippets/fetch-profile-1.java diff --git a/src/sdk/android/3/controllers/security/fetch-role/index.md b/src/sdk/android/3/core-classes/security/fetch-role/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-role/index.md rename to src/sdk/android/3/core-classes/security/fetch-role/index.md diff --git a/src/sdk/android/3/controllers/security/fetch-role/snippets/fetch-role-1.java b/src/sdk/android/3/core-classes/security/fetch-role/snippets/fetch-role-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-role/snippets/fetch-role-1.java rename to src/sdk/android/3/core-classes/security/fetch-role/snippets/fetch-role-1.java diff --git a/src/sdk/android/3/controllers/security/fetch-user/index.md b/src/sdk/android/3/core-classes/security/fetch-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-user/index.md rename to src/sdk/android/3/core-classes/security/fetch-user/index.md diff --git a/src/sdk/android/3/controllers/security/fetch-user/snippets/fetch-user-1.java b/src/sdk/android/3/core-classes/security/fetch-user/snippets/fetch-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/fetch-user/snippets/fetch-user-1.java rename to src/sdk/android/3/core-classes/security/fetch-user/snippets/fetch-user-1.java diff --git a/src/sdk/android/3/controllers/security/get-all-credential-fields/index.md b/src/sdk/android/3/core-classes/security/get-all-credential-fields/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/get-all-credential-fields/index.md rename to src/sdk/android/3/core-classes/security/get-all-credential-fields/index.md diff --git a/src/sdk/android/3/controllers/security/get-all-credential-fields/snippets/get-all-credential-fields-1.java b/src/sdk/android/3/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/get-all-credential-fields/snippets/get-all-credential-fields-1.java rename to src/sdk/android/3/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.java diff --git a/src/sdk/android/3/controllers/security/get-credentials-fields/index.md b/src/sdk/android/3/core-classes/security/get-credentials-fields/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/get-credentials-fields/index.md rename to src/sdk/android/3/core-classes/security/get-credentials-fields/index.md diff --git a/src/sdk/android/3/controllers/security/get-credentials-fields/snippets/get-credentials-fields-1.java b/src/sdk/android/3/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/get-credentials-fields/snippets/get-credentials-fields-1.java rename to src/sdk/android/3/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.java diff --git a/src/sdk/android/3/controllers/security/get-credentials/index.md b/src/sdk/android/3/core-classes/security/get-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/get-credentials/index.md rename to src/sdk/android/3/core-classes/security/get-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/get-credentials/snippets/get-credentials-1.java b/src/sdk/android/3/core-classes/security/get-credentials/snippets/get-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/get-credentials/snippets/get-credentials-1.java rename to src/sdk/android/3/core-classes/security/get-credentials/snippets/get-credentials-1.java diff --git a/src/sdk/android/3/controllers/security/get-user-rights/index.md b/src/sdk/android/3/core-classes/security/get-user-rights/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/get-user-rights/index.md rename to src/sdk/android/3/core-classes/security/get-user-rights/index.md diff --git a/src/sdk/android/3/controllers/security/get-user-rights/snippets/get-user-rights-1.java b/src/sdk/android/3/core-classes/security/get-user-rights/snippets/get-user-rights-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/get-user-rights/snippets/get-user-rights-1.java rename to src/sdk/android/3/core-classes/security/get-user-rights/snippets/get-user-rights-1.java diff --git a/src/sdk/android/3/controllers/security/has-credentials/index.md b/src/sdk/android/3/core-classes/security/has-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/has-credentials/index.md rename to src/sdk/android/3/core-classes/security/has-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/has-credentials/snippets/has-credentials-1.java b/src/sdk/android/3/core-classes/security/has-credentials/snippets/has-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/has-credentials/snippets/has-credentials-1.java rename to src/sdk/android/3/core-classes/security/has-credentials/snippets/has-credentials-1.java diff --git a/src/sdk/android/3/controllers/security/index.md b/src/sdk/android/3/core-classes/security/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/index.md rename to src/sdk/android/3/core-classes/security/index.md diff --git a/src/sdk/android/3/controllers/security/is-action-allowed/index.md b/src/sdk/android/3/core-classes/security/is-action-allowed/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/is-action-allowed/index.md rename to src/sdk/android/3/core-classes/security/is-action-allowed/index.md diff --git a/src/sdk/android/3/controllers/security/is-action-allowed/snippets/is-action-allowed-1.java b/src/sdk/android/3/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/is-action-allowed/snippets/is-action-allowed-1.java rename to src/sdk/android/3/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.java diff --git a/src/sdk/android/3/controllers/security/profile/index.md b/src/sdk/android/3/core-classes/security/profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/profile/index.md rename to src/sdk/android/3/core-classes/security/profile/index.md diff --git a/src/sdk/android/3/controllers/security/profile/snippets/profile-1.java b/src/sdk/android/3/core-classes/security/profile/snippets/profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/profile/snippets/profile-1.java rename to src/sdk/android/3/core-classes/security/profile/snippets/profile-1.java diff --git a/src/sdk/android/3/controllers/security/replace-user/index.md b/src/sdk/android/3/core-classes/security/replace-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/replace-user/index.md rename to src/sdk/android/3/core-classes/security/replace-user/index.md diff --git a/src/sdk/android/3/controllers/security/replace-user/snippets/replace-user-1.java b/src/sdk/android/3/core-classes/security/replace-user/snippets/replace-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/replace-user/snippets/replace-user-1.java rename to src/sdk/android/3/core-classes/security/replace-user/snippets/replace-user-1.java diff --git a/src/sdk/android/3/controllers/security/role/index.md b/src/sdk/android/3/core-classes/security/role/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/role/index.md rename to src/sdk/android/3/core-classes/security/role/index.md diff --git a/src/sdk/android/3/controllers/security/role/snippets/role-1.java b/src/sdk/android/3/core-classes/security/role/snippets/role-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/role/snippets/role-1.java rename to src/sdk/android/3/core-classes/security/role/snippets/role-1.java diff --git a/src/sdk/android/3/controllers/security/scroll-profiles/index.md b/src/sdk/android/3/core-classes/security/scroll-profiles/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/scroll-profiles/index.md rename to src/sdk/android/3/core-classes/security/scroll-profiles/index.md diff --git a/src/sdk/android/3/controllers/security/scroll-profiles/snippets/scroll-profiles-1.java b/src/sdk/android/3/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/scroll-profiles/snippets/scroll-profiles-1.java rename to src/sdk/android/3/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.java diff --git a/src/sdk/android/3/controllers/security/scroll-users/index.md b/src/sdk/android/3/core-classes/security/scroll-users/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/scroll-users/index.md rename to src/sdk/android/3/core-classes/security/scroll-users/index.md diff --git a/src/sdk/android/3/controllers/security/scroll-users/snippets/scroll-users-1.java b/src/sdk/android/3/core-classes/security/scroll-users/snippets/scroll-users-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/scroll-users/snippets/scroll-users-1.java rename to src/sdk/android/3/core-classes/security/scroll-users/snippets/scroll-users-1.java diff --git a/src/sdk/android/3/controllers/security/search-profiles/index.md b/src/sdk/android/3/core-classes/security/search-profiles/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/search-profiles/index.md rename to src/sdk/android/3/core-classes/security/search-profiles/index.md diff --git a/src/sdk/android/3/controllers/security/search-profiles/snippets/search-profiles-1.java b/src/sdk/android/3/core-classes/security/search-profiles/snippets/search-profiles-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/search-profiles/snippets/search-profiles-1.java rename to src/sdk/android/3/core-classes/security/search-profiles/snippets/search-profiles-1.java diff --git a/src/sdk/android/3/controllers/security/search-roles/index.md b/src/sdk/android/3/core-classes/security/search-roles/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/search-roles/index.md rename to src/sdk/android/3/core-classes/security/search-roles/index.md diff --git a/src/sdk/android/3/controllers/security/search-roles/snippets/search-roles-1.java b/src/sdk/android/3/core-classes/security/search-roles/snippets/search-roles-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/search-roles/snippets/search-roles-1.java rename to src/sdk/android/3/core-classes/security/search-roles/snippets/search-roles-1.java diff --git a/src/sdk/android/3/controllers/security/search-users/index.md b/src/sdk/android/3/core-classes/security/search-users/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/search-users/index.md rename to src/sdk/android/3/core-classes/security/search-users/index.md diff --git a/src/sdk/android/3/controllers/security/search-users/snippets/search-users-1.java b/src/sdk/android/3/core-classes/security/search-users/snippets/search-users-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/search-users/snippets/search-users-1.java rename to src/sdk/android/3/core-classes/security/search-users/snippets/search-users-1.java diff --git a/src/sdk/android/3/controllers/security/update-credentials/index.md b/src/sdk/android/3/core-classes/security/update-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/update-credentials/index.md rename to src/sdk/android/3/core-classes/security/update-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/update-credentials/snippets/update-credentials-1.java b/src/sdk/android/3/core-classes/security/update-credentials/snippets/update-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/update-credentials/snippets/update-credentials-1.java rename to src/sdk/android/3/core-classes/security/update-credentials/snippets/update-credentials-1.java diff --git a/src/sdk/android/3/controllers/security/update-profile/index.md b/src/sdk/android/3/core-classes/security/update-profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/update-profile/index.md rename to src/sdk/android/3/core-classes/security/update-profile/index.md diff --git a/src/sdk/android/3/controllers/security/update-profile/snippets/update-profile-1.java b/src/sdk/android/3/core-classes/security/update-profile/snippets/update-profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/update-profile/snippets/update-profile-1.java rename to src/sdk/android/3/core-classes/security/update-profile/snippets/update-profile-1.java diff --git a/src/sdk/android/3/controllers/security/update-role/index.md b/src/sdk/android/3/core-classes/security/update-role/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/update-role/index.md rename to src/sdk/android/3/core-classes/security/update-role/index.md diff --git a/src/sdk/android/3/controllers/security/update-role/snippets/update-role-1.java b/src/sdk/android/3/core-classes/security/update-role/snippets/update-role-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/update-role/snippets/update-role-1.java rename to src/sdk/android/3/core-classes/security/update-role/snippets/update-role-1.java diff --git a/src/sdk/android/3/controllers/security/update-user/index.md b/src/sdk/android/3/core-classes/security/update-user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/update-user/index.md rename to src/sdk/android/3/core-classes/security/update-user/index.md diff --git a/src/sdk/android/3/controllers/security/update-user/snippets/update-user-1.java b/src/sdk/android/3/core-classes/security/update-user/snippets/update-user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/update-user/snippets/update-user-1.java rename to src/sdk/android/3/core-classes/security/update-user/snippets/update-user-1.java diff --git a/src/sdk/android/3/controllers/security/user/index.md b/src/sdk/android/3/core-classes/security/user/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/user/index.md rename to src/sdk/android/3/core-classes/security/user/index.md diff --git a/src/sdk/android/3/controllers/security/user/snippets/user-1.java b/src/sdk/android/3/core-classes/security/user/snippets/user-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/user/snippets/user-1.java rename to src/sdk/android/3/core-classes/security/user/snippets/user-1.java diff --git a/src/sdk/android/3/controllers/security/validate-credentials/index.md b/src/sdk/android/3/core-classes/security/validate-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/security/validate-credentials/index.md rename to src/sdk/android/3/core-classes/security/validate-credentials/index.md diff --git a/src/sdk/android/3/controllers/security/validate-credentials/snippets/validate-credentials-1.java b/src/sdk/android/3/core-classes/security/validate-credentials/snippets/validate-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/security/validate-credentials/snippets/validate-credentials-1.java rename to src/sdk/android/3/core-classes/security/validate-credentials/snippets/validate-credentials-1.java diff --git a/src/sdk/android/3/controllers/user/add-profile/index.md b/src/sdk/android/3/core-classes/user/add-profile/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/add-profile/index.md rename to src/sdk/android/3/core-classes/user/add-profile/index.md diff --git a/src/sdk/android/3/controllers/user/add-profile/snippets/add-profile-1.java b/src/sdk/android/3/core-classes/user/add-profile/snippets/add-profile-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/add-profile/snippets/add-profile-1.java rename to src/sdk/android/3/core-classes/user/add-profile/snippets/add-profile-1.java diff --git a/src/sdk/android/3/controllers/user/constructor/index.md b/src/sdk/android/3/core-classes/user/constructor/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/constructor/index.md rename to src/sdk/android/3/core-classes/user/constructor/index.md diff --git a/src/sdk/android/3/controllers/user/constructor/snippets/constructor-1.java b/src/sdk/android/3/core-classes/user/constructor/snippets/constructor-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/constructor/snippets/constructor-1.java rename to src/sdk/android/3/core-classes/user/constructor/snippets/constructor-1.java diff --git a/src/sdk/android/3/controllers/user/create/index.md b/src/sdk/android/3/core-classes/user/create/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/create/index.md rename to src/sdk/android/3/core-classes/user/create/index.md diff --git a/src/sdk/android/3/controllers/user/create/snippets/create-1.java b/src/sdk/android/3/core-classes/user/create/snippets/create-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/create/snippets/create-1.java rename to src/sdk/android/3/core-classes/user/create/snippets/create-1.java diff --git a/src/sdk/android/3/controllers/user/delete/index.md b/src/sdk/android/3/core-classes/user/delete/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/delete/index.md rename to src/sdk/android/3/core-classes/user/delete/index.md diff --git a/src/sdk/android/3/controllers/user/delete/snippets/delete-1.java b/src/sdk/android/3/core-classes/user/delete/snippets/delete-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/delete/snippets/delete-1.java rename to src/sdk/android/3/core-classes/user/delete/snippets/delete-1.java diff --git a/src/sdk/android/3/controllers/user/get-profileids/index.md b/src/sdk/android/3/core-classes/user/get-profileids/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/get-profileids/index.md rename to src/sdk/android/3/core-classes/user/get-profileids/index.md diff --git a/src/sdk/android/3/controllers/user/get-profileids/snippets/get-profileids-1.java b/src/sdk/android/3/core-classes/user/get-profileids/snippets/get-profileids-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/get-profileids/snippets/get-profileids-1.java rename to src/sdk/android/3/core-classes/user/get-profileids/snippets/get-profileids-1.java diff --git a/src/sdk/android/3/controllers/user/get-profiles/index.md b/src/sdk/android/3/core-classes/user/get-profiles/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/get-profiles/index.md rename to src/sdk/android/3/core-classes/user/get-profiles/index.md diff --git a/src/sdk/android/3/controllers/user/get-profiles/snippets/get-profiles-1.java b/src/sdk/android/3/core-classes/user/get-profiles/snippets/get-profiles-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/get-profiles/snippets/get-profiles-1.java rename to src/sdk/android/3/core-classes/user/get-profiles/snippets/get-profiles-1.java diff --git a/src/sdk/android/3/controllers/user/index.md b/src/sdk/android/3/core-classes/user/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/index.md rename to src/sdk/android/3/core-classes/user/index.md diff --git a/src/sdk/android/3/controllers/user/replace/index.md b/src/sdk/android/3/core-classes/user/replace/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/replace/index.md rename to src/sdk/android/3/core-classes/user/replace/index.md diff --git a/src/sdk/android/3/controllers/user/replace/snippets/replace-1.java b/src/sdk/android/3/core-classes/user/replace/snippets/replace-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/replace/snippets/replace-1.java rename to src/sdk/android/3/core-classes/user/replace/snippets/replace-1.java diff --git a/src/sdk/android/3/controllers/user/save-restricted/index.md b/src/sdk/android/3/core-classes/user/save-restricted/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/save-restricted/index.md rename to src/sdk/android/3/core-classes/user/save-restricted/index.md diff --git a/src/sdk/android/3/controllers/user/save-restricted/snippets/save-restricted-1.java b/src/sdk/android/3/core-classes/user/save-restricted/snippets/save-restricted-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/save-restricted/snippets/save-restricted-1.java rename to src/sdk/android/3/core-classes/user/save-restricted/snippets/save-restricted-1.java diff --git a/src/sdk/android/3/controllers/user/save/index.md b/src/sdk/android/3/core-classes/user/save/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/save/index.md rename to src/sdk/android/3/core-classes/user/save/index.md diff --git a/src/sdk/android/3/controllers/user/save/snippets/save-1.java b/src/sdk/android/3/core-classes/user/save/snippets/save-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/save/snippets/save-1.java rename to src/sdk/android/3/core-classes/user/save/snippets/save-1.java diff --git a/src/sdk/android/3/controllers/user/set-content/index.md b/src/sdk/android/3/core-classes/user/set-content/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/set-content/index.md rename to src/sdk/android/3/core-classes/user/set-content/index.md diff --git a/src/sdk/android/3/controllers/user/set-content/snippets/set-content-1.java b/src/sdk/android/3/core-classes/user/set-content/snippets/set-content-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/set-content/snippets/set-content-1.java rename to src/sdk/android/3/core-classes/user/set-content/snippets/set-content-1.java diff --git a/src/sdk/android/3/controllers/user/set-credentials/index.md b/src/sdk/android/3/core-classes/user/set-credentials/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/set-credentials/index.md rename to src/sdk/android/3/core-classes/user/set-credentials/index.md diff --git a/src/sdk/android/3/controllers/user/set-credentials/snippets/set-credentials-1.java b/src/sdk/android/3/core-classes/user/set-credentials/snippets/set-credentials-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/set-credentials/snippets/set-credentials-1.java rename to src/sdk/android/3/core-classes/user/set-credentials/snippets/set-credentials-1.java diff --git a/src/sdk/android/3/controllers/user/set-profiles/index.md b/src/sdk/android/3/core-classes/user/set-profiles/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/set-profiles/index.md rename to src/sdk/android/3/core-classes/user/set-profiles/index.md diff --git a/src/sdk/android/3/controllers/user/set-profiles/snippets/set-profiles-1.java b/src/sdk/android/3/core-classes/user/set-profiles/snippets/set-profiles-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/set-profiles/snippets/set-profiles-1.java rename to src/sdk/android/3/core-classes/user/set-profiles/snippets/set-profiles-1.java diff --git a/src/sdk/android/3/controllers/user/update/index.md b/src/sdk/android/3/core-classes/user/update/index.md similarity index 100% rename from src/sdk/android/3/controllers/user/update/index.md rename to src/sdk/android/3/core-classes/user/update/index.md diff --git a/src/sdk/android/3/controllers/user/update/snippets/update-1.java b/src/sdk/android/3/core-classes/user/update/snippets/update-1.java similarity index 100% rename from src/sdk/android/3/controllers/user/update/snippets/update-1.java rename to src/sdk/android/3/core-classes/user/update/snippets/update-1.java diff --git a/src/sdk/android/3/essentials/handling-errors/index.md b/src/sdk/android/3/essentials/error-handling/index.md similarity index 100% rename from src/sdk/android/3/essentials/handling-errors/index.md rename to src/sdk/android/3/essentials/error-handling/index.md diff --git a/src/sdk/android/3/essentials/handling-errors/snippets/handling-errors-1.java b/src/sdk/android/3/essentials/error-handling/snippets/handling-errors-1.java similarity index 100% rename from src/sdk/android/3/essentials/handling-errors/snippets/handling-errors-1.java rename to src/sdk/android/3/essentials/error-handling/snippets/handling-errors-1.java diff --git a/src/sdk/android/3/essentials/offline-first/index.md b/src/sdk/android/3/essentials/offline-tools/index.md similarity index 98% rename from src/sdk/android/3/essentials/offline-first/index.md rename to src/sdk/android/3/essentials/offline-tools/index.md index 46496a7ee..b4a19c5fe 100644 --- a/src/sdk/android/3/essentials/offline-first/index.md +++ b/src/sdk/android/3/essentials/offline-tools/index.md @@ -1,11 +1,11 @@ --- code: false type: page -title: Offline First +title: Offline Tools order: 300 --- -# Offline First +# Offline Tools When using an unstable network connection, an application must maintain a normal behavior when it is disconnected. Our goal is to provide the right toolkit to handle such situations. @@ -32,7 +32,7 @@ While in offline mode, the Kuzzle SDK client maintains all subscriptions configu ## API Requests -While in offline mode, API requests can be queued, and then executed once the network connection has been reestablished. +While in offline mode, API requests can be queued, and then executed once the network connection has been reestablished. By default, there is no request queuing. - Queue all requests automatically when going offline by setting the `autoQueue` option to `true` (see [Kuzzle SDK constructor](/sdk/android/3/core-classes/kuzzle/)) @@ -76,7 +76,7 @@ The `offlineQueuePush` event is fired whenever a request is queued. It will emit The `offlineQueuePop` event is fired whenever a request has been removed from the queue, either because the queue limits have been reached, or because the request has been replayed. It provides the removed request to its listeners. -The `offlineQueueLoader` property of the Kuzzle SDK instance loads requests to the queue, **before any previously queued request**. It is invoked every time the Kuzzle SDK starts dequeuing requests. +The `offlineQueueLoader` property of the Kuzzle SDK instance loads requests to the queue, **before any previously queued request**. It is invoked every time the Kuzzle SDK starts dequeuing requests. This property must be set with a function that returns an array of objects with the following accessible properties: - a `query` property, containing the request to be replayed diff --git a/src/sdk/android/3/essentials/notifications/index.md b/src/sdk/android/3/essentials/realtime-notifications/index.md similarity index 98% rename from src/sdk/android/3/essentials/notifications/index.md rename to src/sdk/android/3/essentials/realtime-notifications/index.md index 568fba8ea..86972ba1d 100644 --- a/src/sdk/android/3/essentials/notifications/index.md +++ b/src/sdk/android/3/essentials/realtime-notifications/index.md @@ -1,11 +1,11 @@ --- code: false type: page -title: Notifications +title: Realtime Notifications order: 300 --- -# Notifications +# Realtime Notifications With Kuzzle, you don't [subscribe](/sdk/android/3/controllers/collection/subscribe/) to a room or a topic but, instead, you subscribe to documents. This means, that when you want to subscribe you must provide a set of filter definitions, using [Koncorde](/core/1/koncorde), that tell Kuzzle what documents should trigger a notification. Then, any time a document matches the defined filters, Kuzzle will send a notification to the subscriber. diff --git a/src/sdk/cpp/1/controllers/auth/login/index.md b/src/sdk/cpp/1/controllers/auth/login/index.md index 8d87541c1..87aa926e1 100644 --- a/src/sdk/cpp/1/controllers/auth/login/index.md +++ b/src/sdk/cpp/1/controllers/auth/login/index.md @@ -34,10 +34,10 @@ std::string login( The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example on this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn @@ -47,7 +47,7 @@ The default value for the `expiresIn` option is defined at server level, in Kuzz ## Return -Returns the encrypted JSON Web Token. +Returns the encrypted JSON Web Token. Once `auth:login` has been called, the returned JWT is stored by the SDK and used for all the subsequent API call, ensuring they are properly authenticated. ## Exceptions diff --git a/src/sdk/go/1/controllers/auth/login/index.md b/src/sdk/go/1/controllers/auth/login/index.md index 6ac9dad7d..b70ccf0ae 100644 --- a/src/sdk/go/1/controllers/auth/login/index.md +++ b/src/sdk/go/1/controllers/auth/login/index.md @@ -31,10 +31,10 @@ func (a *Auth) Login( The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/). diff --git a/src/sdk/go/1/core-structs/protocols/http/index.md b/src/sdk/go/1/protocols/http/index.md similarity index 100% rename from src/sdk/go/1/core-structs/protocols/http/index.md rename to src/sdk/go/1/protocols/http/index.md diff --git a/src/sdk/go/1/core-structs/protocols/index.md b/src/sdk/go/1/protocols/index.md similarity index 83% rename from src/sdk/go/1/core-structs/protocols/index.md rename to src/sdk/go/1/protocols/index.md index 3df694ea5..f53019352 100644 --- a/src/sdk/go/1/core-structs/protocols/index.md +++ b/src/sdk/go/1/protocols/index.md @@ -1,7 +1,7 @@ --- code: true type: branch -title: Protocol +title: Protocols description: Protocol objects documentation order: 500 --- diff --git a/src/sdk/go/1/core-structs/protocols/socketio/index.md b/src/sdk/go/1/protocols/socketio/index.md similarity index 100% rename from src/sdk/go/1/core-structs/protocols/socketio/index.md rename to src/sdk/go/1/protocols/socketio/index.md diff --git a/src/sdk/go/1/core-structs/protocols/websocket/index.md b/src/sdk/go/1/protocols/websocket/index.md similarity index 100% rename from src/sdk/go/1/core-structs/protocols/websocket/index.md rename to src/sdk/go/1/protocols/websocket/index.md diff --git a/src/sdk/java/1/controllers/auth/login/index.md b/src/sdk/java/1/controllers/auth/login/index.md index 1bad6e191..2fd763ac4 100644 --- a/src/sdk/java/1/controllers/auth/login/index.md +++ b/src/sdk/java/1/controllers/auth/login/index.md @@ -31,10 +31,10 @@ String login(String, String); The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn diff --git a/src/sdk/java/1/core-classes/protocol/http/index.md b/src/sdk/java/1/protocols/http/index.md similarity index 100% rename from src/sdk/java/1/core-classes/protocol/http/index.md rename to src/sdk/java/1/protocols/http/index.md diff --git a/src/sdk/java/1/core-classes/protocol/index.md b/src/sdk/java/1/protocols/index.md similarity index 83% rename from src/sdk/java/1/core-classes/protocol/index.md rename to src/sdk/java/1/protocols/index.md index 3df694ea5..f53019352 100644 --- a/src/sdk/java/1/core-classes/protocol/index.md +++ b/src/sdk/java/1/protocols/index.md @@ -1,7 +1,7 @@ --- code: true type: branch -title: Protocol +title: Protocols description: Protocol objects documentation order: 500 --- diff --git a/src/sdk/java/1/core-classes/protocol/socketio/index.md b/src/sdk/java/1/protocols/socketio/index.md similarity index 100% rename from src/sdk/java/1/core-classes/protocol/socketio/index.md rename to src/sdk/java/1/protocols/socketio/index.md diff --git a/src/sdk/java/1/core-classes/protocol/websocket/index.md b/src/sdk/java/1/protocols/websocket/index.md similarity index 100% rename from src/sdk/java/1/core-classes/protocol/websocket/index.md rename to src/sdk/java/1/protocols/websocket/index.md diff --git a/src/sdk/js/5/collection-mapping/apply/index.md b/src/sdk/js/5/core-classes/collection-mapping/apply/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/apply/index.md rename to src/sdk/js/5/core-classes/collection-mapping/apply/index.md diff --git a/src/sdk/js/5/collection-mapping/apply/snippets/apply-1.js b/src/sdk/js/5/core-classes/collection-mapping/apply/snippets/apply-1.js similarity index 100% rename from src/sdk/js/5/collection-mapping/apply/snippets/apply-1.js rename to src/sdk/js/5/core-classes/collection-mapping/apply/snippets/apply-1.js diff --git a/src/sdk/js/5/collection-mapping/constructor/index.md b/src/sdk/js/5/core-classes/collection-mapping/constructor/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/constructor/index.md rename to src/sdk/js/5/core-classes/collection-mapping/constructor/index.md diff --git a/src/sdk/js/5/collection-mapping/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/collection-mapping/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/collection-mapping/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/collection-mapping/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/collection-mapping/index.md b/src/sdk/js/5/core-classes/collection-mapping/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/index.md rename to src/sdk/js/5/core-classes/collection-mapping/index.md diff --git a/src/sdk/js/5/collection-mapping/refresh/index.md b/src/sdk/js/5/core-classes/collection-mapping/refresh/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/refresh/index.md rename to src/sdk/js/5/core-classes/collection-mapping/refresh/index.md diff --git a/src/sdk/js/5/collection-mapping/refresh/snippets/refresh-1.js b/src/sdk/js/5/core-classes/collection-mapping/refresh/snippets/refresh-1.js similarity index 100% rename from src/sdk/js/5/collection-mapping/refresh/snippets/refresh-1.js rename to src/sdk/js/5/core-classes/collection-mapping/refresh/snippets/refresh-1.js diff --git a/src/sdk/js/5/collection-mapping/set-headers/index.md b/src/sdk/js/5/core-classes/collection-mapping/set-headers/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/set-headers/index.md rename to src/sdk/js/5/core-classes/collection-mapping/set-headers/index.md diff --git a/src/sdk/js/5/collection-mapping/set-headers/snippets/set-headers-1.js b/src/sdk/js/5/core-classes/collection-mapping/set-headers/snippets/set-headers-1.js similarity index 100% rename from src/sdk/js/5/collection-mapping/set-headers/snippets/set-headers-1.js rename to src/sdk/js/5/core-classes/collection-mapping/set-headers/snippets/set-headers-1.js diff --git a/src/sdk/js/5/collection-mapping/set/index.md b/src/sdk/js/5/core-classes/collection-mapping/set/index.md similarity index 100% rename from src/sdk/js/5/collection-mapping/set/index.md rename to src/sdk/js/5/core-classes/collection-mapping/set/index.md diff --git a/src/sdk/js/5/collection-mapping/set/snippets/set-1.js b/src/sdk/js/5/core-classes/collection-mapping/set/snippets/set-1.js similarity index 100% rename from src/sdk/js/5/collection-mapping/set/snippets/set-1.js rename to src/sdk/js/5/core-classes/collection-mapping/set/snippets/set-1.js diff --git a/src/sdk/js/5/collection/collection-mapping/index.md b/src/sdk/js/5/core-classes/collection/collection-mapping/index.md similarity index 100% rename from src/sdk/js/5/collection/collection-mapping/index.md rename to src/sdk/js/5/core-classes/collection/collection-mapping/index.md diff --git a/src/sdk/js/5/collection/collection-mapping/snippets/collection-mapping-1.js b/src/sdk/js/5/core-classes/collection/collection-mapping/snippets/collection-mapping-1.js similarity index 100% rename from src/sdk/js/5/collection/collection-mapping/snippets/collection-mapping-1.js rename to src/sdk/js/5/core-classes/collection/collection-mapping/snippets/collection-mapping-1.js diff --git a/src/sdk/js/5/collection/constructor/index.md b/src/sdk/js/5/core-classes/collection/constructor/index.md similarity index 100% rename from src/sdk/js/5/collection/constructor/index.md rename to src/sdk/js/5/core-classes/collection/constructor/index.md diff --git a/src/sdk/js/5/collection/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/collection/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/collection/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/collection/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/collection/count/index.md b/src/sdk/js/5/core-classes/collection/count/index.md similarity index 100% rename from src/sdk/js/5/collection/count/index.md rename to src/sdk/js/5/core-classes/collection/count/index.md diff --git a/src/sdk/js/5/collection/count/snippets/count-1.js b/src/sdk/js/5/core-classes/collection/count/snippets/count-1.js similarity index 100% rename from src/sdk/js/5/collection/count/snippets/count-1.js rename to src/sdk/js/5/core-classes/collection/count/snippets/count-1.js diff --git a/src/sdk/js/5/collection/count/snippets/count-2.js b/src/sdk/js/5/core-classes/collection/count/snippets/count-2.js similarity index 100% rename from src/sdk/js/5/collection/count/snippets/count-2.js rename to src/sdk/js/5/core-classes/collection/count/snippets/count-2.js diff --git a/src/sdk/js/5/collection/create-document/index.md b/src/sdk/js/5/core-classes/collection/create-document/index.md similarity index 100% rename from src/sdk/js/5/collection/create-document/index.md rename to src/sdk/js/5/core-classes/collection/create-document/index.md diff --git a/src/sdk/js/5/collection/create-document/snippets/create-document-1.js b/src/sdk/js/5/core-classes/collection/create-document/snippets/create-document-1.js similarity index 100% rename from src/sdk/js/5/collection/create-document/snippets/create-document-1.js rename to src/sdk/js/5/core-classes/collection/create-document/snippets/create-document-1.js diff --git a/src/sdk/js/5/collection/create/index.md b/src/sdk/js/5/core-classes/collection/create/index.md similarity index 100% rename from src/sdk/js/5/collection/create/index.md rename to src/sdk/js/5/core-classes/collection/create/index.md diff --git a/src/sdk/js/5/collection/create/snippets/create-1.js b/src/sdk/js/5/core-classes/collection/create/snippets/create-1.js similarity index 100% rename from src/sdk/js/5/collection/create/snippets/create-1.js rename to src/sdk/js/5/core-classes/collection/create/snippets/create-1.js diff --git a/src/sdk/js/5/collection/create/snippets/create-2.js b/src/sdk/js/5/core-classes/collection/create/snippets/create-2.js similarity index 100% rename from src/sdk/js/5/collection/create/snippets/create-2.js rename to src/sdk/js/5/core-classes/collection/create/snippets/create-2.js diff --git a/src/sdk/js/5/collection/delete-document/index.md b/src/sdk/js/5/core-classes/collection/delete-document/index.md similarity index 100% rename from src/sdk/js/5/collection/delete-document/index.md rename to src/sdk/js/5/core-classes/collection/delete-document/index.md diff --git a/src/sdk/js/5/collection/delete-document/snippets/delete-document-1.js b/src/sdk/js/5/core-classes/collection/delete-document/snippets/delete-document-1.js similarity index 100% rename from src/sdk/js/5/collection/delete-document/snippets/delete-document-1.js rename to src/sdk/js/5/core-classes/collection/delete-document/snippets/delete-document-1.js diff --git a/src/sdk/js/5/collection/delete-document/snippets/delete-document-2.js b/src/sdk/js/5/core-classes/collection/delete-document/snippets/delete-document-2.js similarity index 100% rename from src/sdk/js/5/collection/delete-document/snippets/delete-document-2.js rename to src/sdk/js/5/core-classes/collection/delete-document/snippets/delete-document-2.js diff --git a/src/sdk/js/5/collection/delete-specifications/index.md b/src/sdk/js/5/core-classes/collection/delete-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/delete-specifications/index.md rename to src/sdk/js/5/core-classes/collection/delete-specifications/index.md diff --git a/src/sdk/js/5/collection/delete-specifications/snippets/delete-specifications-1.js b/src/sdk/js/5/core-classes/collection/delete-specifications/snippets/delete-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/delete-specifications/snippets/delete-specifications-1.js rename to src/sdk/js/5/core-classes/collection/delete-specifications/snippets/delete-specifications-1.js diff --git a/src/sdk/js/5/collection/delete-specifications/snippets/delete-specifications-2.js b/src/sdk/js/5/core-classes/collection/delete-specifications/snippets/delete-specifications-2.js similarity index 100% rename from src/sdk/js/5/collection/delete-specifications/snippets/delete-specifications-2.js rename to src/sdk/js/5/core-classes/collection/delete-specifications/snippets/delete-specifications-2.js diff --git a/src/sdk/js/5/collection/document/index.md b/src/sdk/js/5/core-classes/collection/document/index.md similarity index 100% rename from src/sdk/js/5/collection/document/index.md rename to src/sdk/js/5/core-classes/collection/document/index.md diff --git a/src/sdk/js/5/collection/document/snippets/document-1.js b/src/sdk/js/5/core-classes/collection/document/snippets/document-1.js similarity index 100% rename from src/sdk/js/5/collection/document/snippets/document-1.js rename to src/sdk/js/5/core-classes/collection/document/snippets/document-1.js diff --git a/src/sdk/js/5/collection/fetch-document/index.md b/src/sdk/js/5/core-classes/collection/fetch-document/index.md similarity index 100% rename from src/sdk/js/5/collection/fetch-document/index.md rename to src/sdk/js/5/core-classes/collection/fetch-document/index.md diff --git a/src/sdk/js/5/collection/fetch-document/snippets/fetch-document-1.js b/src/sdk/js/5/core-classes/collection/fetch-document/snippets/fetch-document-1.js similarity index 100% rename from src/sdk/js/5/collection/fetch-document/snippets/fetch-document-1.js rename to src/sdk/js/5/core-classes/collection/fetch-document/snippets/fetch-document-1.js diff --git a/src/sdk/js/5/collection/get-mapping/index.md b/src/sdk/js/5/core-classes/collection/get-mapping/index.md similarity index 100% rename from src/sdk/js/5/collection/get-mapping/index.md rename to src/sdk/js/5/core-classes/collection/get-mapping/index.md diff --git a/src/sdk/js/5/collection/get-mapping/snippets/get-mapping-1.js b/src/sdk/js/5/core-classes/collection/get-mapping/snippets/get-mapping-1.js similarity index 100% rename from src/sdk/js/5/collection/get-mapping/snippets/get-mapping-1.js rename to src/sdk/js/5/core-classes/collection/get-mapping/snippets/get-mapping-1.js diff --git a/src/sdk/js/5/collection/get-specifications/index.md b/src/sdk/js/5/core-classes/collection/get-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/get-specifications/index.md rename to src/sdk/js/5/core-classes/collection/get-specifications/index.md diff --git a/src/sdk/js/5/collection/get-specifications/snippets/get-specifications-1.js b/src/sdk/js/5/core-classes/collection/get-specifications/snippets/get-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/get-specifications/snippets/get-specifications-1.js rename to src/sdk/js/5/core-classes/collection/get-specifications/snippets/get-specifications-1.js diff --git a/src/sdk/js/5/collection/get-specifications/snippets/get-specifications-2.js b/src/sdk/js/5/core-classes/collection/get-specifications/snippets/get-specifications-2.js similarity index 100% rename from src/sdk/js/5/collection/get-specifications/snippets/get-specifications-2.js rename to src/sdk/js/5/core-classes/collection/get-specifications/snippets/get-specifications-2.js diff --git a/src/sdk/js/5/collection/index.md b/src/sdk/js/5/core-classes/collection/index.md similarity index 100% rename from src/sdk/js/5/collection/index.md rename to src/sdk/js/5/core-classes/collection/index.md diff --git a/src/sdk/js/5/collection/mcreate-document/index.md b/src/sdk/js/5/core-classes/collection/mcreate-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mcreate-document/index.md rename to src/sdk/js/5/core-classes/collection/mcreate-document/index.md diff --git a/src/sdk/js/5/collection/mcreate-document/snippets/mcreate-document-1.js b/src/sdk/js/5/core-classes/collection/mcreate-document/snippets/mcreate-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mcreate-document/snippets/mcreate-document-1.js rename to src/sdk/js/5/core-classes/collection/mcreate-document/snippets/mcreate-document-1.js diff --git a/src/sdk/js/5/collection/mcreate-document/snippets/mcreate-document-2.js b/src/sdk/js/5/core-classes/collection/mcreate-document/snippets/mcreate-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mcreate-document/snippets/mcreate-document-2.js rename to src/sdk/js/5/core-classes/collection/mcreate-document/snippets/mcreate-document-2.js diff --git a/src/sdk/js/5/collection/mcreate-or-replace-document/index.md b/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mcreate-or-replace-document/index.md rename to src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md diff --git a/src/sdk/js/5/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.js b/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.js rename to src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.js diff --git a/src/sdk/js/5/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-2.js b/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-2.js rename to src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-2.js diff --git a/src/sdk/js/5/collection/mdelete-document/index.md b/src/sdk/js/5/core-classes/collection/mdelete-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mdelete-document/index.md rename to src/sdk/js/5/core-classes/collection/mdelete-document/index.md diff --git a/src/sdk/js/5/collection/mdelete-document/snippets/mdelete-document-1.js b/src/sdk/js/5/core-classes/collection/mdelete-document/snippets/mdelete-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mdelete-document/snippets/mdelete-document-1.js rename to src/sdk/js/5/core-classes/collection/mdelete-document/snippets/mdelete-document-1.js diff --git a/src/sdk/js/5/collection/mdelete-document/snippets/mdelete-document-2.js b/src/sdk/js/5/core-classes/collection/mdelete-document/snippets/mdelete-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mdelete-document/snippets/mdelete-document-2.js rename to src/sdk/js/5/core-classes/collection/mdelete-document/snippets/mdelete-document-2.js diff --git a/src/sdk/js/5/collection/mget-document/index.md b/src/sdk/js/5/core-classes/collection/mget-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mget-document/index.md rename to src/sdk/js/5/core-classes/collection/mget-document/index.md diff --git a/src/sdk/js/5/collection/mget-document/snippets/mget-document-1.js b/src/sdk/js/5/core-classes/collection/mget-document/snippets/mget-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mget-document/snippets/mget-document-1.js rename to src/sdk/js/5/core-classes/collection/mget-document/snippets/mget-document-1.js diff --git a/src/sdk/js/5/collection/mget-document/snippets/mget-document-2.js b/src/sdk/js/5/core-classes/collection/mget-document/snippets/mget-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mget-document/snippets/mget-document-2.js rename to src/sdk/js/5/core-classes/collection/mget-document/snippets/mget-document-2.js diff --git a/src/sdk/js/5/collection/mreplace-document/index.md b/src/sdk/js/5/core-classes/collection/mreplace-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mreplace-document/index.md rename to src/sdk/js/5/core-classes/collection/mreplace-document/index.md diff --git a/src/sdk/js/5/collection/mreplace-document/snippets/mreplace-document-1.js b/src/sdk/js/5/core-classes/collection/mreplace-document/snippets/mreplace-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mreplace-document/snippets/mreplace-document-1.js rename to src/sdk/js/5/core-classes/collection/mreplace-document/snippets/mreplace-document-1.js diff --git a/src/sdk/js/5/collection/mreplace-document/snippets/mreplace-document-2.js b/src/sdk/js/5/core-classes/collection/mreplace-document/snippets/mreplace-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mreplace-document/snippets/mreplace-document-2.js rename to src/sdk/js/5/core-classes/collection/mreplace-document/snippets/mreplace-document-2.js diff --git a/src/sdk/js/5/collection/mupdate-document/index.md b/src/sdk/js/5/core-classes/collection/mupdate-document/index.md similarity index 100% rename from src/sdk/js/5/collection/mupdate-document/index.md rename to src/sdk/js/5/core-classes/collection/mupdate-document/index.md diff --git a/src/sdk/js/5/collection/mupdate-document/snippets/mupdate-document-1.js b/src/sdk/js/5/core-classes/collection/mupdate-document/snippets/mupdate-document-1.js similarity index 100% rename from src/sdk/js/5/collection/mupdate-document/snippets/mupdate-document-1.js rename to src/sdk/js/5/core-classes/collection/mupdate-document/snippets/mupdate-document-1.js diff --git a/src/sdk/js/5/collection/mupdate-document/snippets/mupdate-document-2.js b/src/sdk/js/5/core-classes/collection/mupdate-document/snippets/mupdate-document-2.js similarity index 100% rename from src/sdk/js/5/collection/mupdate-document/snippets/mupdate-document-2.js rename to src/sdk/js/5/core-classes/collection/mupdate-document/snippets/mupdate-document-2.js diff --git a/src/sdk/js/5/collection/publish-message/index.md b/src/sdk/js/5/core-classes/collection/publish-message/index.md similarity index 100% rename from src/sdk/js/5/collection/publish-message/index.md rename to src/sdk/js/5/core-classes/collection/publish-message/index.md diff --git a/src/sdk/js/5/collection/publish-message/snippets/publish-message-1.js b/src/sdk/js/5/core-classes/collection/publish-message/snippets/publish-message-1.js similarity index 100% rename from src/sdk/js/5/collection/publish-message/snippets/publish-message-1.js rename to src/sdk/js/5/core-classes/collection/publish-message/snippets/publish-message-1.js diff --git a/src/sdk/js/5/collection/replace-document/index.md b/src/sdk/js/5/core-classes/collection/replace-document/index.md similarity index 100% rename from src/sdk/js/5/collection/replace-document/index.md rename to src/sdk/js/5/core-classes/collection/replace-document/index.md diff --git a/src/sdk/js/5/collection/replace-document/snippets/replace-document-1.js b/src/sdk/js/5/core-classes/collection/replace-document/snippets/replace-document-1.js similarity index 100% rename from src/sdk/js/5/collection/replace-document/snippets/replace-document-1.js rename to src/sdk/js/5/core-classes/collection/replace-document/snippets/replace-document-1.js diff --git a/src/sdk/js/5/collection/room/index.md b/src/sdk/js/5/core-classes/collection/room/index.md similarity index 100% rename from src/sdk/js/5/collection/room/index.md rename to src/sdk/js/5/core-classes/collection/room/index.md diff --git a/src/sdk/js/5/collection/room/snippets/room-1.js b/src/sdk/js/5/core-classes/collection/room/snippets/room-1.js similarity index 100% rename from src/sdk/js/5/collection/room/snippets/room-1.js rename to src/sdk/js/5/core-classes/collection/room/snippets/room-1.js diff --git a/src/sdk/js/5/collection/scroll-specifications/index.md b/src/sdk/js/5/core-classes/collection/scroll-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/scroll-specifications/index.md rename to src/sdk/js/5/core-classes/collection/scroll-specifications/index.md diff --git a/src/sdk/js/5/collection/scroll-specifications/snippets/scroll-specifications-1.js b/src/sdk/js/5/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/scroll-specifications/snippets/scroll-specifications-1.js rename to src/sdk/js/5/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.js diff --git a/src/sdk/js/5/collection/scroll-specifications/snippets/scroll-specifications-2.js b/src/sdk/js/5/core-classes/collection/scroll-specifications/snippets/scroll-specifications-2.js similarity index 100% rename from src/sdk/js/5/collection/scroll-specifications/snippets/scroll-specifications-2.js rename to src/sdk/js/5/core-classes/collection/scroll-specifications/snippets/scroll-specifications-2.js diff --git a/src/sdk/js/5/collection/scroll/index.md b/src/sdk/js/5/core-classes/collection/scroll/index.md similarity index 100% rename from src/sdk/js/5/collection/scroll/index.md rename to src/sdk/js/5/core-classes/collection/scroll/index.md diff --git a/src/sdk/js/5/collection/scroll/snippets/scroll-1.js b/src/sdk/js/5/core-classes/collection/scroll/snippets/scroll-1.js similarity index 100% rename from src/sdk/js/5/collection/scroll/snippets/scroll-1.js rename to src/sdk/js/5/core-classes/collection/scroll/snippets/scroll-1.js diff --git a/src/sdk/js/5/collection/search-specifications/index.md b/src/sdk/js/5/core-classes/collection/search-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/search-specifications/index.md rename to src/sdk/js/5/core-classes/collection/search-specifications/index.md diff --git a/src/sdk/js/5/collection/search-specifications/snippets/search-specifications-1.js b/src/sdk/js/5/core-classes/collection/search-specifications/snippets/search-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/search-specifications/snippets/search-specifications-1.js rename to src/sdk/js/5/core-classes/collection/search-specifications/snippets/search-specifications-1.js diff --git a/src/sdk/js/5/collection/search-specifications/snippets/search-specifications-2.js b/src/sdk/js/5/core-classes/collection/search-specifications/snippets/search-specifications-2.js similarity index 100% rename from src/sdk/js/5/collection/search-specifications/snippets/search-specifications-2.js rename to src/sdk/js/5/core-classes/collection/search-specifications/snippets/search-specifications-2.js diff --git a/src/sdk/js/5/collection/search/index.md b/src/sdk/js/5/core-classes/collection/search/index.md similarity index 100% rename from src/sdk/js/5/collection/search/index.md rename to src/sdk/js/5/core-classes/collection/search/index.md diff --git a/src/sdk/js/5/collection/search/snippets/search-1.js b/src/sdk/js/5/core-classes/collection/search/snippets/search-1.js similarity index 100% rename from src/sdk/js/5/collection/search/snippets/search-1.js rename to src/sdk/js/5/core-classes/collection/search/snippets/search-1.js diff --git a/src/sdk/js/5/collection/set-headers/index.md b/src/sdk/js/5/core-classes/collection/set-headers/index.md similarity index 100% rename from src/sdk/js/5/collection/set-headers/index.md rename to src/sdk/js/5/core-classes/collection/set-headers/index.md diff --git a/src/sdk/js/5/collection/set-headers/snippets/set-headers-1.js b/src/sdk/js/5/core-classes/collection/set-headers/snippets/set-headers-1.js similarity index 100% rename from src/sdk/js/5/collection/set-headers/snippets/set-headers-1.js rename to src/sdk/js/5/core-classes/collection/set-headers/snippets/set-headers-1.js diff --git a/src/sdk/js/5/collection/subscribe/index.md b/src/sdk/js/5/core-classes/collection/subscribe/index.md similarity index 98% rename from src/sdk/js/5/collection/subscribe/index.md rename to src/sdk/js/5/core-classes/collection/subscribe/index.md index 2c24e60ab..395aecfee 100644 --- a/src/sdk/js/5/collection/subscribe/index.md +++ b/src/sdk/js/5/core-classes/collection/subscribe/index.md @@ -9,7 +9,7 @@ description: Collection:subscribe Subscribes to this collection with a set of filters. -The provided callback will be called everytime a [notification](/sdk/js/5/notifications) is received from Kuzzle. +The provided callback will be called everytime a [notification](/sdk/js/5/essentials/realtime-notifications) is received from Kuzzle. --- diff --git a/src/sdk/js/5/collection/subscribe/snippets/subscribe-1.js b/src/sdk/js/5/core-classes/collection/subscribe/snippets/subscribe-1.js similarity index 100% rename from src/sdk/js/5/collection/subscribe/snippets/subscribe-1.js rename to src/sdk/js/5/core-classes/collection/subscribe/snippets/subscribe-1.js diff --git a/src/sdk/js/5/collection/truncate/index.md b/src/sdk/js/5/core-classes/collection/truncate/index.md similarity index 100% rename from src/sdk/js/5/collection/truncate/index.md rename to src/sdk/js/5/core-classes/collection/truncate/index.md diff --git a/src/sdk/js/5/collection/truncate/snippets/truncate-1.js b/src/sdk/js/5/core-classes/collection/truncate/snippets/truncate-1.js similarity index 100% rename from src/sdk/js/5/collection/truncate/snippets/truncate-1.js rename to src/sdk/js/5/core-classes/collection/truncate/snippets/truncate-1.js diff --git a/src/sdk/js/5/collection/truncate/snippets/truncate-2.js b/src/sdk/js/5/core-classes/collection/truncate/snippets/truncate-2.js similarity index 100% rename from src/sdk/js/5/collection/truncate/snippets/truncate-2.js rename to src/sdk/js/5/core-classes/collection/truncate/snippets/truncate-2.js diff --git a/src/sdk/js/5/collection/update-document/index.md b/src/sdk/js/5/core-classes/collection/update-document/index.md similarity index 100% rename from src/sdk/js/5/collection/update-document/index.md rename to src/sdk/js/5/core-classes/collection/update-document/index.md diff --git a/src/sdk/js/5/collection/update-document/snippets/update-document-1.js b/src/sdk/js/5/core-classes/collection/update-document/snippets/update-document-1.js similarity index 100% rename from src/sdk/js/5/collection/update-document/snippets/update-document-1.js rename to src/sdk/js/5/core-classes/collection/update-document/snippets/update-document-1.js diff --git a/src/sdk/js/5/collection/update-specifications/index.md b/src/sdk/js/5/core-classes/collection/update-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/update-specifications/index.md rename to src/sdk/js/5/core-classes/collection/update-specifications/index.md diff --git a/src/sdk/js/5/collection/update-specifications/snippets/update-specifications-1.js b/src/sdk/js/5/core-classes/collection/update-specifications/snippets/update-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/update-specifications/snippets/update-specifications-1.js rename to src/sdk/js/5/core-classes/collection/update-specifications/snippets/update-specifications-1.js diff --git a/src/sdk/js/5/collection/update-specifications/snippets/update-specifications-2.js b/src/sdk/js/5/core-classes/collection/update-specifications/snippets/update-specifications-2.js similarity index 100% rename from src/sdk/js/5/collection/update-specifications/snippets/update-specifications-2.js rename to src/sdk/js/5/core-classes/collection/update-specifications/snippets/update-specifications-2.js diff --git a/src/sdk/js/5/collection/validate-specifications/index.md b/src/sdk/js/5/core-classes/collection/validate-specifications/index.md similarity index 100% rename from src/sdk/js/5/collection/validate-specifications/index.md rename to src/sdk/js/5/core-classes/collection/validate-specifications/index.md diff --git a/src/sdk/js/5/collection/validate-specifications/snippets/validate-specifications-1.js b/src/sdk/js/5/core-classes/collection/validate-specifications/snippets/validate-specifications-1.js similarity index 100% rename from src/sdk/js/5/collection/validate-specifications/snippets/validate-specifications-1.js rename to src/sdk/js/5/core-classes/collection/validate-specifications/snippets/validate-specifications-1.js diff --git a/src/sdk/js/5/document/constructor/index.md b/src/sdk/js/5/core-classes/document/constructor/index.md similarity index 100% rename from src/sdk/js/5/document/constructor/index.md rename to src/sdk/js/5/core-classes/document/constructor/index.md diff --git a/src/sdk/js/5/document/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/document/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/document/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/document/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/document/delete/index.md b/src/sdk/js/5/core-classes/document/delete/index.md similarity index 100% rename from src/sdk/js/5/document/delete/index.md rename to src/sdk/js/5/core-classes/document/delete/index.md diff --git a/src/sdk/js/5/document/delete/snippets/delete-1.js b/src/sdk/js/5/core-classes/document/delete/snippets/delete-1.js similarity index 100% rename from src/sdk/js/5/document/delete/snippets/delete-1.js rename to src/sdk/js/5/core-classes/document/delete/snippets/delete-1.js diff --git a/src/sdk/js/5/document/exists/index.md b/src/sdk/js/5/core-classes/document/exists/index.md similarity index 100% rename from src/sdk/js/5/document/exists/index.md rename to src/sdk/js/5/core-classes/document/exists/index.md diff --git a/src/sdk/js/5/document/exists/snippets/exists-1.js b/src/sdk/js/5/core-classes/document/exists/snippets/exists-1.js similarity index 100% rename from src/sdk/js/5/document/exists/snippets/exists-1.js rename to src/sdk/js/5/core-classes/document/exists/snippets/exists-1.js diff --git a/src/sdk/js/5/document/index.md b/src/sdk/js/5/core-classes/document/index.md similarity index 100% rename from src/sdk/js/5/document/index.md rename to src/sdk/js/5/core-classes/document/index.md diff --git a/src/sdk/js/5/document/publish/index.md b/src/sdk/js/5/core-classes/document/publish/index.md similarity index 100% rename from src/sdk/js/5/document/publish/index.md rename to src/sdk/js/5/core-classes/document/publish/index.md diff --git a/src/sdk/js/5/document/publish/snippets/publish-1.js b/src/sdk/js/5/core-classes/document/publish/snippets/publish-1.js similarity index 100% rename from src/sdk/js/5/document/publish/snippets/publish-1.js rename to src/sdk/js/5/core-classes/document/publish/snippets/publish-1.js diff --git a/src/sdk/js/5/document/refresh/index.md b/src/sdk/js/5/core-classes/document/refresh/index.md similarity index 100% rename from src/sdk/js/5/document/refresh/index.md rename to src/sdk/js/5/core-classes/document/refresh/index.md diff --git a/src/sdk/js/5/document/refresh/snippets/refresh-1.js b/src/sdk/js/5/core-classes/document/refresh/snippets/refresh-1.js similarity index 100% rename from src/sdk/js/5/document/refresh/snippets/refresh-1.js rename to src/sdk/js/5/core-classes/document/refresh/snippets/refresh-1.js diff --git a/src/sdk/js/5/document/save/index.md b/src/sdk/js/5/core-classes/document/save/index.md similarity index 100% rename from src/sdk/js/5/document/save/index.md rename to src/sdk/js/5/core-classes/document/save/index.md diff --git a/src/sdk/js/5/document/save/snippets/save-1.js b/src/sdk/js/5/core-classes/document/save/snippets/save-1.js similarity index 100% rename from src/sdk/js/5/document/save/snippets/save-1.js rename to src/sdk/js/5/core-classes/document/save/snippets/save-1.js diff --git a/src/sdk/js/5/document/set-content/index.md b/src/sdk/js/5/core-classes/document/set-content/index.md similarity index 100% rename from src/sdk/js/5/document/set-content/index.md rename to src/sdk/js/5/core-classes/document/set-content/index.md diff --git a/src/sdk/js/5/document/set-content/snippets/set-content-1.js b/src/sdk/js/5/core-classes/document/set-content/snippets/set-content-1.js similarity index 100% rename from src/sdk/js/5/document/set-content/snippets/set-content-1.js rename to src/sdk/js/5/core-classes/document/set-content/snippets/set-content-1.js diff --git a/src/sdk/js/5/document/set-headers/index.md b/src/sdk/js/5/core-classes/document/set-headers/index.md similarity index 100% rename from src/sdk/js/5/document/set-headers/index.md rename to src/sdk/js/5/core-classes/document/set-headers/index.md diff --git a/src/sdk/js/5/document/set-headers/snippets/set-headers-1.js b/src/sdk/js/5/core-classes/document/set-headers/snippets/set-headers-1.js similarity index 100% rename from src/sdk/js/5/document/set-headers/snippets/set-headers-1.js rename to src/sdk/js/5/core-classes/document/set-headers/snippets/set-headers-1.js diff --git a/src/sdk/js/5/document/subscribe/index.md b/src/sdk/js/5/core-classes/document/subscribe/index.md similarity index 89% rename from src/sdk/js/5/document/subscribe/index.md rename to src/sdk/js/5/core-classes/document/subscribe/index.md index c05287477..48a9c4d9b 100644 --- a/src/sdk/js/5/document/subscribe/index.md +++ b/src/sdk/js/5/core-classes/document/subscribe/index.md @@ -10,7 +10,7 @@ description: Document:subscribe Listens to changes occuring in this document. Throws an error if this document has not yet been created in Kuzzle. -The provided callback will be called everytime a [notification](/sdk/js/5/notifications) is received from Kuzzle. +The provided callback will be called everytime a [notification](/sdk/js/5/essentials/realtime-notifications) is received from Kuzzle. --- @@ -31,7 +31,7 @@ Options are directly passed to the [Room](/sdk/js/5/room/) object constructor. ## Return Value -Returns an object exposing the following method: +Returns an object exposing the following method: `onDone(callback)` The `callback` argument is called when the subscription ends, either successfully or with an error. diff --git a/src/sdk/js/5/document/subscribe/snippets/subscribe-1.js b/src/sdk/js/5/core-classes/document/subscribe/snippets/subscribe-1.js similarity index 100% rename from src/sdk/js/5/document/subscribe/snippets/subscribe-1.js rename to src/sdk/js/5/core-classes/document/subscribe/snippets/subscribe-1.js diff --git a/src/sdk/js/5/core-classes/index.md b/src/sdk/js/5/core-classes/index.md new file mode 100644 index 000000000..736c461bc --- /dev/null +++ b/src/sdk/js/5/core-classes/index.md @@ -0,0 +1,7 @@ +--- +code: false +type: branch +order: 100 +title: Core Classes +description: Javascript SDK v5.x core classes +--- diff --git a/src/sdk/js/5/kuzzle/add-listener/index.md b/src/sdk/js/5/core-classes/kuzzle/add-listener/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/add-listener/index.md rename to src/sdk/js/5/core-classes/kuzzle/add-listener/index.md diff --git a/src/sdk/js/5/kuzzle/add-listener/snippets/add-listener-1.js b/src/sdk/js/5/core-classes/kuzzle/add-listener/snippets/add-listener-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/add-listener/snippets/add-listener-1.js rename to src/sdk/js/5/core-classes/kuzzle/add-listener/snippets/add-listener-1.js diff --git a/src/sdk/js/5/kuzzle/check-token/index.md b/src/sdk/js/5/core-classes/kuzzle/check-token/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/check-token/index.md rename to src/sdk/js/5/core-classes/kuzzle/check-token/index.md diff --git a/src/sdk/js/5/kuzzle/check-token/snippets/check-token-1.js b/src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/check-token/snippets/check-token-1.js rename to src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-1.js diff --git a/src/sdk/js/5/kuzzle/check-token/snippets/check-token-2.js b/src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/check-token/snippets/check-token-2.js rename to src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-2.js diff --git a/src/sdk/js/5/kuzzle/check-token/snippets/check-token-3.js b/src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-3.js similarity index 100% rename from src/sdk/js/5/kuzzle/check-token/snippets/check-token-3.js rename to src/sdk/js/5/core-classes/kuzzle/check-token/snippets/check-token-3.js diff --git a/src/sdk/js/5/kuzzle/collection/index.md b/src/sdk/js/5/core-classes/kuzzle/collection/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/collection/index.md rename to src/sdk/js/5/core-classes/kuzzle/collection/index.md diff --git a/src/sdk/js/5/kuzzle/collection/snippets/collection-1.js b/src/sdk/js/5/core-classes/kuzzle/collection/snippets/collection-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/collection/snippets/collection-1.js rename to src/sdk/js/5/core-classes/kuzzle/collection/snippets/collection-1.js diff --git a/src/sdk/js/5/kuzzle/connect/index.md b/src/sdk/js/5/core-classes/kuzzle/connect/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/connect/index.md rename to src/sdk/js/5/core-classes/kuzzle/connect/index.md diff --git a/src/sdk/js/5/kuzzle/connect/snippets/connect-1.js b/src/sdk/js/5/core-classes/kuzzle/connect/snippets/connect-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/connect/snippets/connect-1.js rename to src/sdk/js/5/core-classes/kuzzle/connect/snippets/connect-1.js diff --git a/src/sdk/js/5/kuzzle/constructor/index.md b/src/sdk/js/5/core-classes/kuzzle/constructor/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/constructor/index.md rename to src/sdk/js/5/core-classes/kuzzle/constructor/index.md diff --git a/src/sdk/js/5/kuzzle/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/kuzzle/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/kuzzle/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/kuzzle/create-index/index.md b/src/sdk/js/5/core-classes/kuzzle/create-index/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/create-index/index.md rename to src/sdk/js/5/core-classes/kuzzle/create-index/index.md diff --git a/src/sdk/js/5/kuzzle/create-index/snippets/create-index-1.js b/src/sdk/js/5/core-classes/kuzzle/create-index/snippets/create-index-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/create-index/snippets/create-index-1.js rename to src/sdk/js/5/core-classes/kuzzle/create-index/snippets/create-index-1.js diff --git a/src/sdk/js/5/kuzzle/create-index/snippets/create-index-2.js b/src/sdk/js/5/core-classes/kuzzle/create-index/snippets/create-index-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/create-index/snippets/create-index-2.js rename to src/sdk/js/5/core-classes/kuzzle/create-index/snippets/create-index-2.js diff --git a/src/sdk/js/5/kuzzle/create-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/create-my-credentials/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/create-my-credentials/index.md rename to src/sdk/js/5/core-classes/kuzzle/create-my-credentials/index.md diff --git a/src/sdk/js/5/kuzzle/create-my-credentials/snippets/create-my-credentials-1.js b/src/sdk/js/5/core-classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/create-my-credentials/snippets/create-my-credentials-1.js rename to src/sdk/js/5/core-classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.js diff --git a/src/sdk/js/5/kuzzle/delete-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/delete-my-credentials/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/delete-my-credentials/index.md rename to src/sdk/js/5/core-classes/kuzzle/delete-my-credentials/index.md diff --git a/src/sdk/js/5/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.js b/src/sdk/js/5/core-classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.js rename to src/sdk/js/5/core-classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.js diff --git a/src/sdk/js/5/kuzzle/disconnect/index.md b/src/sdk/js/5/core-classes/kuzzle/disconnect/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/disconnect/index.md rename to src/sdk/js/5/core-classes/kuzzle/disconnect/index.md diff --git a/src/sdk/js/5/kuzzle/disconnect/snippets/disconnect-1.js b/src/sdk/js/5/core-classes/kuzzle/disconnect/snippets/disconnect-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/disconnect/snippets/disconnect-1.js rename to src/sdk/js/5/core-classes/kuzzle/disconnect/snippets/disconnect-1.js diff --git a/src/sdk/js/5/kuzzle/flush-queue/index.md b/src/sdk/js/5/core-classes/kuzzle/flush-queue/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/flush-queue/index.md rename to src/sdk/js/5/core-classes/kuzzle/flush-queue/index.md diff --git a/src/sdk/js/5/kuzzle/flush-queue/snippets/flush-queue-1.js b/src/sdk/js/5/core-classes/kuzzle/flush-queue/snippets/flush-queue-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/flush-queue/snippets/flush-queue-1.js rename to src/sdk/js/5/core-classes/kuzzle/flush-queue/snippets/flush-queue-1.js diff --git a/src/sdk/js/5/kuzzle/get-all-statistics/index.md b/src/sdk/js/5/core-classes/kuzzle/get-all-statistics/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-all-statistics/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-all-statistics/index.md diff --git a/src/sdk/js/5/kuzzle/get-all-statistics/snippets/get-all-statistics-1.js b/src/sdk/js/5/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-all-statistics/snippets/get-all-statistics-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.js diff --git a/src/sdk/js/5/kuzzle/get-all-statistics/snippets/get-all-statistics-2.js b/src/sdk/js/5/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-all-statistics/snippets/get-all-statistics-2.js rename to src/sdk/js/5/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-2.js diff --git a/src/sdk/js/5/kuzzle/get-auto-refresh/index.md b/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-auto-refresh/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md diff --git a/src/sdk/js/5/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.js b/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.js diff --git a/src/sdk/js/5/kuzzle/get-jwt-token/index.md b/src/sdk/js/5/core-classes/kuzzle/get-jwt-token/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-jwt-token/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-jwt-token/index.md diff --git a/src/sdk/js/5/kuzzle/get-jwt-token/snippets/get-jwt-token-1.js b/src/sdk/js/5/core-classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-jwt-token/snippets/get-jwt-token-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.js diff --git a/src/sdk/js/5/kuzzle/get-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-credentials/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md diff --git a/src/sdk/js/5/kuzzle/get-my-credentials/snippets/get-my-credentials-1.js b/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-credentials/snippets/get-my-credentials-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.js diff --git a/src/sdk/js/5/kuzzle/get-my-credentials/snippets/get-my-credentials-2.js b/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-credentials/snippets/get-my-credentials-2.js rename to src/sdk/js/5/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-2.js diff --git a/src/sdk/js/5/kuzzle/get-my-rights/index.md b/src/sdk/js/5/core-classes/kuzzle/get-my-rights/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-rights/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-my-rights/index.md diff --git a/src/sdk/js/5/kuzzle/get-my-rights/snippets/get-my-rights-1.js b/src/sdk/js/5/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-rights/snippets/get-my-rights-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-1.js diff --git a/src/sdk/js/5/kuzzle/get-my-rights/snippets/get-my-rights-2.js b/src/sdk/js/5/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-my-rights/snippets/get-my-rights-2.js rename to src/sdk/js/5/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-2.js diff --git a/src/sdk/js/5/kuzzle/get-server-info/index.md b/src/sdk/js/5/core-classes/kuzzle/get-server-info/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-server-info/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-server-info/index.md diff --git a/src/sdk/js/5/kuzzle/get-server-info/snippets/get-server-info-1.js b/src/sdk/js/5/core-classes/kuzzle/get-server-info/snippets/get-server-info-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-server-info/snippets/get-server-info-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-server-info/snippets/get-server-info-1.js diff --git a/src/sdk/js/5/kuzzle/get-server-info/snippets/get-server-info-2.js b/src/sdk/js/5/core-classes/kuzzle/get-server-info/snippets/get-server-info-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-server-info/snippets/get-server-info-2.js rename to src/sdk/js/5/core-classes/kuzzle/get-server-info/snippets/get-server-info-2.js diff --git a/src/sdk/js/5/kuzzle/get-statistics/index.md b/src/sdk/js/5/core-classes/kuzzle/get-statistics/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/get-statistics/index.md rename to src/sdk/js/5/core-classes/kuzzle/get-statistics/index.md diff --git a/src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-1.js b/src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-1.js rename to src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-1.js diff --git a/src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-2.js b/src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-2.js rename to src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-2.js diff --git a/src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-3.js b/src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-3.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-3.js rename to src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-3.js diff --git a/src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-4.js b/src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-4.js similarity index 100% rename from src/sdk/js/5/kuzzle/get-statistics/snippets/get-statistics-4.js rename to src/sdk/js/5/core-classes/kuzzle/get-statistics/snippets/get-statistics-4.js diff --git a/src/sdk/js/5/kuzzle/index.md b/src/sdk/js/5/core-classes/kuzzle/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/index.md rename to src/sdk/js/5/core-classes/kuzzle/index.md diff --git a/src/sdk/js/5/kuzzle/list-collections/index.md b/src/sdk/js/5/core-classes/kuzzle/list-collections/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/list-collections/index.md rename to src/sdk/js/5/core-classes/kuzzle/list-collections/index.md diff --git a/src/sdk/js/5/kuzzle/list-collections/snippets/list-collections-1.js b/src/sdk/js/5/core-classes/kuzzle/list-collections/snippets/list-collections-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/list-collections/snippets/list-collections-1.js rename to src/sdk/js/5/core-classes/kuzzle/list-collections/snippets/list-collections-1.js diff --git a/src/sdk/js/5/kuzzle/list-collections/snippets/list-collections-2.js b/src/sdk/js/5/core-classes/kuzzle/list-collections/snippets/list-collections-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/list-collections/snippets/list-collections-2.js rename to src/sdk/js/5/core-classes/kuzzle/list-collections/snippets/list-collections-2.js diff --git a/src/sdk/js/5/kuzzle/list-indexes/index.md b/src/sdk/js/5/core-classes/kuzzle/list-indexes/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/list-indexes/index.md rename to src/sdk/js/5/core-classes/kuzzle/list-indexes/index.md diff --git a/src/sdk/js/5/kuzzle/list-indexes/snippets/list-indexes-1.js b/src/sdk/js/5/core-classes/kuzzle/list-indexes/snippets/list-indexes-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/list-indexes/snippets/list-indexes-1.js rename to src/sdk/js/5/core-classes/kuzzle/list-indexes/snippets/list-indexes-1.js diff --git a/src/sdk/js/5/kuzzle/list-indexes/snippets/list-indexes-2.js b/src/sdk/js/5/core-classes/kuzzle/list-indexes/snippets/list-indexes-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/list-indexes/snippets/list-indexes-2.js rename to src/sdk/js/5/core-classes/kuzzle/list-indexes/snippets/list-indexes-2.js diff --git a/src/sdk/js/5/kuzzle/login/index.md b/src/sdk/js/5/core-classes/kuzzle/login/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/login/index.md rename to src/sdk/js/5/core-classes/kuzzle/login/index.md diff --git a/src/sdk/js/5/kuzzle/login/snippets/login-1.js b/src/sdk/js/5/core-classes/kuzzle/login/snippets/login-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/login/snippets/login-1.js rename to src/sdk/js/5/core-classes/kuzzle/login/snippets/login-1.js diff --git a/src/sdk/js/5/kuzzle/logout/index.md b/src/sdk/js/5/core-classes/kuzzle/logout/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/logout/index.md rename to src/sdk/js/5/core-classes/kuzzle/logout/index.md diff --git a/src/sdk/js/5/kuzzle/logout/snippets/logout-1.js b/src/sdk/js/5/core-classes/kuzzle/logout/snippets/logout-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/logout/snippets/logout-1.js rename to src/sdk/js/5/core-classes/kuzzle/logout/snippets/logout-1.js diff --git a/src/sdk/js/5/kuzzle/memory-storage/index.md b/src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/memory-storage/index.md rename to src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md diff --git a/src/sdk/js/5/kuzzle/now/index.md b/src/sdk/js/5/core-classes/kuzzle/now/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/now/index.md rename to src/sdk/js/5/core-classes/kuzzle/now/index.md diff --git a/src/sdk/js/5/kuzzle/now/snippets/now-1.js b/src/sdk/js/5/core-classes/kuzzle/now/snippets/now-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/now/snippets/now-1.js rename to src/sdk/js/5/core-classes/kuzzle/now/snippets/now-1.js diff --git a/src/sdk/js/5/kuzzle/now/snippets/now-2.js b/src/sdk/js/5/core-classes/kuzzle/now/snippets/now-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/now/snippets/now-2.js rename to src/sdk/js/5/core-classes/kuzzle/now/snippets/now-2.js diff --git a/src/sdk/js/5/kuzzle/query/index.md b/src/sdk/js/5/core-classes/kuzzle/query/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/query/index.md rename to src/sdk/js/5/core-classes/kuzzle/query/index.md diff --git a/src/sdk/js/5/kuzzle/query/snippets/query-1.js b/src/sdk/js/5/core-classes/kuzzle/query/snippets/query-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/query/snippets/query-1.js rename to src/sdk/js/5/core-classes/kuzzle/query/snippets/query-1.js diff --git a/src/sdk/js/5/kuzzle/query/snippets/query-2.js b/src/sdk/js/5/core-classes/kuzzle/query/snippets/query-2.js similarity index 100% rename from src/sdk/js/5/kuzzle/query/snippets/query-2.js rename to src/sdk/js/5/core-classes/kuzzle/query/snippets/query-2.js diff --git a/src/sdk/js/5/kuzzle/refresh-index/index.md b/src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/refresh-index/index.md rename to src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md diff --git a/src/sdk/js/5/kuzzle/refresh-index/snippets/refresh-index-1.js b/src/sdk/js/5/core-classes/kuzzle/refresh-index/snippets/refresh-index-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/refresh-index/snippets/refresh-index-1.js rename to src/sdk/js/5/core-classes/kuzzle/refresh-index/snippets/refresh-index-1.js diff --git a/src/sdk/js/5/kuzzle/remove-all-listeners/index.md b/src/sdk/js/5/core-classes/kuzzle/remove-all-listeners/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/remove-all-listeners/index.md rename to src/sdk/js/5/core-classes/kuzzle/remove-all-listeners/index.md diff --git a/src/sdk/js/5/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.js b/src/sdk/js/5/core-classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.js rename to src/sdk/js/5/core-classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.js diff --git a/src/sdk/js/5/kuzzle/remove-listener/index.md b/src/sdk/js/5/core-classes/kuzzle/remove-listener/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/remove-listener/index.md rename to src/sdk/js/5/core-classes/kuzzle/remove-listener/index.md diff --git a/src/sdk/js/5/kuzzle/remove-listener/snippets/remove-listener-1.js b/src/sdk/js/5/core-classes/kuzzle/remove-listener/snippets/remove-listener-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/remove-listener/snippets/remove-listener-1.js rename to src/sdk/js/5/core-classes/kuzzle/remove-listener/snippets/remove-listener-1.js diff --git a/src/sdk/js/5/kuzzle/replay-queue/index.md b/src/sdk/js/5/core-classes/kuzzle/replay-queue/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/replay-queue/index.md rename to src/sdk/js/5/core-classes/kuzzle/replay-queue/index.md diff --git a/src/sdk/js/5/kuzzle/replay-queue/snippets/replay-queue-1.js b/src/sdk/js/5/core-classes/kuzzle/replay-queue/snippets/replay-queue-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/replay-queue/snippets/replay-queue-1.js rename to src/sdk/js/5/core-classes/kuzzle/replay-queue/snippets/replay-queue-1.js diff --git a/src/sdk/js/5/kuzzle/security/index.md b/src/sdk/js/5/core-classes/kuzzle/security/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/security/index.md rename to src/sdk/js/5/core-classes/kuzzle/security/index.md diff --git a/src/sdk/js/5/kuzzle/set-auto-refresh/index.md b/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/set-auto-refresh/index.md rename to src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md diff --git a/src/sdk/js/5/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.js b/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.js rename to src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.js diff --git a/src/sdk/js/5/kuzzle/set-default-index/index.md b/src/sdk/js/5/core-classes/kuzzle/set-default-index/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/set-default-index/index.md rename to src/sdk/js/5/core-classes/kuzzle/set-default-index/index.md diff --git a/src/sdk/js/5/kuzzle/set-default-index/snippets/set-default-index-1.js b/src/sdk/js/5/core-classes/kuzzle/set-default-index/snippets/set-default-index-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/set-default-index/snippets/set-default-index-1.js rename to src/sdk/js/5/core-classes/kuzzle/set-default-index/snippets/set-default-index-1.js diff --git a/src/sdk/js/5/kuzzle/set-headers/index.md b/src/sdk/js/5/core-classes/kuzzle/set-headers/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/set-headers/index.md rename to src/sdk/js/5/core-classes/kuzzle/set-headers/index.md diff --git a/src/sdk/js/5/kuzzle/set-headers/snippets/set-headers-1.js b/src/sdk/js/5/core-classes/kuzzle/set-headers/snippets/set-headers-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/set-headers/snippets/set-headers-1.js rename to src/sdk/js/5/core-classes/kuzzle/set-headers/snippets/set-headers-1.js diff --git a/src/sdk/js/5/kuzzle/set-jwt-token/index.md b/src/sdk/js/5/core-classes/kuzzle/set-jwt-token/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/set-jwt-token/index.md rename to src/sdk/js/5/core-classes/kuzzle/set-jwt-token/index.md diff --git a/src/sdk/js/5/kuzzle/set-jwt-token/snippets/set-jwt-token-1.js b/src/sdk/js/5/core-classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/set-jwt-token/snippets/set-jwt-token-1.js rename to src/sdk/js/5/core-classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.js diff --git a/src/sdk/js/5/kuzzle/start-queuing/index.md b/src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/start-queuing/index.md rename to src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md diff --git a/src/sdk/js/5/kuzzle/start-queuing/snippets/start-queuing-1.js b/src/sdk/js/5/core-classes/kuzzle/start-queuing/snippets/start-queuing-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/start-queuing/snippets/start-queuing-1.js rename to src/sdk/js/5/core-classes/kuzzle/start-queuing/snippets/start-queuing-1.js diff --git a/src/sdk/js/5/kuzzle/stop-queuing/index.md b/src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/stop-queuing/index.md rename to src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md diff --git a/src/sdk/js/5/kuzzle/stop-queuing/snippets/stop-queuing-1.js b/src/sdk/js/5/core-classes/kuzzle/stop-queuing/snippets/stop-queuing-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/stop-queuing/snippets/stop-queuing-1.js rename to src/sdk/js/5/core-classes/kuzzle/stop-queuing/snippets/stop-queuing-1.js diff --git a/src/sdk/js/5/kuzzle/unset-jwt-token/index.md b/src/sdk/js/5/core-classes/kuzzle/unset-jwt-token/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/unset-jwt-token/index.md rename to src/sdk/js/5/core-classes/kuzzle/unset-jwt-token/index.md diff --git a/src/sdk/js/5/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.js b/src/sdk/js/5/core-classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.js rename to src/sdk/js/5/core-classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.js diff --git a/src/sdk/js/5/kuzzle/update-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/update-my-credentials/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/update-my-credentials/index.md rename to src/sdk/js/5/core-classes/kuzzle/update-my-credentials/index.md diff --git a/src/sdk/js/5/kuzzle/update-my-credentials/snippets/update-my-credentials-1.js b/src/sdk/js/5/core-classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/update-my-credentials/snippets/update-my-credentials-1.js rename to src/sdk/js/5/core-classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.js diff --git a/src/sdk/js/5/kuzzle/update-self/index.md b/src/sdk/js/5/core-classes/kuzzle/update-self/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/update-self/index.md rename to src/sdk/js/5/core-classes/kuzzle/update-self/index.md diff --git a/src/sdk/js/5/kuzzle/update-self/snippets/update-self-1.js b/src/sdk/js/5/core-classes/kuzzle/update-self/snippets/update-self-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/update-self/snippets/update-self-1.js rename to src/sdk/js/5/core-classes/kuzzle/update-self/snippets/update-self-1.js diff --git a/src/sdk/js/5/kuzzle/validate-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/validate-my-credentials/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/validate-my-credentials/index.md rename to src/sdk/js/5/core-classes/kuzzle/validate-my-credentials/index.md diff --git a/src/sdk/js/5/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.js b/src/sdk/js/5/core-classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.js rename to src/sdk/js/5/core-classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.js diff --git a/src/sdk/js/5/kuzzle/who-am-i/index.md b/src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md similarity index 100% rename from src/sdk/js/5/kuzzle/who-am-i/index.md rename to src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md diff --git a/src/sdk/js/5/kuzzle/who-am-i/snippets/who-am-i-1.js b/src/sdk/js/5/core-classes/kuzzle/who-am-i/snippets/who-am-i-1.js similarity index 100% rename from src/sdk/js/5/kuzzle/who-am-i/snippets/who-am-i-1.js rename to src/sdk/js/5/core-classes/kuzzle/who-am-i/snippets/who-am-i-1.js diff --git a/src/sdk/js/5/memory-storage/append/index.md b/src/sdk/js/5/core-classes/memory-storage/append/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/append/index.md rename to src/sdk/js/5/core-classes/memory-storage/append/index.md diff --git a/src/sdk/js/5/memory-storage/append/snippets/append-1.js b/src/sdk/js/5/core-classes/memory-storage/append/snippets/append-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/append/snippets/append-1.js rename to src/sdk/js/5/core-classes/memory-storage/append/snippets/append-1.js diff --git a/src/sdk/js/5/memory-storage/append/snippets/append-2.js b/src/sdk/js/5/core-classes/memory-storage/append/snippets/append-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/append/snippets/append-2.js rename to src/sdk/js/5/core-classes/memory-storage/append/snippets/append-2.js diff --git a/src/sdk/js/5/memory-storage/bitcount/index.md b/src/sdk/js/5/core-classes/memory-storage/bitcount/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/bitcount/index.md rename to src/sdk/js/5/core-classes/memory-storage/bitcount/index.md diff --git a/src/sdk/js/5/memory-storage/bitcount/snippets/bitcount-1.js b/src/sdk/js/5/core-classes/memory-storage/bitcount/snippets/bitcount-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitcount/snippets/bitcount-1.js rename to src/sdk/js/5/core-classes/memory-storage/bitcount/snippets/bitcount-1.js diff --git a/src/sdk/js/5/memory-storage/bitcount/snippets/bitcount-2.js b/src/sdk/js/5/core-classes/memory-storage/bitcount/snippets/bitcount-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitcount/snippets/bitcount-2.js rename to src/sdk/js/5/core-classes/memory-storage/bitcount/snippets/bitcount-2.js diff --git a/src/sdk/js/5/memory-storage/bitop/index.md b/src/sdk/js/5/core-classes/memory-storage/bitop/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/bitop/index.md rename to src/sdk/js/5/core-classes/memory-storage/bitop/index.md diff --git a/src/sdk/js/5/memory-storage/bitop/snippets/bitop-1.js b/src/sdk/js/5/core-classes/memory-storage/bitop/snippets/bitop-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitop/snippets/bitop-1.js rename to src/sdk/js/5/core-classes/memory-storage/bitop/snippets/bitop-1.js diff --git a/src/sdk/js/5/memory-storage/bitop/snippets/bitop-2.js b/src/sdk/js/5/core-classes/memory-storage/bitop/snippets/bitop-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitop/snippets/bitop-2.js rename to src/sdk/js/5/core-classes/memory-storage/bitop/snippets/bitop-2.js diff --git a/src/sdk/js/5/memory-storage/bitpos/index.md b/src/sdk/js/5/core-classes/memory-storage/bitpos/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/bitpos/index.md rename to src/sdk/js/5/core-classes/memory-storage/bitpos/index.md diff --git a/src/sdk/js/5/memory-storage/bitpos/snippets/bitpos-1.js b/src/sdk/js/5/core-classes/memory-storage/bitpos/snippets/bitpos-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitpos/snippets/bitpos-1.js rename to src/sdk/js/5/core-classes/memory-storage/bitpos/snippets/bitpos-1.js diff --git a/src/sdk/js/5/memory-storage/bitpos/snippets/bitpos-2.js b/src/sdk/js/5/core-classes/memory-storage/bitpos/snippets/bitpos-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/bitpos/snippets/bitpos-2.js rename to src/sdk/js/5/core-classes/memory-storage/bitpos/snippets/bitpos-2.js diff --git a/src/sdk/js/5/memory-storage/constructor/index.md b/src/sdk/js/5/core-classes/memory-storage/constructor/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/constructor/index.md rename to src/sdk/js/5/core-classes/memory-storage/constructor/index.md diff --git a/src/sdk/js/5/memory-storage/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/memory-storage/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/memory-storage/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/memory-storage/dbsize/index.md b/src/sdk/js/5/core-classes/memory-storage/dbsize/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/dbsize/index.md rename to src/sdk/js/5/core-classes/memory-storage/dbsize/index.md diff --git a/src/sdk/js/5/memory-storage/dbsize/snippets/dbsize-1.js b/src/sdk/js/5/core-classes/memory-storage/dbsize/snippets/dbsize-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/dbsize/snippets/dbsize-1.js rename to src/sdk/js/5/core-classes/memory-storage/dbsize/snippets/dbsize-1.js diff --git a/src/sdk/js/5/memory-storage/dbsize/snippets/dbsize-2.js b/src/sdk/js/5/core-classes/memory-storage/dbsize/snippets/dbsize-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/dbsize/snippets/dbsize-2.js rename to src/sdk/js/5/core-classes/memory-storage/dbsize/snippets/dbsize-2.js diff --git a/src/sdk/js/5/memory-storage/decr/index.md b/src/sdk/js/5/core-classes/memory-storage/decr/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/decr/index.md rename to src/sdk/js/5/core-classes/memory-storage/decr/index.md diff --git a/src/sdk/js/5/memory-storage/decr/snippets/decr-1.js b/src/sdk/js/5/core-classes/memory-storage/decr/snippets/decr-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/decr/snippets/decr-1.js rename to src/sdk/js/5/core-classes/memory-storage/decr/snippets/decr-1.js diff --git a/src/sdk/js/5/memory-storage/decr/snippets/decr-2.js b/src/sdk/js/5/core-classes/memory-storage/decr/snippets/decr-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/decr/snippets/decr-2.js rename to src/sdk/js/5/core-classes/memory-storage/decr/snippets/decr-2.js diff --git a/src/sdk/js/5/memory-storage/decrby/index.md b/src/sdk/js/5/core-classes/memory-storage/decrby/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/decrby/index.md rename to src/sdk/js/5/core-classes/memory-storage/decrby/index.md diff --git a/src/sdk/js/5/memory-storage/decrby/snippets/decrby-1.js b/src/sdk/js/5/core-classes/memory-storage/decrby/snippets/decrby-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/decrby/snippets/decrby-1.js rename to src/sdk/js/5/core-classes/memory-storage/decrby/snippets/decrby-1.js diff --git a/src/sdk/js/5/memory-storage/decrby/snippets/decrby-2.js b/src/sdk/js/5/core-classes/memory-storage/decrby/snippets/decrby-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/decrby/snippets/decrby-2.js rename to src/sdk/js/5/core-classes/memory-storage/decrby/snippets/decrby-2.js diff --git a/src/sdk/js/5/memory-storage/del/index.md b/src/sdk/js/5/core-classes/memory-storage/del/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/del/index.md rename to src/sdk/js/5/core-classes/memory-storage/del/index.md diff --git a/src/sdk/js/5/memory-storage/del/snippets/del-1.js b/src/sdk/js/5/core-classes/memory-storage/del/snippets/del-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/del/snippets/del-1.js rename to src/sdk/js/5/core-classes/memory-storage/del/snippets/del-1.js diff --git a/src/sdk/js/5/memory-storage/del/snippets/del-2.js b/src/sdk/js/5/core-classes/memory-storage/del/snippets/del-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/del/snippets/del-2.js rename to src/sdk/js/5/core-classes/memory-storage/del/snippets/del-2.js diff --git a/src/sdk/js/5/memory-storage/exists/index.md b/src/sdk/js/5/core-classes/memory-storage/exists/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/exists/index.md rename to src/sdk/js/5/core-classes/memory-storage/exists/index.md diff --git a/src/sdk/js/5/memory-storage/exists/snippets/exists-1.js b/src/sdk/js/5/core-classes/memory-storage/exists/snippets/exists-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/exists/snippets/exists-1.js rename to src/sdk/js/5/core-classes/memory-storage/exists/snippets/exists-1.js diff --git a/src/sdk/js/5/memory-storage/exists/snippets/exists-2.js b/src/sdk/js/5/core-classes/memory-storage/exists/snippets/exists-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/exists/snippets/exists-2.js rename to src/sdk/js/5/core-classes/memory-storage/exists/snippets/exists-2.js diff --git a/src/sdk/js/5/memory-storage/expire/index.md b/src/sdk/js/5/core-classes/memory-storage/expire/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/expire/index.md rename to src/sdk/js/5/core-classes/memory-storage/expire/index.md diff --git a/src/sdk/js/5/memory-storage/expire/snippets/expire-1.js b/src/sdk/js/5/core-classes/memory-storage/expire/snippets/expire-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/expire/snippets/expire-1.js rename to src/sdk/js/5/core-classes/memory-storage/expire/snippets/expire-1.js diff --git a/src/sdk/js/5/memory-storage/expire/snippets/expire-2.js b/src/sdk/js/5/core-classes/memory-storage/expire/snippets/expire-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/expire/snippets/expire-2.js rename to src/sdk/js/5/core-classes/memory-storage/expire/snippets/expire-2.js diff --git a/src/sdk/js/5/memory-storage/expireat/index.md b/src/sdk/js/5/core-classes/memory-storage/expireat/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/expireat/index.md rename to src/sdk/js/5/core-classes/memory-storage/expireat/index.md diff --git a/src/sdk/js/5/memory-storage/expireat/snippets/expireat-1.js b/src/sdk/js/5/core-classes/memory-storage/expireat/snippets/expireat-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/expireat/snippets/expireat-1.js rename to src/sdk/js/5/core-classes/memory-storage/expireat/snippets/expireat-1.js diff --git a/src/sdk/js/5/memory-storage/expireat/snippets/expireat-2.js b/src/sdk/js/5/core-classes/memory-storage/expireat/snippets/expireat-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/expireat/snippets/expireat-2.js rename to src/sdk/js/5/core-classes/memory-storage/expireat/snippets/expireat-2.js diff --git a/src/sdk/js/5/memory-storage/flushdb/index.md b/src/sdk/js/5/core-classes/memory-storage/flushdb/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/flushdb/index.md rename to src/sdk/js/5/core-classes/memory-storage/flushdb/index.md diff --git a/src/sdk/js/5/memory-storage/flushdb/snippets/flushdb-1.js b/src/sdk/js/5/core-classes/memory-storage/flushdb/snippets/flushdb-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/flushdb/snippets/flushdb-1.js rename to src/sdk/js/5/core-classes/memory-storage/flushdb/snippets/flushdb-1.js diff --git a/src/sdk/js/5/memory-storage/geoadd/index.md b/src/sdk/js/5/core-classes/memory-storage/geoadd/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/geoadd/index.md rename to src/sdk/js/5/core-classes/memory-storage/geoadd/index.md diff --git a/src/sdk/js/5/memory-storage/geoadd/snippets/geoadd-1.js b/src/sdk/js/5/core-classes/memory-storage/geoadd/snippets/geoadd-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/geoadd/snippets/geoadd-1.js rename to src/sdk/js/5/core-classes/memory-storage/geoadd/snippets/geoadd-1.js diff --git a/src/sdk/js/5/memory-storage/geoadd/snippets/geoadd-2.js b/src/sdk/js/5/core-classes/memory-storage/geoadd/snippets/geoadd-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/geoadd/snippets/geoadd-2.js rename to src/sdk/js/5/core-classes/memory-storage/geoadd/snippets/geoadd-2.js diff --git a/src/sdk/js/5/memory-storage/geodist/index.md b/src/sdk/js/5/core-classes/memory-storage/geodist/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/geodist/index.md rename to src/sdk/js/5/core-classes/memory-storage/geodist/index.md diff --git a/src/sdk/js/5/memory-storage/geodist/snippets/geodist-1.js b/src/sdk/js/5/core-classes/memory-storage/geodist/snippets/geodist-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/geodist/snippets/geodist-1.js rename to src/sdk/js/5/core-classes/memory-storage/geodist/snippets/geodist-1.js diff --git a/src/sdk/js/5/memory-storage/geodist/snippets/geodist-2.js b/src/sdk/js/5/core-classes/memory-storage/geodist/snippets/geodist-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/geodist/snippets/geodist-2.js rename to src/sdk/js/5/core-classes/memory-storage/geodist/snippets/geodist-2.js diff --git a/src/sdk/js/5/memory-storage/geohash/index.md b/src/sdk/js/5/core-classes/memory-storage/geohash/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/geohash/index.md rename to src/sdk/js/5/core-classes/memory-storage/geohash/index.md diff --git a/src/sdk/js/5/memory-storage/geohash/snippets/geohash-1.js b/src/sdk/js/5/core-classes/memory-storage/geohash/snippets/geohash-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/geohash/snippets/geohash-1.js rename to src/sdk/js/5/core-classes/memory-storage/geohash/snippets/geohash-1.js diff --git a/src/sdk/js/5/memory-storage/geohash/snippets/geohash-2.js b/src/sdk/js/5/core-classes/memory-storage/geohash/snippets/geohash-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/geohash/snippets/geohash-2.js rename to src/sdk/js/5/core-classes/memory-storage/geohash/snippets/geohash-2.js diff --git a/src/sdk/js/5/memory-storage/geopos/index.md b/src/sdk/js/5/core-classes/memory-storage/geopos/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/geopos/index.md rename to src/sdk/js/5/core-classes/memory-storage/geopos/index.md diff --git a/src/sdk/js/5/memory-storage/geopos/snippets/geopos-1.js b/src/sdk/js/5/core-classes/memory-storage/geopos/snippets/geopos-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/geopos/snippets/geopos-1.js rename to src/sdk/js/5/core-classes/memory-storage/geopos/snippets/geopos-1.js diff --git a/src/sdk/js/5/memory-storage/geopos/snippets/geopos-2.js b/src/sdk/js/5/core-classes/memory-storage/geopos/snippets/geopos-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/geopos/snippets/geopos-2.js rename to src/sdk/js/5/core-classes/memory-storage/geopos/snippets/geopos-2.js diff --git a/src/sdk/js/5/memory-storage/georadius/index.md b/src/sdk/js/5/core-classes/memory-storage/georadius/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/georadius/index.md rename to src/sdk/js/5/core-classes/memory-storage/georadius/index.md diff --git a/src/sdk/js/5/memory-storage/georadius/snippets/georadius-1.js b/src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadius/snippets/georadius-1.js rename to src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-1.js diff --git a/src/sdk/js/5/memory-storage/georadius/snippets/georadius-2.js b/src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadius/snippets/georadius-2.js rename to src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-2.js diff --git a/src/sdk/js/5/memory-storage/georadius/snippets/georadius-3.js b/src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-3.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadius/snippets/georadius-3.js rename to src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-3.js diff --git a/src/sdk/js/5/memory-storage/georadius/snippets/georadius-4.js b/src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-4.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadius/snippets/georadius-4.js rename to src/sdk/js/5/core-classes/memory-storage/georadius/snippets/georadius-4.js diff --git a/src/sdk/js/5/memory-storage/georadiusbymember/index.md b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/georadiusbymember/index.md rename to src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md diff --git a/src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-1.js b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-1.js rename to src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.js diff --git a/src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-2.js b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-2.js rename to src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-2.js diff --git a/src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-3.js b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-3.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-3.js rename to src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-3.js diff --git a/src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-4.js b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-4.js similarity index 100% rename from src/sdk/js/5/memory-storage/georadiusbymember/snippets/georadiusbymember-4.js rename to src/sdk/js/5/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-4.js diff --git a/src/sdk/js/5/memory-storage/get/index.md b/src/sdk/js/5/core-classes/memory-storage/get/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/get/index.md rename to src/sdk/js/5/core-classes/memory-storage/get/index.md diff --git a/src/sdk/js/5/memory-storage/get/snippets/get-1.js b/src/sdk/js/5/core-classes/memory-storage/get/snippets/get-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/get/snippets/get-1.js rename to src/sdk/js/5/core-classes/memory-storage/get/snippets/get-1.js diff --git a/src/sdk/js/5/memory-storage/get/snippets/get-2.js b/src/sdk/js/5/core-classes/memory-storage/get/snippets/get-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/get/snippets/get-2.js rename to src/sdk/js/5/core-classes/memory-storage/get/snippets/get-2.js diff --git a/src/sdk/js/5/memory-storage/getbit/index.md b/src/sdk/js/5/core-classes/memory-storage/getbit/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/getbit/index.md rename to src/sdk/js/5/core-classes/memory-storage/getbit/index.md diff --git a/src/sdk/js/5/memory-storage/getbit/snippets/getbit-1.js b/src/sdk/js/5/core-classes/memory-storage/getbit/snippets/getbit-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/getbit/snippets/getbit-1.js rename to src/sdk/js/5/core-classes/memory-storage/getbit/snippets/getbit-1.js diff --git a/src/sdk/js/5/memory-storage/getbit/snippets/getbit-2.js b/src/sdk/js/5/core-classes/memory-storage/getbit/snippets/getbit-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/getbit/snippets/getbit-2.js rename to src/sdk/js/5/core-classes/memory-storage/getbit/snippets/getbit-2.js diff --git a/src/sdk/js/5/memory-storage/getrange/index.md b/src/sdk/js/5/core-classes/memory-storage/getrange/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/getrange/index.md rename to src/sdk/js/5/core-classes/memory-storage/getrange/index.md diff --git a/src/sdk/js/5/memory-storage/getrange/snippets/getrange-1.js b/src/sdk/js/5/core-classes/memory-storage/getrange/snippets/getrange-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/getrange/snippets/getrange-1.js rename to src/sdk/js/5/core-classes/memory-storage/getrange/snippets/getrange-1.js diff --git a/src/sdk/js/5/memory-storage/getrange/snippets/getrange-2.js b/src/sdk/js/5/core-classes/memory-storage/getrange/snippets/getrange-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/getrange/snippets/getrange-2.js rename to src/sdk/js/5/core-classes/memory-storage/getrange/snippets/getrange-2.js diff --git a/src/sdk/js/5/memory-storage/getset/index.md b/src/sdk/js/5/core-classes/memory-storage/getset/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/getset/index.md rename to src/sdk/js/5/core-classes/memory-storage/getset/index.md diff --git a/src/sdk/js/5/memory-storage/getset/snippets/getset-1.js b/src/sdk/js/5/core-classes/memory-storage/getset/snippets/getset-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/getset/snippets/getset-1.js rename to src/sdk/js/5/core-classes/memory-storage/getset/snippets/getset-1.js diff --git a/src/sdk/js/5/memory-storage/getset/snippets/getset-2.js b/src/sdk/js/5/core-classes/memory-storage/getset/snippets/getset-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/getset/snippets/getset-2.js rename to src/sdk/js/5/core-classes/memory-storage/getset/snippets/getset-2.js diff --git a/src/sdk/js/5/memory-storage/hdel/index.md b/src/sdk/js/5/core-classes/memory-storage/hdel/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hdel/index.md rename to src/sdk/js/5/core-classes/memory-storage/hdel/index.md diff --git a/src/sdk/js/5/memory-storage/hdel/snippets/hdel-1.js b/src/sdk/js/5/core-classes/memory-storage/hdel/snippets/hdel-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hdel/snippets/hdel-1.js rename to src/sdk/js/5/core-classes/memory-storage/hdel/snippets/hdel-1.js diff --git a/src/sdk/js/5/memory-storage/hdel/snippets/hdel-2.js b/src/sdk/js/5/core-classes/memory-storage/hdel/snippets/hdel-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hdel/snippets/hdel-2.js rename to src/sdk/js/5/core-classes/memory-storage/hdel/snippets/hdel-2.js diff --git a/src/sdk/js/5/memory-storage/hexists/index.md b/src/sdk/js/5/core-classes/memory-storage/hexists/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hexists/index.md rename to src/sdk/js/5/core-classes/memory-storage/hexists/index.md diff --git a/src/sdk/js/5/memory-storage/hexists/snippets/hexists-1.js b/src/sdk/js/5/core-classes/memory-storage/hexists/snippets/hexists-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hexists/snippets/hexists-1.js rename to src/sdk/js/5/core-classes/memory-storage/hexists/snippets/hexists-1.js diff --git a/src/sdk/js/5/memory-storage/hexists/snippets/hexists-2.js b/src/sdk/js/5/core-classes/memory-storage/hexists/snippets/hexists-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hexists/snippets/hexists-2.js rename to src/sdk/js/5/core-classes/memory-storage/hexists/snippets/hexists-2.js diff --git a/src/sdk/js/5/memory-storage/hget/index.md b/src/sdk/js/5/core-classes/memory-storage/hget/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hget/index.md rename to src/sdk/js/5/core-classes/memory-storage/hget/index.md diff --git a/src/sdk/js/5/memory-storage/hget/snippets/hget-1.js b/src/sdk/js/5/core-classes/memory-storage/hget/snippets/hget-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hget/snippets/hget-1.js rename to src/sdk/js/5/core-classes/memory-storage/hget/snippets/hget-1.js diff --git a/src/sdk/js/5/memory-storage/hget/snippets/hget-2.js b/src/sdk/js/5/core-classes/memory-storage/hget/snippets/hget-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hget/snippets/hget-2.js rename to src/sdk/js/5/core-classes/memory-storage/hget/snippets/hget-2.js diff --git a/src/sdk/js/5/memory-storage/hgetall/index.md b/src/sdk/js/5/core-classes/memory-storage/hgetall/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hgetall/index.md rename to src/sdk/js/5/core-classes/memory-storage/hgetall/index.md diff --git a/src/sdk/js/5/memory-storage/hgetall/snippets/hgetall-1.js b/src/sdk/js/5/core-classes/memory-storage/hgetall/snippets/hgetall-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hgetall/snippets/hgetall-1.js rename to src/sdk/js/5/core-classes/memory-storage/hgetall/snippets/hgetall-1.js diff --git a/src/sdk/js/5/memory-storage/hgetall/snippets/hgetall-2.js b/src/sdk/js/5/core-classes/memory-storage/hgetall/snippets/hgetall-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hgetall/snippets/hgetall-2.js rename to src/sdk/js/5/core-classes/memory-storage/hgetall/snippets/hgetall-2.js diff --git a/src/sdk/js/5/memory-storage/hincrby/index.md b/src/sdk/js/5/core-classes/memory-storage/hincrby/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hincrby/index.md rename to src/sdk/js/5/core-classes/memory-storage/hincrby/index.md diff --git a/src/sdk/js/5/memory-storage/hincrby/snippets/hincrby-1.js b/src/sdk/js/5/core-classes/memory-storage/hincrby/snippets/hincrby-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hincrby/snippets/hincrby-1.js rename to src/sdk/js/5/core-classes/memory-storage/hincrby/snippets/hincrby-1.js diff --git a/src/sdk/js/5/memory-storage/hincrby/snippets/hincrby-2.js b/src/sdk/js/5/core-classes/memory-storage/hincrby/snippets/hincrby-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hincrby/snippets/hincrby-2.js rename to src/sdk/js/5/core-classes/memory-storage/hincrby/snippets/hincrby-2.js diff --git a/src/sdk/js/5/memory-storage/hincrbyfloat/index.md b/src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hincrbyfloat/index.md rename to src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/index.md diff --git a/src/sdk/js/5/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.js b/src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.js rename to src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.js diff --git a/src/sdk/js/5/memory-storage/hincrbyfloat/snippets/hincrbyfloat-2.js b/src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hincrbyfloat/snippets/hincrbyfloat-2.js rename to src/sdk/js/5/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-2.js diff --git a/src/sdk/js/5/memory-storage/hkeys/index.md b/src/sdk/js/5/core-classes/memory-storage/hkeys/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hkeys/index.md rename to src/sdk/js/5/core-classes/memory-storage/hkeys/index.md diff --git a/src/sdk/js/5/memory-storage/hkeys/snippets/hkeys-1.js b/src/sdk/js/5/core-classes/memory-storage/hkeys/snippets/hkeys-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hkeys/snippets/hkeys-1.js rename to src/sdk/js/5/core-classes/memory-storage/hkeys/snippets/hkeys-1.js diff --git a/src/sdk/js/5/memory-storage/hkeys/snippets/hkeys-2.js b/src/sdk/js/5/core-classes/memory-storage/hkeys/snippets/hkeys-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hkeys/snippets/hkeys-2.js rename to src/sdk/js/5/core-classes/memory-storage/hkeys/snippets/hkeys-2.js diff --git a/src/sdk/js/5/memory-storage/hlen/index.md b/src/sdk/js/5/core-classes/memory-storage/hlen/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hlen/index.md rename to src/sdk/js/5/core-classes/memory-storage/hlen/index.md diff --git a/src/sdk/js/5/memory-storage/hlen/snippets/hlen-1.js b/src/sdk/js/5/core-classes/memory-storage/hlen/snippets/hlen-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hlen/snippets/hlen-1.js rename to src/sdk/js/5/core-classes/memory-storage/hlen/snippets/hlen-1.js diff --git a/src/sdk/js/5/memory-storage/hlen/snippets/hlen-2.js b/src/sdk/js/5/core-classes/memory-storage/hlen/snippets/hlen-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hlen/snippets/hlen-2.js rename to src/sdk/js/5/core-classes/memory-storage/hlen/snippets/hlen-2.js diff --git a/src/sdk/js/5/memory-storage/hmget/index.md b/src/sdk/js/5/core-classes/memory-storage/hmget/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hmget/index.md rename to src/sdk/js/5/core-classes/memory-storage/hmget/index.md diff --git a/src/sdk/js/5/memory-storage/hmget/snippets/hmget-1.js b/src/sdk/js/5/core-classes/memory-storage/hmget/snippets/hmget-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hmget/snippets/hmget-1.js rename to src/sdk/js/5/core-classes/memory-storage/hmget/snippets/hmget-1.js diff --git a/src/sdk/js/5/memory-storage/hmget/snippets/hmget-2.js b/src/sdk/js/5/core-classes/memory-storage/hmget/snippets/hmget-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hmget/snippets/hmget-2.js rename to src/sdk/js/5/core-classes/memory-storage/hmget/snippets/hmget-2.js diff --git a/src/sdk/js/5/memory-storage/hmset/index.md b/src/sdk/js/5/core-classes/memory-storage/hmset/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hmset/index.md rename to src/sdk/js/5/core-classes/memory-storage/hmset/index.md diff --git a/src/sdk/js/5/memory-storage/hmset/snippets/hmset-1.js b/src/sdk/js/5/core-classes/memory-storage/hmset/snippets/hmset-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hmset/snippets/hmset-1.js rename to src/sdk/js/5/core-classes/memory-storage/hmset/snippets/hmset-1.js diff --git a/src/sdk/js/5/memory-storage/hscan/index.md b/src/sdk/js/5/core-classes/memory-storage/hscan/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hscan/index.md rename to src/sdk/js/5/core-classes/memory-storage/hscan/index.md diff --git a/src/sdk/js/5/memory-storage/hscan/snippets/hscan-1.js b/src/sdk/js/5/core-classes/memory-storage/hscan/snippets/hscan-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hscan/snippets/hscan-1.js rename to src/sdk/js/5/core-classes/memory-storage/hscan/snippets/hscan-1.js diff --git a/src/sdk/js/5/memory-storage/hscan/snippets/hscan-2.js b/src/sdk/js/5/core-classes/memory-storage/hscan/snippets/hscan-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hscan/snippets/hscan-2.js rename to src/sdk/js/5/core-classes/memory-storage/hscan/snippets/hscan-2.js diff --git a/src/sdk/js/5/memory-storage/hset/index.md b/src/sdk/js/5/core-classes/memory-storage/hset/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hset/index.md rename to src/sdk/js/5/core-classes/memory-storage/hset/index.md diff --git a/src/sdk/js/5/memory-storage/hset/snippets/hset-1.js b/src/sdk/js/5/core-classes/memory-storage/hset/snippets/hset-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hset/snippets/hset-1.js rename to src/sdk/js/5/core-classes/memory-storage/hset/snippets/hset-1.js diff --git a/src/sdk/js/5/memory-storage/hset/snippets/hset-2.js b/src/sdk/js/5/core-classes/memory-storage/hset/snippets/hset-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hset/snippets/hset-2.js rename to src/sdk/js/5/core-classes/memory-storage/hset/snippets/hset-2.js diff --git a/src/sdk/js/5/memory-storage/hsetnx/index.md b/src/sdk/js/5/core-classes/memory-storage/hsetnx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hsetnx/index.md rename to src/sdk/js/5/core-classes/memory-storage/hsetnx/index.md diff --git a/src/sdk/js/5/memory-storage/hsetnx/snippets/hsetnx-1.js b/src/sdk/js/5/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hsetnx/snippets/hsetnx-1.js rename to src/sdk/js/5/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.js diff --git a/src/sdk/js/5/memory-storage/hsetnx/snippets/hsetnx-2.js b/src/sdk/js/5/core-classes/memory-storage/hsetnx/snippets/hsetnx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hsetnx/snippets/hsetnx-2.js rename to src/sdk/js/5/core-classes/memory-storage/hsetnx/snippets/hsetnx-2.js diff --git a/src/sdk/js/5/memory-storage/hstrlen/index.md b/src/sdk/js/5/core-classes/memory-storage/hstrlen/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hstrlen/index.md rename to src/sdk/js/5/core-classes/memory-storage/hstrlen/index.md diff --git a/src/sdk/js/5/memory-storage/hstrlen/snippets/hstrlen-1.js b/src/sdk/js/5/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hstrlen/snippets/hstrlen-1.js rename to src/sdk/js/5/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.js diff --git a/src/sdk/js/5/memory-storage/hstrlen/snippets/hstrlen-2.js b/src/sdk/js/5/core-classes/memory-storage/hstrlen/snippets/hstrlen-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hstrlen/snippets/hstrlen-2.js rename to src/sdk/js/5/core-classes/memory-storage/hstrlen/snippets/hstrlen-2.js diff --git a/src/sdk/js/5/memory-storage/hvals/index.md b/src/sdk/js/5/core-classes/memory-storage/hvals/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/hvals/index.md rename to src/sdk/js/5/core-classes/memory-storage/hvals/index.md diff --git a/src/sdk/js/5/memory-storage/hvals/snippets/hvals-1.js b/src/sdk/js/5/core-classes/memory-storage/hvals/snippets/hvals-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/hvals/snippets/hvals-1.js rename to src/sdk/js/5/core-classes/memory-storage/hvals/snippets/hvals-1.js diff --git a/src/sdk/js/5/memory-storage/hvals/snippets/hvals-2.js b/src/sdk/js/5/core-classes/memory-storage/hvals/snippets/hvals-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/hvals/snippets/hvals-2.js rename to src/sdk/js/5/core-classes/memory-storage/hvals/snippets/hvals-2.js diff --git a/src/sdk/js/5/memory-storage/incr/index.md b/src/sdk/js/5/core-classes/memory-storage/incr/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/incr/index.md rename to src/sdk/js/5/core-classes/memory-storage/incr/index.md diff --git a/src/sdk/js/5/memory-storage/incr/snippets/incr-1.js b/src/sdk/js/5/core-classes/memory-storage/incr/snippets/incr-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/incr/snippets/incr-1.js rename to src/sdk/js/5/core-classes/memory-storage/incr/snippets/incr-1.js diff --git a/src/sdk/js/5/memory-storage/incr/snippets/incr-2.js b/src/sdk/js/5/core-classes/memory-storage/incr/snippets/incr-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/incr/snippets/incr-2.js rename to src/sdk/js/5/core-classes/memory-storage/incr/snippets/incr-2.js diff --git a/src/sdk/js/5/memory-storage/incrby/index.md b/src/sdk/js/5/core-classes/memory-storage/incrby/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/incrby/index.md rename to src/sdk/js/5/core-classes/memory-storage/incrby/index.md diff --git a/src/sdk/js/5/memory-storage/incrby/snippets/incrby-1.js b/src/sdk/js/5/core-classes/memory-storage/incrby/snippets/incrby-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/incrby/snippets/incrby-1.js rename to src/sdk/js/5/core-classes/memory-storage/incrby/snippets/incrby-1.js diff --git a/src/sdk/js/5/memory-storage/incrby/snippets/incrby-2.js b/src/sdk/js/5/core-classes/memory-storage/incrby/snippets/incrby-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/incrby/snippets/incrby-2.js rename to src/sdk/js/5/core-classes/memory-storage/incrby/snippets/incrby-2.js diff --git a/src/sdk/js/5/memory-storage/incrbyfloat/index.md b/src/sdk/js/5/core-classes/memory-storage/incrbyfloat/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/incrbyfloat/index.md rename to src/sdk/js/5/core-classes/memory-storage/incrbyfloat/index.md diff --git a/src/sdk/js/5/memory-storage/incrbyfloat/snippets/incrbyfloat-1.js b/src/sdk/js/5/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/incrbyfloat/snippets/incrbyfloat-1.js rename to src/sdk/js/5/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.js diff --git a/src/sdk/js/5/memory-storage/incrbyfloat/snippets/incrbyfloat-2.js b/src/sdk/js/5/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/incrbyfloat/snippets/incrbyfloat-2.js rename to src/sdk/js/5/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-2.js diff --git a/src/sdk/js/5/memory-storage/index.md b/src/sdk/js/5/core-classes/memory-storage/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/index.md rename to src/sdk/js/5/core-classes/memory-storage/index.md diff --git a/src/sdk/js/5/memory-storage/keys/index.md b/src/sdk/js/5/core-classes/memory-storage/keys/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/keys/index.md rename to src/sdk/js/5/core-classes/memory-storage/keys/index.md diff --git a/src/sdk/js/5/memory-storage/keys/snippets/keys-1.js b/src/sdk/js/5/core-classes/memory-storage/keys/snippets/keys-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/keys/snippets/keys-1.js rename to src/sdk/js/5/core-classes/memory-storage/keys/snippets/keys-1.js diff --git a/src/sdk/js/5/memory-storage/keys/snippets/keys-2.js b/src/sdk/js/5/core-classes/memory-storage/keys/snippets/keys-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/keys/snippets/keys-2.js rename to src/sdk/js/5/core-classes/memory-storage/keys/snippets/keys-2.js diff --git a/src/sdk/js/5/memory-storage/lindex/index.md b/src/sdk/js/5/core-classes/memory-storage/lindex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lindex/index.md rename to src/sdk/js/5/core-classes/memory-storage/lindex/index.md diff --git a/src/sdk/js/5/memory-storage/lindex/snippets/lindex-1.js b/src/sdk/js/5/core-classes/memory-storage/lindex/snippets/lindex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lindex/snippets/lindex-1.js rename to src/sdk/js/5/core-classes/memory-storage/lindex/snippets/lindex-1.js diff --git a/src/sdk/js/5/memory-storage/lindex/snippets/lindex-2.js b/src/sdk/js/5/core-classes/memory-storage/lindex/snippets/lindex-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lindex/snippets/lindex-2.js rename to src/sdk/js/5/core-classes/memory-storage/lindex/snippets/lindex-2.js diff --git a/src/sdk/js/5/memory-storage/linsert/index.md b/src/sdk/js/5/core-classes/memory-storage/linsert/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/linsert/index.md rename to src/sdk/js/5/core-classes/memory-storage/linsert/index.md diff --git a/src/sdk/js/5/memory-storage/linsert/snippets/linsert-1.js b/src/sdk/js/5/core-classes/memory-storage/linsert/snippets/linsert-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/linsert/snippets/linsert-1.js rename to src/sdk/js/5/core-classes/memory-storage/linsert/snippets/linsert-1.js diff --git a/src/sdk/js/5/memory-storage/linsert/snippets/linsert-2.js b/src/sdk/js/5/core-classes/memory-storage/linsert/snippets/linsert-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/linsert/snippets/linsert-2.js rename to src/sdk/js/5/core-classes/memory-storage/linsert/snippets/linsert-2.js diff --git a/src/sdk/js/5/memory-storage/llen/index.md b/src/sdk/js/5/core-classes/memory-storage/llen/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/llen/index.md rename to src/sdk/js/5/core-classes/memory-storage/llen/index.md diff --git a/src/sdk/js/5/memory-storage/llen/snippets/llen-1.js b/src/sdk/js/5/core-classes/memory-storage/llen/snippets/llen-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/llen/snippets/llen-1.js rename to src/sdk/js/5/core-classes/memory-storage/llen/snippets/llen-1.js diff --git a/src/sdk/js/5/memory-storage/llen/snippets/llen-2.js b/src/sdk/js/5/core-classes/memory-storage/llen/snippets/llen-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/llen/snippets/llen-2.js rename to src/sdk/js/5/core-classes/memory-storage/llen/snippets/llen-2.js diff --git a/src/sdk/js/5/memory-storage/lpop/index.md b/src/sdk/js/5/core-classes/memory-storage/lpop/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lpop/index.md rename to src/sdk/js/5/core-classes/memory-storage/lpop/index.md diff --git a/src/sdk/js/5/memory-storage/lpop/snippets/lpop-1.js b/src/sdk/js/5/core-classes/memory-storage/lpop/snippets/lpop-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpop/snippets/lpop-1.js rename to src/sdk/js/5/core-classes/memory-storage/lpop/snippets/lpop-1.js diff --git a/src/sdk/js/5/memory-storage/lpop/snippets/lpop-2.js b/src/sdk/js/5/core-classes/memory-storage/lpop/snippets/lpop-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpop/snippets/lpop-2.js rename to src/sdk/js/5/core-classes/memory-storage/lpop/snippets/lpop-2.js diff --git a/src/sdk/js/5/memory-storage/lpush/index.md b/src/sdk/js/5/core-classes/memory-storage/lpush/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lpush/index.md rename to src/sdk/js/5/core-classes/memory-storage/lpush/index.md diff --git a/src/sdk/js/5/memory-storage/lpush/snippets/lpush-1.js b/src/sdk/js/5/core-classes/memory-storage/lpush/snippets/lpush-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpush/snippets/lpush-1.js rename to src/sdk/js/5/core-classes/memory-storage/lpush/snippets/lpush-1.js diff --git a/src/sdk/js/5/memory-storage/lpush/snippets/lpush-2.js b/src/sdk/js/5/core-classes/memory-storage/lpush/snippets/lpush-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpush/snippets/lpush-2.js rename to src/sdk/js/5/core-classes/memory-storage/lpush/snippets/lpush-2.js diff --git a/src/sdk/js/5/memory-storage/lpushx/index.md b/src/sdk/js/5/core-classes/memory-storage/lpushx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lpushx/index.md rename to src/sdk/js/5/core-classes/memory-storage/lpushx/index.md diff --git a/src/sdk/js/5/memory-storage/lpushx/snippets/lpushx-1.js b/src/sdk/js/5/core-classes/memory-storage/lpushx/snippets/lpushx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpushx/snippets/lpushx-1.js rename to src/sdk/js/5/core-classes/memory-storage/lpushx/snippets/lpushx-1.js diff --git a/src/sdk/js/5/memory-storage/lpushx/snippets/lpushx-2.js b/src/sdk/js/5/core-classes/memory-storage/lpushx/snippets/lpushx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lpushx/snippets/lpushx-2.js rename to src/sdk/js/5/core-classes/memory-storage/lpushx/snippets/lpushx-2.js diff --git a/src/sdk/js/5/memory-storage/lrange/index.md b/src/sdk/js/5/core-classes/memory-storage/lrange/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lrange/index.md rename to src/sdk/js/5/core-classes/memory-storage/lrange/index.md diff --git a/src/sdk/js/5/memory-storage/lrange/snippets/lrange-1.js b/src/sdk/js/5/core-classes/memory-storage/lrange/snippets/lrange-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lrange/snippets/lrange-1.js rename to src/sdk/js/5/core-classes/memory-storage/lrange/snippets/lrange-1.js diff --git a/src/sdk/js/5/memory-storage/lrange/snippets/lrange-2.js b/src/sdk/js/5/core-classes/memory-storage/lrange/snippets/lrange-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lrange/snippets/lrange-2.js rename to src/sdk/js/5/core-classes/memory-storage/lrange/snippets/lrange-2.js diff --git a/src/sdk/js/5/memory-storage/lrem/index.md b/src/sdk/js/5/core-classes/memory-storage/lrem/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lrem/index.md rename to src/sdk/js/5/core-classes/memory-storage/lrem/index.md diff --git a/src/sdk/js/5/memory-storage/lrem/snippets/lrem-1.js b/src/sdk/js/5/core-classes/memory-storage/lrem/snippets/lrem-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lrem/snippets/lrem-1.js rename to src/sdk/js/5/core-classes/memory-storage/lrem/snippets/lrem-1.js diff --git a/src/sdk/js/5/memory-storage/lrem/snippets/lrem-2.js b/src/sdk/js/5/core-classes/memory-storage/lrem/snippets/lrem-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/lrem/snippets/lrem-2.js rename to src/sdk/js/5/core-classes/memory-storage/lrem/snippets/lrem-2.js diff --git a/src/sdk/js/5/memory-storage/lset/index.md b/src/sdk/js/5/core-classes/memory-storage/lset/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/lset/index.md rename to src/sdk/js/5/core-classes/memory-storage/lset/index.md diff --git a/src/sdk/js/5/memory-storage/lset/snippets/lset-1.js b/src/sdk/js/5/core-classes/memory-storage/lset/snippets/lset-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/lset/snippets/lset-1.js rename to src/sdk/js/5/core-classes/memory-storage/lset/snippets/lset-1.js diff --git a/src/sdk/js/5/memory-storage/ltrim/index.md b/src/sdk/js/5/core-classes/memory-storage/ltrim/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/ltrim/index.md rename to src/sdk/js/5/core-classes/memory-storage/ltrim/index.md diff --git a/src/sdk/js/5/memory-storage/ltrim/snippets/ltrim-1.js b/src/sdk/js/5/core-classes/memory-storage/ltrim/snippets/ltrim-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/ltrim/snippets/ltrim-1.js rename to src/sdk/js/5/core-classes/memory-storage/ltrim/snippets/ltrim-1.js diff --git a/src/sdk/js/5/memory-storage/mget/index.md b/src/sdk/js/5/core-classes/memory-storage/mget/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/mget/index.md rename to src/sdk/js/5/core-classes/memory-storage/mget/index.md diff --git a/src/sdk/js/5/memory-storage/mget/snippets/mget-1.js b/src/sdk/js/5/core-classes/memory-storage/mget/snippets/mget-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/mget/snippets/mget-1.js rename to src/sdk/js/5/core-classes/memory-storage/mget/snippets/mget-1.js diff --git a/src/sdk/js/5/memory-storage/mget/snippets/mget-2.js b/src/sdk/js/5/core-classes/memory-storage/mget/snippets/mget-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/mget/snippets/mget-2.js rename to src/sdk/js/5/core-classes/memory-storage/mget/snippets/mget-2.js diff --git a/src/sdk/js/5/memory-storage/mset/index.md b/src/sdk/js/5/core-classes/memory-storage/mset/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/mset/index.md rename to src/sdk/js/5/core-classes/memory-storage/mset/index.md diff --git a/src/sdk/js/5/memory-storage/mset/snippets/mset-1.js b/src/sdk/js/5/core-classes/memory-storage/mset/snippets/mset-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/mset/snippets/mset-1.js rename to src/sdk/js/5/core-classes/memory-storage/mset/snippets/mset-1.js diff --git a/src/sdk/js/5/memory-storage/msetnx/index.md b/src/sdk/js/5/core-classes/memory-storage/msetnx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/msetnx/index.md rename to src/sdk/js/5/core-classes/memory-storage/msetnx/index.md diff --git a/src/sdk/js/5/memory-storage/msetnx/snippets/msetnx-1.js b/src/sdk/js/5/core-classes/memory-storage/msetnx/snippets/msetnx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/msetnx/snippets/msetnx-1.js rename to src/sdk/js/5/core-classes/memory-storage/msetnx/snippets/msetnx-1.js diff --git a/src/sdk/js/5/memory-storage/msetnx/snippets/msetnx-2.js b/src/sdk/js/5/core-classes/memory-storage/msetnx/snippets/msetnx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/msetnx/snippets/msetnx-2.js rename to src/sdk/js/5/core-classes/memory-storage/msetnx/snippets/msetnx-2.js diff --git a/src/sdk/js/5/memory-storage/object/index.md b/src/sdk/js/5/core-classes/memory-storage/object/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/object/index.md rename to src/sdk/js/5/core-classes/memory-storage/object/index.md diff --git a/src/sdk/js/5/memory-storage/object/snippets/object-1.js b/src/sdk/js/5/core-classes/memory-storage/object/snippets/object-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/object/snippets/object-1.js rename to src/sdk/js/5/core-classes/memory-storage/object/snippets/object-1.js diff --git a/src/sdk/js/5/memory-storage/object/snippets/object-2.js b/src/sdk/js/5/core-classes/memory-storage/object/snippets/object-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/object/snippets/object-2.js rename to src/sdk/js/5/core-classes/memory-storage/object/snippets/object-2.js diff --git a/src/sdk/js/5/memory-storage/persist/index.md b/src/sdk/js/5/core-classes/memory-storage/persist/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/persist/index.md rename to src/sdk/js/5/core-classes/memory-storage/persist/index.md diff --git a/src/sdk/js/5/memory-storage/persist/snippets/persist-1.js b/src/sdk/js/5/core-classes/memory-storage/persist/snippets/persist-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/persist/snippets/persist-1.js rename to src/sdk/js/5/core-classes/memory-storage/persist/snippets/persist-1.js diff --git a/src/sdk/js/5/memory-storage/persist/snippets/persist-2.js b/src/sdk/js/5/core-classes/memory-storage/persist/snippets/persist-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/persist/snippets/persist-2.js rename to src/sdk/js/5/core-classes/memory-storage/persist/snippets/persist-2.js diff --git a/src/sdk/js/5/memory-storage/pexpire/index.md b/src/sdk/js/5/core-classes/memory-storage/pexpire/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pexpire/index.md rename to src/sdk/js/5/core-classes/memory-storage/pexpire/index.md diff --git a/src/sdk/js/5/memory-storage/pexpire/snippets/pexpire-1.js b/src/sdk/js/5/core-classes/memory-storage/pexpire/snippets/pexpire-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pexpire/snippets/pexpire-1.js rename to src/sdk/js/5/core-classes/memory-storage/pexpire/snippets/pexpire-1.js diff --git a/src/sdk/js/5/memory-storage/pexpire/snippets/pexpire-2.js b/src/sdk/js/5/core-classes/memory-storage/pexpire/snippets/pexpire-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/pexpire/snippets/pexpire-2.js rename to src/sdk/js/5/core-classes/memory-storage/pexpire/snippets/pexpire-2.js diff --git a/src/sdk/js/5/memory-storage/pexpireat/index.md b/src/sdk/js/5/core-classes/memory-storage/pexpireat/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pexpireat/index.md rename to src/sdk/js/5/core-classes/memory-storage/pexpireat/index.md diff --git a/src/sdk/js/5/memory-storage/pexpireat/snippets/pexpireat-1.js b/src/sdk/js/5/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pexpireat/snippets/pexpireat-1.js rename to src/sdk/js/5/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.js diff --git a/src/sdk/js/5/memory-storage/pexpireat/snippets/pexpireat-2.js b/src/sdk/js/5/core-classes/memory-storage/pexpireat/snippets/pexpireat-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/pexpireat/snippets/pexpireat-2.js rename to src/sdk/js/5/core-classes/memory-storage/pexpireat/snippets/pexpireat-2.js diff --git a/src/sdk/js/5/memory-storage/pfadd/index.md b/src/sdk/js/5/core-classes/memory-storage/pfadd/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pfadd/index.md rename to src/sdk/js/5/core-classes/memory-storage/pfadd/index.md diff --git a/src/sdk/js/5/memory-storage/pfadd/snippets/pfadd-1.js b/src/sdk/js/5/core-classes/memory-storage/pfadd/snippets/pfadd-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pfadd/snippets/pfadd-1.js rename to src/sdk/js/5/core-classes/memory-storage/pfadd/snippets/pfadd-1.js diff --git a/src/sdk/js/5/memory-storage/pfadd/snippets/pfadd-2.js b/src/sdk/js/5/core-classes/memory-storage/pfadd/snippets/pfadd-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/pfadd/snippets/pfadd-2.js rename to src/sdk/js/5/core-classes/memory-storage/pfadd/snippets/pfadd-2.js diff --git a/src/sdk/js/5/memory-storage/pfcount/index.md b/src/sdk/js/5/core-classes/memory-storage/pfcount/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pfcount/index.md rename to src/sdk/js/5/core-classes/memory-storage/pfcount/index.md diff --git a/src/sdk/js/5/memory-storage/pfcount/snippets/pfcount-1.js b/src/sdk/js/5/core-classes/memory-storage/pfcount/snippets/pfcount-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pfcount/snippets/pfcount-1.js rename to src/sdk/js/5/core-classes/memory-storage/pfcount/snippets/pfcount-1.js diff --git a/src/sdk/js/5/memory-storage/pfcount/snippets/pfcount-2.js b/src/sdk/js/5/core-classes/memory-storage/pfcount/snippets/pfcount-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/pfcount/snippets/pfcount-2.js rename to src/sdk/js/5/core-classes/memory-storage/pfcount/snippets/pfcount-2.js diff --git a/src/sdk/js/5/memory-storage/pfmerge/index.md b/src/sdk/js/5/core-classes/memory-storage/pfmerge/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pfmerge/index.md rename to src/sdk/js/5/core-classes/memory-storage/pfmerge/index.md diff --git a/src/sdk/js/5/memory-storage/pfmerge/snippets/pfmerge-1.js b/src/sdk/js/5/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pfmerge/snippets/pfmerge-1.js rename to src/sdk/js/5/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.js diff --git a/src/sdk/js/5/memory-storage/ping/index.md b/src/sdk/js/5/core-classes/memory-storage/ping/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/ping/index.md rename to src/sdk/js/5/core-classes/memory-storage/ping/index.md diff --git a/src/sdk/js/5/memory-storage/ping/snippets/ping-1.js b/src/sdk/js/5/core-classes/memory-storage/ping/snippets/ping-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/ping/snippets/ping-1.js rename to src/sdk/js/5/core-classes/memory-storage/ping/snippets/ping-1.js diff --git a/src/sdk/js/5/memory-storage/ping/snippets/ping-2.js b/src/sdk/js/5/core-classes/memory-storage/ping/snippets/ping-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/ping/snippets/ping-2.js rename to src/sdk/js/5/core-classes/memory-storage/ping/snippets/ping-2.js diff --git a/src/sdk/js/5/memory-storage/psetex/index.md b/src/sdk/js/5/core-classes/memory-storage/psetex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/psetex/index.md rename to src/sdk/js/5/core-classes/memory-storage/psetex/index.md diff --git a/src/sdk/js/5/memory-storage/psetex/snippets/psetex-1.js b/src/sdk/js/5/core-classes/memory-storage/psetex/snippets/psetex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/psetex/snippets/psetex-1.js rename to src/sdk/js/5/core-classes/memory-storage/psetex/snippets/psetex-1.js diff --git a/src/sdk/js/5/memory-storage/pttl/index.md b/src/sdk/js/5/core-classes/memory-storage/pttl/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/pttl/index.md rename to src/sdk/js/5/core-classes/memory-storage/pttl/index.md diff --git a/src/sdk/js/5/memory-storage/pttl/snippets/pttl-1.js b/src/sdk/js/5/core-classes/memory-storage/pttl/snippets/pttl-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/pttl/snippets/pttl-1.js rename to src/sdk/js/5/core-classes/memory-storage/pttl/snippets/pttl-1.js diff --git a/src/sdk/js/5/memory-storage/pttl/snippets/pttl-2.js b/src/sdk/js/5/core-classes/memory-storage/pttl/snippets/pttl-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/pttl/snippets/pttl-2.js rename to src/sdk/js/5/core-classes/memory-storage/pttl/snippets/pttl-2.js diff --git a/src/sdk/js/5/memory-storage/randomkey/index.md b/src/sdk/js/5/core-classes/memory-storage/randomkey/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/randomkey/index.md rename to src/sdk/js/5/core-classes/memory-storage/randomkey/index.md diff --git a/src/sdk/js/5/memory-storage/randomkey/snippets/randomkey-1.js b/src/sdk/js/5/core-classes/memory-storage/randomkey/snippets/randomkey-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/randomkey/snippets/randomkey-1.js rename to src/sdk/js/5/core-classes/memory-storage/randomkey/snippets/randomkey-1.js diff --git a/src/sdk/js/5/memory-storage/randomkey/snippets/randomkey-2.js b/src/sdk/js/5/core-classes/memory-storage/randomkey/snippets/randomkey-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/randomkey/snippets/randomkey-2.js rename to src/sdk/js/5/core-classes/memory-storage/randomkey/snippets/randomkey-2.js diff --git a/src/sdk/js/5/memory-storage/rename/index.md b/src/sdk/js/5/core-classes/memory-storage/rename/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/rename/index.md rename to src/sdk/js/5/core-classes/memory-storage/rename/index.md diff --git a/src/sdk/js/5/memory-storage/rename/snippets/rename-1.js b/src/sdk/js/5/core-classes/memory-storage/rename/snippets/rename-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/rename/snippets/rename-1.js rename to src/sdk/js/5/core-classes/memory-storage/rename/snippets/rename-1.js diff --git a/src/sdk/js/5/memory-storage/renamenx/index.md b/src/sdk/js/5/core-classes/memory-storage/renamenx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/renamenx/index.md rename to src/sdk/js/5/core-classes/memory-storage/renamenx/index.md diff --git a/src/sdk/js/5/memory-storage/renamenx/snippets/renamenx-1.js b/src/sdk/js/5/core-classes/memory-storage/renamenx/snippets/renamenx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/renamenx/snippets/renamenx-1.js rename to src/sdk/js/5/core-classes/memory-storage/renamenx/snippets/renamenx-1.js diff --git a/src/sdk/js/5/memory-storage/renamenx/snippets/renamenx-2.js b/src/sdk/js/5/core-classes/memory-storage/renamenx/snippets/renamenx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/renamenx/snippets/renamenx-2.js rename to src/sdk/js/5/core-classes/memory-storage/renamenx/snippets/renamenx-2.js diff --git a/src/sdk/js/5/memory-storage/rpop/index.md b/src/sdk/js/5/core-classes/memory-storage/rpop/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/rpop/index.md rename to src/sdk/js/5/core-classes/memory-storage/rpop/index.md diff --git a/src/sdk/js/5/memory-storage/rpop/snippets/rpop-1.js b/src/sdk/js/5/core-classes/memory-storage/rpop/snippets/rpop-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpop/snippets/rpop-1.js rename to src/sdk/js/5/core-classes/memory-storage/rpop/snippets/rpop-1.js diff --git a/src/sdk/js/5/memory-storage/rpop/snippets/rpop-2.js b/src/sdk/js/5/core-classes/memory-storage/rpop/snippets/rpop-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpop/snippets/rpop-2.js rename to src/sdk/js/5/core-classes/memory-storage/rpop/snippets/rpop-2.js diff --git a/src/sdk/js/5/memory-storage/rpoplpush/index.md b/src/sdk/js/5/core-classes/memory-storage/rpoplpush/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/rpoplpush/index.md rename to src/sdk/js/5/core-classes/memory-storage/rpoplpush/index.md diff --git a/src/sdk/js/5/memory-storage/rpoplpush/snippets/rpoplpush-1.js b/src/sdk/js/5/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpoplpush/snippets/rpoplpush-1.js rename to src/sdk/js/5/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.js diff --git a/src/sdk/js/5/memory-storage/rpoplpush/snippets/rpoplpush-2.js b/src/sdk/js/5/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpoplpush/snippets/rpoplpush-2.js rename to src/sdk/js/5/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-2.js diff --git a/src/sdk/js/5/memory-storage/rpush/index.md b/src/sdk/js/5/core-classes/memory-storage/rpush/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/rpush/index.md rename to src/sdk/js/5/core-classes/memory-storage/rpush/index.md diff --git a/src/sdk/js/5/memory-storage/rpush/snippets/rpush-1.js b/src/sdk/js/5/core-classes/memory-storage/rpush/snippets/rpush-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpush/snippets/rpush-1.js rename to src/sdk/js/5/core-classes/memory-storage/rpush/snippets/rpush-1.js diff --git a/src/sdk/js/5/memory-storage/rpush/snippets/rpush-2.js b/src/sdk/js/5/core-classes/memory-storage/rpush/snippets/rpush-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpush/snippets/rpush-2.js rename to src/sdk/js/5/core-classes/memory-storage/rpush/snippets/rpush-2.js diff --git a/src/sdk/js/5/memory-storage/rpushx/index.md b/src/sdk/js/5/core-classes/memory-storage/rpushx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/rpushx/index.md rename to src/sdk/js/5/core-classes/memory-storage/rpushx/index.md diff --git a/src/sdk/js/5/memory-storage/rpushx/snippets/rpushx-1.js b/src/sdk/js/5/core-classes/memory-storage/rpushx/snippets/rpushx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpushx/snippets/rpushx-1.js rename to src/sdk/js/5/core-classes/memory-storage/rpushx/snippets/rpushx-1.js diff --git a/src/sdk/js/5/memory-storage/rpushx/snippets/rpushx-2.js b/src/sdk/js/5/core-classes/memory-storage/rpushx/snippets/rpushx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/rpushx/snippets/rpushx-2.js rename to src/sdk/js/5/core-classes/memory-storage/rpushx/snippets/rpushx-2.js diff --git a/src/sdk/js/5/memory-storage/sadd/index.md b/src/sdk/js/5/core-classes/memory-storage/sadd/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sadd/index.md rename to src/sdk/js/5/core-classes/memory-storage/sadd/index.md diff --git a/src/sdk/js/5/memory-storage/sadd/snippets/sadd-1.js b/src/sdk/js/5/core-classes/memory-storage/sadd/snippets/sadd-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sadd/snippets/sadd-1.js rename to src/sdk/js/5/core-classes/memory-storage/sadd/snippets/sadd-1.js diff --git a/src/sdk/js/5/memory-storage/sadd/snippets/sadd-2.js b/src/sdk/js/5/core-classes/memory-storage/sadd/snippets/sadd-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sadd/snippets/sadd-2.js rename to src/sdk/js/5/core-classes/memory-storage/sadd/snippets/sadd-2.js diff --git a/src/sdk/js/5/memory-storage/scan/index.md b/src/sdk/js/5/core-classes/memory-storage/scan/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/scan/index.md rename to src/sdk/js/5/core-classes/memory-storage/scan/index.md diff --git a/src/sdk/js/5/memory-storage/scan/snippets/scan-1.js b/src/sdk/js/5/core-classes/memory-storage/scan/snippets/scan-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/scan/snippets/scan-1.js rename to src/sdk/js/5/core-classes/memory-storage/scan/snippets/scan-1.js diff --git a/src/sdk/js/5/memory-storage/scan/snippets/scan-2.js b/src/sdk/js/5/core-classes/memory-storage/scan/snippets/scan-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/scan/snippets/scan-2.js rename to src/sdk/js/5/core-classes/memory-storage/scan/snippets/scan-2.js diff --git a/src/sdk/js/5/memory-storage/scard/index.md b/src/sdk/js/5/core-classes/memory-storage/scard/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/scard/index.md rename to src/sdk/js/5/core-classes/memory-storage/scard/index.md diff --git a/src/sdk/js/5/memory-storage/scard/snippets/scard-1.js b/src/sdk/js/5/core-classes/memory-storage/scard/snippets/scard-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/scard/snippets/scard-1.js rename to src/sdk/js/5/core-classes/memory-storage/scard/snippets/scard-1.js diff --git a/src/sdk/js/5/memory-storage/scard/snippets/scard-2.js b/src/sdk/js/5/core-classes/memory-storage/scard/snippets/scard-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/scard/snippets/scard-2.js rename to src/sdk/js/5/core-classes/memory-storage/scard/snippets/scard-2.js diff --git a/src/sdk/js/5/memory-storage/sdiff/index.md b/src/sdk/js/5/core-classes/memory-storage/sdiff/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sdiff/index.md rename to src/sdk/js/5/core-classes/memory-storage/sdiff/index.md diff --git a/src/sdk/js/5/memory-storage/sdiff/snippets/sdiff-1.js b/src/sdk/js/5/core-classes/memory-storage/sdiff/snippets/sdiff-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sdiff/snippets/sdiff-1.js rename to src/sdk/js/5/core-classes/memory-storage/sdiff/snippets/sdiff-1.js diff --git a/src/sdk/js/5/memory-storage/sdiff/snippets/sdiff-2.js b/src/sdk/js/5/core-classes/memory-storage/sdiff/snippets/sdiff-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sdiff/snippets/sdiff-2.js rename to src/sdk/js/5/core-classes/memory-storage/sdiff/snippets/sdiff-2.js diff --git a/src/sdk/js/5/memory-storage/sdiffstore/index.md b/src/sdk/js/5/core-classes/memory-storage/sdiffstore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sdiffstore/index.md rename to src/sdk/js/5/core-classes/memory-storage/sdiffstore/index.md diff --git a/src/sdk/js/5/memory-storage/sdiffstore/snippets/sdiffstore-1.js b/src/sdk/js/5/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sdiffstore/snippets/sdiffstore-1.js rename to src/sdk/js/5/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.js diff --git a/src/sdk/js/5/memory-storage/sdiffstore/snippets/sdiffstore-2.js b/src/sdk/js/5/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sdiffstore/snippets/sdiffstore-2.js rename to src/sdk/js/5/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-2.js diff --git a/src/sdk/js/5/memory-storage/set/index.md b/src/sdk/js/5/core-classes/memory-storage/set/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/set/index.md rename to src/sdk/js/5/core-classes/memory-storage/set/index.md diff --git a/src/sdk/js/5/memory-storage/set/snippets/set-1.js b/src/sdk/js/5/core-classes/memory-storage/set/snippets/set-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/set/snippets/set-1.js rename to src/sdk/js/5/core-classes/memory-storage/set/snippets/set-1.js diff --git a/src/sdk/js/5/memory-storage/setex/index.md b/src/sdk/js/5/core-classes/memory-storage/setex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/setex/index.md rename to src/sdk/js/5/core-classes/memory-storage/setex/index.md diff --git a/src/sdk/js/5/memory-storage/setex/snippets/setex-1.js b/src/sdk/js/5/core-classes/memory-storage/setex/snippets/setex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/setex/snippets/setex-1.js rename to src/sdk/js/5/core-classes/memory-storage/setex/snippets/setex-1.js diff --git a/src/sdk/js/5/memory-storage/setnx/index.md b/src/sdk/js/5/core-classes/memory-storage/setnx/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/setnx/index.md rename to src/sdk/js/5/core-classes/memory-storage/setnx/index.md diff --git a/src/sdk/js/5/memory-storage/setnx/snippets/setnx-1.js b/src/sdk/js/5/core-classes/memory-storage/setnx/snippets/setnx-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/setnx/snippets/setnx-1.js rename to src/sdk/js/5/core-classes/memory-storage/setnx/snippets/setnx-1.js diff --git a/src/sdk/js/5/memory-storage/setnx/snippets/setnx-2.js b/src/sdk/js/5/core-classes/memory-storage/setnx/snippets/setnx-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/setnx/snippets/setnx-2.js rename to src/sdk/js/5/core-classes/memory-storage/setnx/snippets/setnx-2.js diff --git a/src/sdk/js/5/memory-storage/sinter/index.md b/src/sdk/js/5/core-classes/memory-storage/sinter/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sinter/index.md rename to src/sdk/js/5/core-classes/memory-storage/sinter/index.md diff --git a/src/sdk/js/5/memory-storage/sinter/snippets/sinter-1.js b/src/sdk/js/5/core-classes/memory-storage/sinter/snippets/sinter-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sinter/snippets/sinter-1.js rename to src/sdk/js/5/core-classes/memory-storage/sinter/snippets/sinter-1.js diff --git a/src/sdk/js/5/memory-storage/sinter/snippets/sinter-2.js b/src/sdk/js/5/core-classes/memory-storage/sinter/snippets/sinter-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sinter/snippets/sinter-2.js rename to src/sdk/js/5/core-classes/memory-storage/sinter/snippets/sinter-2.js diff --git a/src/sdk/js/5/memory-storage/sinterstore/index.md b/src/sdk/js/5/core-classes/memory-storage/sinterstore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sinterstore/index.md rename to src/sdk/js/5/core-classes/memory-storage/sinterstore/index.md diff --git a/src/sdk/js/5/memory-storage/sinterstore/snippets/sinterstore-1.js b/src/sdk/js/5/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sinterstore/snippets/sinterstore-1.js rename to src/sdk/js/5/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.js diff --git a/src/sdk/js/5/memory-storage/sinterstore/snippets/sinterstore-2.js b/src/sdk/js/5/core-classes/memory-storage/sinterstore/snippets/sinterstore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sinterstore/snippets/sinterstore-2.js rename to src/sdk/js/5/core-classes/memory-storage/sinterstore/snippets/sinterstore-2.js diff --git a/src/sdk/js/5/memory-storage/sismember/index.md b/src/sdk/js/5/core-classes/memory-storage/sismember/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sismember/index.md rename to src/sdk/js/5/core-classes/memory-storage/sismember/index.md diff --git a/src/sdk/js/5/memory-storage/sismember/snippets/sismember-1.js b/src/sdk/js/5/core-classes/memory-storage/sismember/snippets/sismember-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sismember/snippets/sismember-1.js rename to src/sdk/js/5/core-classes/memory-storage/sismember/snippets/sismember-1.js diff --git a/src/sdk/js/5/memory-storage/sismember/snippets/sismember-2.js b/src/sdk/js/5/core-classes/memory-storage/sismember/snippets/sismember-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sismember/snippets/sismember-2.js rename to src/sdk/js/5/core-classes/memory-storage/sismember/snippets/sismember-2.js diff --git a/src/sdk/js/5/memory-storage/smembers/index.md b/src/sdk/js/5/core-classes/memory-storage/smembers/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/smembers/index.md rename to src/sdk/js/5/core-classes/memory-storage/smembers/index.md diff --git a/src/sdk/js/5/memory-storage/smembers/snippets/smembers-1.js b/src/sdk/js/5/core-classes/memory-storage/smembers/snippets/smembers-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/smembers/snippets/smembers-1.js rename to src/sdk/js/5/core-classes/memory-storage/smembers/snippets/smembers-1.js diff --git a/src/sdk/js/5/memory-storage/smembers/snippets/smembers-2.js b/src/sdk/js/5/core-classes/memory-storage/smembers/snippets/smembers-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/smembers/snippets/smembers-2.js rename to src/sdk/js/5/core-classes/memory-storage/smembers/snippets/smembers-2.js diff --git a/src/sdk/js/5/memory-storage/smove/index.md b/src/sdk/js/5/core-classes/memory-storage/smove/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/smove/index.md rename to src/sdk/js/5/core-classes/memory-storage/smove/index.md diff --git a/src/sdk/js/5/memory-storage/smove/snippets/smove-1.js b/src/sdk/js/5/core-classes/memory-storage/smove/snippets/smove-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/smove/snippets/smove-1.js rename to src/sdk/js/5/core-classes/memory-storage/smove/snippets/smove-1.js diff --git a/src/sdk/js/5/memory-storage/smove/snippets/smove-2.js b/src/sdk/js/5/core-classes/memory-storage/smove/snippets/smove-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/smove/snippets/smove-2.js rename to src/sdk/js/5/core-classes/memory-storage/smove/snippets/smove-2.js diff --git a/src/sdk/js/5/memory-storage/sort/index.md b/src/sdk/js/5/core-classes/memory-storage/sort/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sort/index.md rename to src/sdk/js/5/core-classes/memory-storage/sort/index.md diff --git a/src/sdk/js/5/memory-storage/sort/snippets/sort-1.js b/src/sdk/js/5/core-classes/memory-storage/sort/snippets/sort-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sort/snippets/sort-1.js rename to src/sdk/js/5/core-classes/memory-storage/sort/snippets/sort-1.js diff --git a/src/sdk/js/5/memory-storage/sort/snippets/sort-2.js b/src/sdk/js/5/core-classes/memory-storage/sort/snippets/sort-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sort/snippets/sort-2.js rename to src/sdk/js/5/core-classes/memory-storage/sort/snippets/sort-2.js diff --git a/src/sdk/js/5/memory-storage/spop/index.md b/src/sdk/js/5/core-classes/memory-storage/spop/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/spop/index.md rename to src/sdk/js/5/core-classes/memory-storage/spop/index.md diff --git a/src/sdk/js/5/memory-storage/spop/snippets/spop-1.js b/src/sdk/js/5/core-classes/memory-storage/spop/snippets/spop-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/spop/snippets/spop-1.js rename to src/sdk/js/5/core-classes/memory-storage/spop/snippets/spop-1.js diff --git a/src/sdk/js/5/memory-storage/spop/snippets/spop-2.js b/src/sdk/js/5/core-classes/memory-storage/spop/snippets/spop-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/spop/snippets/spop-2.js rename to src/sdk/js/5/core-classes/memory-storage/spop/snippets/spop-2.js diff --git a/src/sdk/js/5/memory-storage/srandmember/index.md b/src/sdk/js/5/core-classes/memory-storage/srandmember/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/srandmember/index.md rename to src/sdk/js/5/core-classes/memory-storage/srandmember/index.md diff --git a/src/sdk/js/5/memory-storage/srandmember/snippets/srandmember-1.js b/src/sdk/js/5/core-classes/memory-storage/srandmember/snippets/srandmember-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/srandmember/snippets/srandmember-1.js rename to src/sdk/js/5/core-classes/memory-storage/srandmember/snippets/srandmember-1.js diff --git a/src/sdk/js/5/memory-storage/srandmember/snippets/srandmember-2.js b/src/sdk/js/5/core-classes/memory-storage/srandmember/snippets/srandmember-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/srandmember/snippets/srandmember-2.js rename to src/sdk/js/5/core-classes/memory-storage/srandmember/snippets/srandmember-2.js diff --git a/src/sdk/js/5/memory-storage/srem/index.md b/src/sdk/js/5/core-classes/memory-storage/srem/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/srem/index.md rename to src/sdk/js/5/core-classes/memory-storage/srem/index.md diff --git a/src/sdk/js/5/memory-storage/srem/snippets/srem-1.js b/src/sdk/js/5/core-classes/memory-storage/srem/snippets/srem-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/srem/snippets/srem-1.js rename to src/sdk/js/5/core-classes/memory-storage/srem/snippets/srem-1.js diff --git a/src/sdk/js/5/memory-storage/srem/snippets/srem-2.js b/src/sdk/js/5/core-classes/memory-storage/srem/snippets/srem-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/srem/snippets/srem-2.js rename to src/sdk/js/5/core-classes/memory-storage/srem/snippets/srem-2.js diff --git a/src/sdk/js/5/memory-storage/sscan/index.md b/src/sdk/js/5/core-classes/memory-storage/sscan/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sscan/index.md rename to src/sdk/js/5/core-classes/memory-storage/sscan/index.md diff --git a/src/sdk/js/5/memory-storage/sscan/snippets/sscan-1.js b/src/sdk/js/5/core-classes/memory-storage/sscan/snippets/sscan-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sscan/snippets/sscan-1.js rename to src/sdk/js/5/core-classes/memory-storage/sscan/snippets/sscan-1.js diff --git a/src/sdk/js/5/memory-storage/sscan/snippets/sscan-2.js b/src/sdk/js/5/core-classes/memory-storage/sscan/snippets/sscan-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sscan/snippets/sscan-2.js rename to src/sdk/js/5/core-classes/memory-storage/sscan/snippets/sscan-2.js diff --git a/src/sdk/js/5/memory-storage/strlen/index.md b/src/sdk/js/5/core-classes/memory-storage/strlen/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/strlen/index.md rename to src/sdk/js/5/core-classes/memory-storage/strlen/index.md diff --git a/src/sdk/js/5/memory-storage/strlen/snippets/strlen-1.js b/src/sdk/js/5/core-classes/memory-storage/strlen/snippets/strlen-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/strlen/snippets/strlen-1.js rename to src/sdk/js/5/core-classes/memory-storage/strlen/snippets/strlen-1.js diff --git a/src/sdk/js/5/memory-storage/strlen/snippets/strlen-2.js b/src/sdk/js/5/core-classes/memory-storage/strlen/snippets/strlen-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/strlen/snippets/strlen-2.js rename to src/sdk/js/5/core-classes/memory-storage/strlen/snippets/strlen-2.js diff --git a/src/sdk/js/5/memory-storage/sunion/index.md b/src/sdk/js/5/core-classes/memory-storage/sunion/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sunion/index.md rename to src/sdk/js/5/core-classes/memory-storage/sunion/index.md diff --git a/src/sdk/js/5/memory-storage/sunion/snippets/sunion-1.js b/src/sdk/js/5/core-classes/memory-storage/sunion/snippets/sunion-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sunion/snippets/sunion-1.js rename to src/sdk/js/5/core-classes/memory-storage/sunion/snippets/sunion-1.js diff --git a/src/sdk/js/5/memory-storage/sunion/snippets/sunion-2.js b/src/sdk/js/5/core-classes/memory-storage/sunion/snippets/sunion-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sunion/snippets/sunion-2.js rename to src/sdk/js/5/core-classes/memory-storage/sunion/snippets/sunion-2.js diff --git a/src/sdk/js/5/memory-storage/sunionstore/index.md b/src/sdk/js/5/core-classes/memory-storage/sunionstore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/sunionstore/index.md rename to src/sdk/js/5/core-classes/memory-storage/sunionstore/index.md diff --git a/src/sdk/js/5/memory-storage/sunionstore/snippets/sunionstore-1.js b/src/sdk/js/5/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/sunionstore/snippets/sunionstore-1.js rename to src/sdk/js/5/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.js diff --git a/src/sdk/js/5/memory-storage/sunionstore/snippets/sunionstore-2.js b/src/sdk/js/5/core-classes/memory-storage/sunionstore/snippets/sunionstore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/sunionstore/snippets/sunionstore-2.js rename to src/sdk/js/5/core-classes/memory-storage/sunionstore/snippets/sunionstore-2.js diff --git a/src/sdk/js/5/memory-storage/time/index.md b/src/sdk/js/5/core-classes/memory-storage/time/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/time/index.md rename to src/sdk/js/5/core-classes/memory-storage/time/index.md diff --git a/src/sdk/js/5/memory-storage/time/snippets/time-1.js b/src/sdk/js/5/core-classes/memory-storage/time/snippets/time-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/time/snippets/time-1.js rename to src/sdk/js/5/core-classes/memory-storage/time/snippets/time-1.js diff --git a/src/sdk/js/5/memory-storage/time/snippets/time-2.js b/src/sdk/js/5/core-classes/memory-storage/time/snippets/time-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/time/snippets/time-2.js rename to src/sdk/js/5/core-classes/memory-storage/time/snippets/time-2.js diff --git a/src/sdk/js/5/memory-storage/touch/index.md b/src/sdk/js/5/core-classes/memory-storage/touch/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/touch/index.md rename to src/sdk/js/5/core-classes/memory-storage/touch/index.md diff --git a/src/sdk/js/5/memory-storage/touch/snippets/touch-1.js b/src/sdk/js/5/core-classes/memory-storage/touch/snippets/touch-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/touch/snippets/touch-1.js rename to src/sdk/js/5/core-classes/memory-storage/touch/snippets/touch-1.js diff --git a/src/sdk/js/5/memory-storage/touch/snippets/touch-2.js b/src/sdk/js/5/core-classes/memory-storage/touch/snippets/touch-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/touch/snippets/touch-2.js rename to src/sdk/js/5/core-classes/memory-storage/touch/snippets/touch-2.js diff --git a/src/sdk/js/5/memory-storage/ttl/index.md b/src/sdk/js/5/core-classes/memory-storage/ttl/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/ttl/index.md rename to src/sdk/js/5/core-classes/memory-storage/ttl/index.md diff --git a/src/sdk/js/5/memory-storage/ttl/snippets/ttl-1.js b/src/sdk/js/5/core-classes/memory-storage/ttl/snippets/ttl-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/ttl/snippets/ttl-1.js rename to src/sdk/js/5/core-classes/memory-storage/ttl/snippets/ttl-1.js diff --git a/src/sdk/js/5/memory-storage/ttl/snippets/ttl-2.js b/src/sdk/js/5/core-classes/memory-storage/ttl/snippets/ttl-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/ttl/snippets/ttl-2.js rename to src/sdk/js/5/core-classes/memory-storage/ttl/snippets/ttl-2.js diff --git a/src/sdk/js/5/memory-storage/type/index.md b/src/sdk/js/5/core-classes/memory-storage/type/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/type/index.md rename to src/sdk/js/5/core-classes/memory-storage/type/index.md diff --git a/src/sdk/js/5/memory-storage/type/snippets/type-1.js b/src/sdk/js/5/core-classes/memory-storage/type/snippets/type-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/type/snippets/type-1.js rename to src/sdk/js/5/core-classes/memory-storage/type/snippets/type-1.js diff --git a/src/sdk/js/5/memory-storage/type/snippets/type-2.js b/src/sdk/js/5/core-classes/memory-storage/type/snippets/type-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/type/snippets/type-2.js rename to src/sdk/js/5/core-classes/memory-storage/type/snippets/type-2.js diff --git a/src/sdk/js/5/memory-storage/zadd/index.md b/src/sdk/js/5/core-classes/memory-storage/zadd/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zadd/index.md rename to src/sdk/js/5/core-classes/memory-storage/zadd/index.md diff --git a/src/sdk/js/5/memory-storage/zadd/snippets/zadd-1.js b/src/sdk/js/5/core-classes/memory-storage/zadd/snippets/zadd-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zadd/snippets/zadd-1.js rename to src/sdk/js/5/core-classes/memory-storage/zadd/snippets/zadd-1.js diff --git a/src/sdk/js/5/memory-storage/zadd/snippets/zadd-2.js b/src/sdk/js/5/core-classes/memory-storage/zadd/snippets/zadd-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zadd/snippets/zadd-2.js rename to src/sdk/js/5/core-classes/memory-storage/zadd/snippets/zadd-2.js diff --git a/src/sdk/js/5/memory-storage/zcard/index.md b/src/sdk/js/5/core-classes/memory-storage/zcard/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zcard/index.md rename to src/sdk/js/5/core-classes/memory-storage/zcard/index.md diff --git a/src/sdk/js/5/memory-storage/zcard/snippets/zcard-1.js b/src/sdk/js/5/core-classes/memory-storage/zcard/snippets/zcard-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zcard/snippets/zcard-1.js rename to src/sdk/js/5/core-classes/memory-storage/zcard/snippets/zcard-1.js diff --git a/src/sdk/js/5/memory-storage/zcard/snippets/zcard-2.js b/src/sdk/js/5/core-classes/memory-storage/zcard/snippets/zcard-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zcard/snippets/zcard-2.js rename to src/sdk/js/5/core-classes/memory-storage/zcard/snippets/zcard-2.js diff --git a/src/sdk/js/5/memory-storage/zcount/index.md b/src/sdk/js/5/core-classes/memory-storage/zcount/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zcount/index.md rename to src/sdk/js/5/core-classes/memory-storage/zcount/index.md diff --git a/src/sdk/js/5/memory-storage/zcount/snippets/zcount-1.js b/src/sdk/js/5/core-classes/memory-storage/zcount/snippets/zcount-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zcount/snippets/zcount-1.js rename to src/sdk/js/5/core-classes/memory-storage/zcount/snippets/zcount-1.js diff --git a/src/sdk/js/5/memory-storage/zcount/snippets/zcount-2.js b/src/sdk/js/5/core-classes/memory-storage/zcount/snippets/zcount-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zcount/snippets/zcount-2.js rename to src/sdk/js/5/core-classes/memory-storage/zcount/snippets/zcount-2.js diff --git a/src/sdk/js/5/memory-storage/zincrby/index.md b/src/sdk/js/5/core-classes/memory-storage/zincrby/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zincrby/index.md rename to src/sdk/js/5/core-classes/memory-storage/zincrby/index.md diff --git a/src/sdk/js/5/memory-storage/zincrby/snippets/zincrby-1.js b/src/sdk/js/5/core-classes/memory-storage/zincrby/snippets/zincrby-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zincrby/snippets/zincrby-1.js rename to src/sdk/js/5/core-classes/memory-storage/zincrby/snippets/zincrby-1.js diff --git a/src/sdk/js/5/memory-storage/zincrby/snippets/zincrby-2.js b/src/sdk/js/5/core-classes/memory-storage/zincrby/snippets/zincrby-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zincrby/snippets/zincrby-2.js rename to src/sdk/js/5/core-classes/memory-storage/zincrby/snippets/zincrby-2.js diff --git a/src/sdk/js/5/memory-storage/zinterstore/index.md b/src/sdk/js/5/core-classes/memory-storage/zinterstore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zinterstore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zinterstore/index.md diff --git a/src/sdk/js/5/memory-storage/zinterstore/snippets/zinterstore-1.js b/src/sdk/js/5/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zinterstore/snippets/zinterstore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.js diff --git a/src/sdk/js/5/memory-storage/zinterstore/snippets/zinterstore-2.js b/src/sdk/js/5/core-classes/memory-storage/zinterstore/snippets/zinterstore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zinterstore/snippets/zinterstore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zinterstore/snippets/zinterstore-2.js diff --git a/src/sdk/js/5/memory-storage/zlexcount/index.md b/src/sdk/js/5/core-classes/memory-storage/zlexcount/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zlexcount/index.md rename to src/sdk/js/5/core-classes/memory-storage/zlexcount/index.md diff --git a/src/sdk/js/5/memory-storage/zlexcount/snippets/zlexcount-1.js b/src/sdk/js/5/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zlexcount/snippets/zlexcount-1.js rename to src/sdk/js/5/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.js diff --git a/src/sdk/js/5/memory-storage/zlexcount/snippets/zlexcount-2.js b/src/sdk/js/5/core-classes/memory-storage/zlexcount/snippets/zlexcount-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zlexcount/snippets/zlexcount-2.js rename to src/sdk/js/5/core-classes/memory-storage/zlexcount/snippets/zlexcount-2.js diff --git a/src/sdk/js/5/memory-storage/zrange/index.md b/src/sdk/js/5/core-classes/memory-storage/zrange/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrange/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrange/index.md diff --git a/src/sdk/js/5/memory-storage/zrange/snippets/zrange-1.js b/src/sdk/js/5/core-classes/memory-storage/zrange/snippets/zrange-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrange/snippets/zrange-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrange/snippets/zrange-1.js diff --git a/src/sdk/js/5/memory-storage/zrange/snippets/zrange-2.js b/src/sdk/js/5/core-classes/memory-storage/zrange/snippets/zrange-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrange/snippets/zrange-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrange/snippets/zrange-2.js diff --git a/src/sdk/js/5/memory-storage/zrangebylex/index.md b/src/sdk/js/5/core-classes/memory-storage/zrangebylex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebylex/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrangebylex/index.md diff --git a/src/sdk/js/5/memory-storage/zrangebylex/snippets/zrangebylex-1.js b/src/sdk/js/5/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebylex/snippets/zrangebylex-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.js diff --git a/src/sdk/js/5/memory-storage/zrangebylex/snippets/zrangebylex-2.js b/src/sdk/js/5/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebylex/snippets/zrangebylex-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-2.js diff --git a/src/sdk/js/5/memory-storage/zrangebyscore/index.md b/src/sdk/js/5/core-classes/memory-storage/zrangebyscore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebyscore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrangebyscore/index.md diff --git a/src/sdk/js/5/memory-storage/zrangebyscore/snippets/zrangebyscore-1.js b/src/sdk/js/5/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebyscore/snippets/zrangebyscore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.js diff --git a/src/sdk/js/5/memory-storage/zrangebyscore/snippets/zrangebyscore-2.js b/src/sdk/js/5/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrangebyscore/snippets/zrangebyscore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-2.js diff --git a/src/sdk/js/5/memory-storage/zrank/index.md b/src/sdk/js/5/core-classes/memory-storage/zrank/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrank/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrank/index.md diff --git a/src/sdk/js/5/memory-storage/zrank/snippets/zrank-1.js b/src/sdk/js/5/core-classes/memory-storage/zrank/snippets/zrank-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrank/snippets/zrank-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrank/snippets/zrank-1.js diff --git a/src/sdk/js/5/memory-storage/zrank/snippets/zrank-2.js b/src/sdk/js/5/core-classes/memory-storage/zrank/snippets/zrank-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrank/snippets/zrank-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrank/snippets/zrank-2.js diff --git a/src/sdk/js/5/memory-storage/zrem/index.md b/src/sdk/js/5/core-classes/memory-storage/zrem/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrem/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrem/index.md diff --git a/src/sdk/js/5/memory-storage/zrem/snippets/zrem-1.js b/src/sdk/js/5/core-classes/memory-storage/zrem/snippets/zrem-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrem/snippets/zrem-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrem/snippets/zrem-1.js diff --git a/src/sdk/js/5/memory-storage/zrem/snippets/zrem-2.js b/src/sdk/js/5/core-classes/memory-storage/zrem/snippets/zrem-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrem/snippets/zrem-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrem/snippets/zrem-2.js diff --git a/src/sdk/js/5/memory-storage/zremrangebylex/index.md b/src/sdk/js/5/core-classes/memory-storage/zremrangebylex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebylex/index.md rename to src/sdk/js/5/core-classes/memory-storage/zremrangebylex/index.md diff --git a/src/sdk/js/5/memory-storage/zremrangebylex/snippets/zremrangebylex-1.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebylex/snippets/zremrangebylex-1.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.js diff --git a/src/sdk/js/5/memory-storage/zremrangebylex/snippets/zremrangebylex-2.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebylex/snippets/zremrangebylex-2.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-2.js diff --git a/src/sdk/js/5/memory-storage/zremrangebyrank/index.md b/src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyrank/index.md rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/index.md diff --git a/src/sdk/js/5/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.js diff --git a/src/sdk/js/5/memory-storage/zremrangebyrank/snippets/zremrangebyrank-2.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyrank/snippets/zremrangebyrank-2.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-2.js diff --git a/src/sdk/js/5/memory-storage/zremrangebyscore/index.md b/src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyscore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/index.md diff --git a/src/sdk/js/5/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.js diff --git a/src/sdk/js/5/memory-storage/zremrangebyscore/snippets/zremrangebyscore-2.js b/src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zremrangebyscore/snippets/zremrangebyscore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-2.js diff --git a/src/sdk/js/5/memory-storage/zrevrange/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrange/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md diff --git a/src/sdk/js/5/memory-storage/zrevrange/snippets/zrevrange-1.js b/src/sdk/js/5/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrange/snippets/zrevrange-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.js diff --git a/src/sdk/js/5/memory-storage/zrevrange/snippets/zrevrange-2.js b/src/sdk/js/5/core-classes/memory-storage/zrevrange/snippets/zrevrange-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrange/snippets/zrevrange-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrange/snippets/zrevrange-2.js diff --git a/src/sdk/js/5/memory-storage/zrevrangebylex/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebylex/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md diff --git a/src/sdk/js/5/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.js b/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.js diff --git a/src/sdk/js/5/memory-storage/zrevrangebylex/snippets/zrevrangebylex-2.js b/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebylex/snippets/zrevrangebylex-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-2.js diff --git a/src/sdk/js/5/memory-storage/zrevrangebyscore/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebyscore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md diff --git a/src/sdk/js/5/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.js b/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.js diff --git a/src/sdk/js/5/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-2.js b/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-2.js diff --git a/src/sdk/js/5/memory-storage/zrevrank/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrank/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrank/index.md rename to src/sdk/js/5/core-classes/memory-storage/zrevrank/index.md diff --git a/src/sdk/js/5/memory-storage/zrevrank/snippets/zrevrank-1.js b/src/sdk/js/5/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrank/snippets/zrevrank-1.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.js diff --git a/src/sdk/js/5/memory-storage/zrevrank/snippets/zrevrank-2.js b/src/sdk/js/5/core-classes/memory-storage/zrevrank/snippets/zrevrank-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zrevrank/snippets/zrevrank-2.js rename to src/sdk/js/5/core-classes/memory-storage/zrevrank/snippets/zrevrank-2.js diff --git a/src/sdk/js/5/memory-storage/zscan/index.md b/src/sdk/js/5/core-classes/memory-storage/zscan/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zscan/index.md rename to src/sdk/js/5/core-classes/memory-storage/zscan/index.md diff --git a/src/sdk/js/5/memory-storage/zscan/snippets/zscan-1.js b/src/sdk/js/5/core-classes/memory-storage/zscan/snippets/zscan-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zscan/snippets/zscan-1.js rename to src/sdk/js/5/core-classes/memory-storage/zscan/snippets/zscan-1.js diff --git a/src/sdk/js/5/memory-storage/zscan/snippets/zscan-2.js b/src/sdk/js/5/core-classes/memory-storage/zscan/snippets/zscan-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zscan/snippets/zscan-2.js rename to src/sdk/js/5/core-classes/memory-storage/zscan/snippets/zscan-2.js diff --git a/src/sdk/js/5/memory-storage/zscore/index.md b/src/sdk/js/5/core-classes/memory-storage/zscore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zscore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zscore/index.md diff --git a/src/sdk/js/5/memory-storage/zscore/snippets/zscore-1.js b/src/sdk/js/5/core-classes/memory-storage/zscore/snippets/zscore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zscore/snippets/zscore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zscore/snippets/zscore-1.js diff --git a/src/sdk/js/5/memory-storage/zscore/snippets/zscore-2.js b/src/sdk/js/5/core-classes/memory-storage/zscore/snippets/zscore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zscore/snippets/zscore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zscore/snippets/zscore-2.js diff --git a/src/sdk/js/5/memory-storage/zunionstore/index.md b/src/sdk/js/5/core-classes/memory-storage/zunionstore/index.md similarity index 100% rename from src/sdk/js/5/memory-storage/zunionstore/index.md rename to src/sdk/js/5/core-classes/memory-storage/zunionstore/index.md diff --git a/src/sdk/js/5/memory-storage/zunionstore/snippets/zunionstore-1.js b/src/sdk/js/5/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.js similarity index 100% rename from src/sdk/js/5/memory-storage/zunionstore/snippets/zunionstore-1.js rename to src/sdk/js/5/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.js diff --git a/src/sdk/js/5/memory-storage/zunionstore/snippets/zunionstore-2.js b/src/sdk/js/5/core-classes/memory-storage/zunionstore/snippets/zunionstore-2.js similarity index 100% rename from src/sdk/js/5/memory-storage/zunionstore/snippets/zunionstore-2.js rename to src/sdk/js/5/core-classes/memory-storage/zunionstore/snippets/zunionstore-2.js diff --git a/src/sdk/js/5/profile/add-policy/index.md b/src/sdk/js/5/core-classes/profile/add-policy/index.md similarity index 100% rename from src/sdk/js/5/profile/add-policy/index.md rename to src/sdk/js/5/core-classes/profile/add-policy/index.md diff --git a/src/sdk/js/5/profile/add-policy/snippets/add-policy-1.js b/src/sdk/js/5/core-classes/profile/add-policy/snippets/add-policy-1.js similarity index 100% rename from src/sdk/js/5/profile/add-policy/snippets/add-policy-1.js rename to src/sdk/js/5/core-classes/profile/add-policy/snippets/add-policy-1.js diff --git a/src/sdk/js/5/profile/constructor/index.md b/src/sdk/js/5/core-classes/profile/constructor/index.md similarity index 100% rename from src/sdk/js/5/profile/constructor/index.md rename to src/sdk/js/5/core-classes/profile/constructor/index.md diff --git a/src/sdk/js/5/profile/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/profile/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/profile/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/profile/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/profile/delete/index.md b/src/sdk/js/5/core-classes/profile/delete/index.md similarity index 100% rename from src/sdk/js/5/profile/delete/index.md rename to src/sdk/js/5/core-classes/profile/delete/index.md diff --git a/src/sdk/js/5/profile/delete/snippets/delete-1.js b/src/sdk/js/5/core-classes/profile/delete/snippets/delete-1.js similarity index 100% rename from src/sdk/js/5/profile/delete/snippets/delete-1.js rename to src/sdk/js/5/core-classes/profile/delete/snippets/delete-1.js diff --git a/src/sdk/js/5/profile/get-policies/index.md b/src/sdk/js/5/core-classes/profile/get-policies/index.md similarity index 100% rename from src/sdk/js/5/profile/get-policies/index.md rename to src/sdk/js/5/core-classes/profile/get-policies/index.md diff --git a/src/sdk/js/5/profile/get-policies/snippets/get-policies-1.js b/src/sdk/js/5/core-classes/profile/get-policies/snippets/get-policies-1.js similarity index 100% rename from src/sdk/js/5/profile/get-policies/snippets/get-policies-1.js rename to src/sdk/js/5/core-classes/profile/get-policies/snippets/get-policies-1.js diff --git a/src/sdk/js/5/profile/get-policies/snippets/get-policies-2.js b/src/sdk/js/5/core-classes/profile/get-policies/snippets/get-policies-2.js similarity index 100% rename from src/sdk/js/5/profile/get-policies/snippets/get-policies-2.js rename to src/sdk/js/5/core-classes/profile/get-policies/snippets/get-policies-2.js diff --git a/src/sdk/js/5/profile/index.md b/src/sdk/js/5/core-classes/profile/index.md similarity index 100% rename from src/sdk/js/5/profile/index.md rename to src/sdk/js/5/core-classes/profile/index.md diff --git a/src/sdk/js/5/profile/save/index.md b/src/sdk/js/5/core-classes/profile/save/index.md similarity index 100% rename from src/sdk/js/5/profile/save/index.md rename to src/sdk/js/5/core-classes/profile/save/index.md diff --git a/src/sdk/js/5/profile/save/snippets/save-1.js b/src/sdk/js/5/core-classes/profile/save/snippets/save-1.js similarity index 100% rename from src/sdk/js/5/profile/save/snippets/save-1.js rename to src/sdk/js/5/core-classes/profile/save/snippets/save-1.js diff --git a/src/sdk/js/5/profile/set-content/index.md b/src/sdk/js/5/core-classes/profile/set-content/index.md similarity index 100% rename from src/sdk/js/5/profile/set-content/index.md rename to src/sdk/js/5/core-classes/profile/set-content/index.md diff --git a/src/sdk/js/5/profile/set-content/snippets/set-content-1.js b/src/sdk/js/5/core-classes/profile/set-content/snippets/set-content-1.js similarity index 100% rename from src/sdk/js/5/profile/set-content/snippets/set-content-1.js rename to src/sdk/js/5/core-classes/profile/set-content/snippets/set-content-1.js diff --git a/src/sdk/js/5/profile/set-policies/index.md b/src/sdk/js/5/core-classes/profile/set-policies/index.md similarity index 100% rename from src/sdk/js/5/profile/set-policies/index.md rename to src/sdk/js/5/core-classes/profile/set-policies/index.md diff --git a/src/sdk/js/5/profile/set-policies/snippets/set-policies-1.js b/src/sdk/js/5/core-classes/profile/set-policies/snippets/set-policies-1.js similarity index 100% rename from src/sdk/js/5/profile/set-policies/snippets/set-policies-1.js rename to src/sdk/js/5/core-classes/profile/set-policies/snippets/set-policies-1.js diff --git a/src/sdk/js/5/profile/update/index.md b/src/sdk/js/5/core-classes/profile/update/index.md similarity index 100% rename from src/sdk/js/5/profile/update/index.md rename to src/sdk/js/5/core-classes/profile/update/index.md diff --git a/src/sdk/js/5/profile/update/snippets/update-1.js b/src/sdk/js/5/core-classes/profile/update/snippets/update-1.js similarity index 100% rename from src/sdk/js/5/profile/update/snippets/update-1.js rename to src/sdk/js/5/core-classes/profile/update/snippets/update-1.js diff --git a/src/sdk/js/5/role/constructor/index.md b/src/sdk/js/5/core-classes/role/constructor/index.md similarity index 100% rename from src/sdk/js/5/role/constructor/index.md rename to src/sdk/js/5/core-classes/role/constructor/index.md diff --git a/src/sdk/js/5/role/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/role/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/role/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/role/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/role/delete/index.md b/src/sdk/js/5/core-classes/role/delete/index.md similarity index 100% rename from src/sdk/js/5/role/delete/index.md rename to src/sdk/js/5/core-classes/role/delete/index.md diff --git a/src/sdk/js/5/role/delete/snippets/delete-1.js b/src/sdk/js/5/core-classes/role/delete/snippets/delete-1.js similarity index 100% rename from src/sdk/js/5/role/delete/snippets/delete-1.js rename to src/sdk/js/5/core-classes/role/delete/snippets/delete-1.js diff --git a/src/sdk/js/5/role/index.md b/src/sdk/js/5/core-classes/role/index.md similarity index 100% rename from src/sdk/js/5/role/index.md rename to src/sdk/js/5/core-classes/role/index.md diff --git a/src/sdk/js/5/role/save/index.md b/src/sdk/js/5/core-classes/role/save/index.md similarity index 100% rename from src/sdk/js/5/role/save/index.md rename to src/sdk/js/5/core-classes/role/save/index.md diff --git a/src/sdk/js/5/role/save/snippets/save-1.js b/src/sdk/js/5/core-classes/role/save/snippets/save-1.js similarity index 100% rename from src/sdk/js/5/role/save/snippets/save-1.js rename to src/sdk/js/5/core-classes/role/save/snippets/save-1.js diff --git a/src/sdk/js/5/role/set-content/index.md b/src/sdk/js/5/core-classes/role/set-content/index.md similarity index 100% rename from src/sdk/js/5/role/set-content/index.md rename to src/sdk/js/5/core-classes/role/set-content/index.md diff --git a/src/sdk/js/5/role/set-content/snippets/set-content-1.js b/src/sdk/js/5/core-classes/role/set-content/snippets/set-content-1.js similarity index 100% rename from src/sdk/js/5/role/set-content/snippets/set-content-1.js rename to src/sdk/js/5/core-classes/role/set-content/snippets/set-content-1.js diff --git a/src/sdk/js/5/role/update/index.md b/src/sdk/js/5/core-classes/role/update/index.md similarity index 100% rename from src/sdk/js/5/role/update/index.md rename to src/sdk/js/5/core-classes/role/update/index.md diff --git a/src/sdk/js/5/role/update/snippets/update-1.js b/src/sdk/js/5/core-classes/role/update/snippets/update-1.js similarity index 100% rename from src/sdk/js/5/role/update/snippets/update-1.js rename to src/sdk/js/5/core-classes/role/update/snippets/update-1.js diff --git a/src/sdk/js/5/room/constructor/index.md b/src/sdk/js/5/core-classes/room/constructor/index.md similarity index 78% rename from src/sdk/js/5/room/constructor/index.md rename to src/sdk/js/5/core-classes/room/constructor/index.md index ce7709c43..d8d783a57 100644 --- a/src/sdk/js/5/room/constructor/index.md +++ b/src/sdk/js/5/core-classes/room/constructor/index.md @@ -26,10 +26,10 @@ The `Room` object is the result of a subscription request, allowing you to manip | Option | Type | Description | Default | | ----------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `volatile` | JSON Object | Additional information passed to notifications to other users | `null` | -| `scope` | string | Filter [document notifications](/sdk/js/5/notifications/#document-notification) depending on their scope status. You may receive entering documents (scope: `in`), leaving documents (scope: `out`), all documents changes (scope: `all`) or filter these notifications completely (scope: `none`). This filter does not affect pub/sub messages or user events. | `all` | -| `state` | string | Filter [document notifications](/sdk/js/5/notifications/#document-notification) depending on the state of the modifying request. You may receive real-time notifications when a document is about to be changed (state: `pending`), or be notified when the change has been fully written in the database (state: `done`), or both (state: `all`). This filter does not affect pub/sub messages or user events. | `done` | +| `scope` | string | Filter [document notifications](/sdk/js/5/essentials/realtime-notifications/#document-notification) depending on their scope status. You may receive entering documents (scope: `in`), leaving documents (scope: `out`), all documents changes (scope: `all`) or filter these notifications completely (scope: `none`). This filter does not affect pub/sub messages or user events. | `all` | +| `state` | string | Filter [document notifications](/sdk/js/5/essentials/realtime-notifications/#document-notification) depending on the state of the modifying request. You may receive real-time notifications when a document is about to be changed (state: `pending`), or be notified when the change has been fully written in the database (state: `done`), or both (state: `all`). This filter does not affect pub/sub messages or user events. | `done` | | `subscribeToSelf` | boolean | (Don't) subscribe to notifications fired as a consequence of our own queries | `true` | -| `users` | string | Filter [user notifications](/sdk/js/5/notifications/#user-notification) triggered upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | +| `users` | string | Filter [user notifications](/sdk/js/5/essentials/realtime-notifications/#user-notification) triggered upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | --- diff --git a/src/sdk/js/5/room/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/room/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/room/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/room/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/room/count/index.md b/src/sdk/js/5/core-classes/room/count/index.md similarity index 100% rename from src/sdk/js/5/room/count/index.md rename to src/sdk/js/5/core-classes/room/count/index.md diff --git a/src/sdk/js/5/room/count/snippets/count-1.js b/src/sdk/js/5/core-classes/room/count/snippets/count-1.js similarity index 100% rename from src/sdk/js/5/room/count/snippets/count-1.js rename to src/sdk/js/5/core-classes/room/count/snippets/count-1.js diff --git a/src/sdk/js/5/room/count/snippets/count-2.js b/src/sdk/js/5/core-classes/room/count/snippets/count-2.js similarity index 100% rename from src/sdk/js/5/room/count/snippets/count-2.js rename to src/sdk/js/5/core-classes/room/count/snippets/count-2.js diff --git a/src/sdk/js/5/room/index.md b/src/sdk/js/5/core-classes/room/index.md similarity index 100% rename from src/sdk/js/5/room/index.md rename to src/sdk/js/5/core-classes/room/index.md diff --git a/src/sdk/js/5/room/renew/index.md b/src/sdk/js/5/core-classes/room/renew/index.md similarity index 92% rename from src/sdk/js/5/room/renew/index.md rename to src/sdk/js/5/core-classes/room/renew/index.md index d30b7c76f..ed9752c51 100644 --- a/src/sdk/js/5/room/renew/index.md +++ b/src/sdk/js/5/core-classes/room/renew/index.md @@ -18,7 +18,7 @@ Unsubscribes first if this `Room` object was already listening to events. | Arguments | Type | Description | | ---------------------- | ----------- | ------------------------------------------------------------------------------- | | `filters` | JSON Object | [Filters](/core/1/koncorde) | -| `notificationCallback` | function | Function called each time a [notification](/sdk/js/5/notifications) is received | +| `notificationCallback` | function | Function called each time a [notification](/sdk/js/5/essentials/realtime-notifications) is received | | `subscriptionCallback` | function | Function called with the subscription result | ## Usage diff --git a/src/sdk/js/5/room/renew/snippets/renew-1.js b/src/sdk/js/5/core-classes/room/renew/snippets/renew-1.js similarity index 100% rename from src/sdk/js/5/room/renew/snippets/renew-1.js rename to src/sdk/js/5/core-classes/room/renew/snippets/renew-1.js diff --git a/src/sdk/js/5/room/set-headers/index.md b/src/sdk/js/5/core-classes/room/set-headers/index.md similarity index 100% rename from src/sdk/js/5/room/set-headers/index.md rename to src/sdk/js/5/core-classes/room/set-headers/index.md diff --git a/src/sdk/js/5/room/set-headers/snippets/set-headers-1.js b/src/sdk/js/5/core-classes/room/set-headers/snippets/set-headers-1.js similarity index 100% rename from src/sdk/js/5/room/set-headers/snippets/set-headers-1.js rename to src/sdk/js/5/core-classes/room/set-headers/snippets/set-headers-1.js diff --git a/src/sdk/js/5/room/unsubscribe/index.md b/src/sdk/js/5/core-classes/room/unsubscribe/index.md similarity index 100% rename from src/sdk/js/5/room/unsubscribe/index.md rename to src/sdk/js/5/core-classes/room/unsubscribe/index.md diff --git a/src/sdk/js/5/room/unsubscribe/snippets/unsubscribe-1.js b/src/sdk/js/5/core-classes/room/unsubscribe/snippets/unsubscribe-1.js similarity index 100% rename from src/sdk/js/5/room/unsubscribe/snippets/unsubscribe-1.js rename to src/sdk/js/5/core-classes/room/unsubscribe/snippets/unsubscribe-1.js diff --git a/src/sdk/js/5/search-result/constructor/index.md b/src/sdk/js/5/core-classes/search-result/constructor/index.md similarity index 100% rename from src/sdk/js/5/search-result/constructor/index.md rename to src/sdk/js/5/core-classes/search-result/constructor/index.md diff --git a/src/sdk/js/5/search-result/fetch-next/index.md b/src/sdk/js/5/core-classes/search-result/fetch-next/index.md similarity index 100% rename from src/sdk/js/5/search-result/fetch-next/index.md rename to src/sdk/js/5/core-classes/search-result/fetch-next/index.md diff --git a/src/sdk/js/5/search-result/fetch-next/snippets/fetch-next-1.js b/src/sdk/js/5/core-classes/search-result/fetch-next/snippets/fetch-next-1.js similarity index 100% rename from src/sdk/js/5/search-result/fetch-next/snippets/fetch-next-1.js rename to src/sdk/js/5/core-classes/search-result/fetch-next/snippets/fetch-next-1.js diff --git a/src/sdk/js/5/search-result/fetch-next/snippets/fetch-next-2.js b/src/sdk/js/5/core-classes/search-result/fetch-next/snippets/fetch-next-2.js similarity index 100% rename from src/sdk/js/5/search-result/fetch-next/snippets/fetch-next-2.js rename to src/sdk/js/5/core-classes/search-result/fetch-next/snippets/fetch-next-2.js diff --git a/src/sdk/js/5/search-result/index.md b/src/sdk/js/5/core-classes/search-result/index.md similarity index 100% rename from src/sdk/js/5/search-result/index.md rename to src/sdk/js/5/core-classes/search-result/index.md diff --git a/src/sdk/js/5/security/constructor/index.md b/src/sdk/js/5/core-classes/security/constructor/index.md similarity index 100% rename from src/sdk/js/5/security/constructor/index.md rename to src/sdk/js/5/core-classes/security/constructor/index.md diff --git a/src/sdk/js/5/security/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/security/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/security/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/security/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/security/create-credentials/index.md b/src/sdk/js/5/core-classes/security/create-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/create-credentials/index.md rename to src/sdk/js/5/core-classes/security/create-credentials/index.md diff --git a/src/sdk/js/5/security/create-credentials/snippets/create-credentials-1.js b/src/sdk/js/5/core-classes/security/create-credentials/snippets/create-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/create-credentials/snippets/create-credentials-1.js rename to src/sdk/js/5/core-classes/security/create-credentials/snippets/create-credentials-1.js diff --git a/src/sdk/js/5/security/create-credentials/snippets/create-credentials-2.js b/src/sdk/js/5/core-classes/security/create-credentials/snippets/create-credentials-2.js similarity index 100% rename from src/sdk/js/5/security/create-credentials/snippets/create-credentials-2.js rename to src/sdk/js/5/core-classes/security/create-credentials/snippets/create-credentials-2.js diff --git a/src/sdk/js/5/security/create-profile/index.md b/src/sdk/js/5/core-classes/security/create-profile/index.md similarity index 100% rename from src/sdk/js/5/security/create-profile/index.md rename to src/sdk/js/5/core-classes/security/create-profile/index.md diff --git a/src/sdk/js/5/security/create-profile/snippets/create-profile-1.js b/src/sdk/js/5/core-classes/security/create-profile/snippets/create-profile-1.js similarity index 100% rename from src/sdk/js/5/security/create-profile/snippets/create-profile-1.js rename to src/sdk/js/5/core-classes/security/create-profile/snippets/create-profile-1.js diff --git a/src/sdk/js/5/security/create-restricted-user/index.md b/src/sdk/js/5/core-classes/security/create-restricted-user/index.md similarity index 100% rename from src/sdk/js/5/security/create-restricted-user/index.md rename to src/sdk/js/5/core-classes/security/create-restricted-user/index.md diff --git a/src/sdk/js/5/security/create-restricted-user/snippets/create-restricted-user-1.js b/src/sdk/js/5/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.js similarity index 100% rename from src/sdk/js/5/security/create-restricted-user/snippets/create-restricted-user-1.js rename to src/sdk/js/5/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.js diff --git a/src/sdk/js/5/security/create-role/index.md b/src/sdk/js/5/core-classes/security/create-role/index.md similarity index 100% rename from src/sdk/js/5/security/create-role/index.md rename to src/sdk/js/5/core-classes/security/create-role/index.md diff --git a/src/sdk/js/5/security/create-role/snippets/create-role-1.js b/src/sdk/js/5/core-classes/security/create-role/snippets/create-role-1.js similarity index 100% rename from src/sdk/js/5/security/create-role/snippets/create-role-1.js rename to src/sdk/js/5/core-classes/security/create-role/snippets/create-role-1.js diff --git a/src/sdk/js/5/security/create-user/index.md b/src/sdk/js/5/core-classes/security/create-user/index.md similarity index 100% rename from src/sdk/js/5/security/create-user/index.md rename to src/sdk/js/5/core-classes/security/create-user/index.md diff --git a/src/sdk/js/5/security/create-user/snippets/create-user-1.js b/src/sdk/js/5/core-classes/security/create-user/snippets/create-user-1.js similarity index 100% rename from src/sdk/js/5/security/create-user/snippets/create-user-1.js rename to src/sdk/js/5/core-classes/security/create-user/snippets/create-user-1.js diff --git a/src/sdk/js/5/security/delete-credentials/index.md b/src/sdk/js/5/core-classes/security/delete-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/delete-credentials/index.md rename to src/sdk/js/5/core-classes/security/delete-credentials/index.md diff --git a/src/sdk/js/5/security/delete-credentials/snippets/delete-credentials-1.js b/src/sdk/js/5/core-classes/security/delete-credentials/snippets/delete-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/delete-credentials/snippets/delete-credentials-1.js rename to src/sdk/js/5/core-classes/security/delete-credentials/snippets/delete-credentials-1.js diff --git a/src/sdk/js/5/security/delete-credentials/snippets/delete-credentials-2.js b/src/sdk/js/5/core-classes/security/delete-credentials/snippets/delete-credentials-2.js similarity index 100% rename from src/sdk/js/5/security/delete-credentials/snippets/delete-credentials-2.js rename to src/sdk/js/5/core-classes/security/delete-credentials/snippets/delete-credentials-2.js diff --git a/src/sdk/js/5/security/delete-profile/index.md b/src/sdk/js/5/core-classes/security/delete-profile/index.md similarity index 100% rename from src/sdk/js/5/security/delete-profile/index.md rename to src/sdk/js/5/core-classes/security/delete-profile/index.md diff --git a/src/sdk/js/5/security/delete-profile/snippets/delete-profile-1.js b/src/sdk/js/5/core-classes/security/delete-profile/snippets/delete-profile-1.js similarity index 100% rename from src/sdk/js/5/security/delete-profile/snippets/delete-profile-1.js rename to src/sdk/js/5/core-classes/security/delete-profile/snippets/delete-profile-1.js diff --git a/src/sdk/js/5/security/delete-profile/snippets/delete-profile-2.js b/src/sdk/js/5/core-classes/security/delete-profile/snippets/delete-profile-2.js similarity index 100% rename from src/sdk/js/5/security/delete-profile/snippets/delete-profile-2.js rename to src/sdk/js/5/core-classes/security/delete-profile/snippets/delete-profile-2.js diff --git a/src/sdk/js/5/security/delete-role/index.md b/src/sdk/js/5/core-classes/security/delete-role/index.md similarity index 100% rename from src/sdk/js/5/security/delete-role/index.md rename to src/sdk/js/5/core-classes/security/delete-role/index.md diff --git a/src/sdk/js/5/security/delete-role/snippets/delete-role-1.js b/src/sdk/js/5/core-classes/security/delete-role/snippets/delete-role-1.js similarity index 100% rename from src/sdk/js/5/security/delete-role/snippets/delete-role-1.js rename to src/sdk/js/5/core-classes/security/delete-role/snippets/delete-role-1.js diff --git a/src/sdk/js/5/security/delete-role/snippets/delete-role-2.js b/src/sdk/js/5/core-classes/security/delete-role/snippets/delete-role-2.js similarity index 100% rename from src/sdk/js/5/security/delete-role/snippets/delete-role-2.js rename to src/sdk/js/5/core-classes/security/delete-role/snippets/delete-role-2.js diff --git a/src/sdk/js/5/security/delete-user/index.md b/src/sdk/js/5/core-classes/security/delete-user/index.md similarity index 100% rename from src/sdk/js/5/security/delete-user/index.md rename to src/sdk/js/5/core-classes/security/delete-user/index.md diff --git a/src/sdk/js/5/security/delete-user/snippets/delete-user-1.js b/src/sdk/js/5/core-classes/security/delete-user/snippets/delete-user-1.js similarity index 100% rename from src/sdk/js/5/security/delete-user/snippets/delete-user-1.js rename to src/sdk/js/5/core-classes/security/delete-user/snippets/delete-user-1.js diff --git a/src/sdk/js/5/security/delete-user/snippets/delete-user-2.js b/src/sdk/js/5/core-classes/security/delete-user/snippets/delete-user-2.js similarity index 100% rename from src/sdk/js/5/security/delete-user/snippets/delete-user-2.js rename to src/sdk/js/5/core-classes/security/delete-user/snippets/delete-user-2.js diff --git a/src/sdk/js/5/security/fetch-profile/index.md b/src/sdk/js/5/core-classes/security/fetch-profile/index.md similarity index 100% rename from src/sdk/js/5/security/fetch-profile/index.md rename to src/sdk/js/5/core-classes/security/fetch-profile/index.md diff --git a/src/sdk/js/5/security/fetch-profile/snippets/fetch-profile-1.js b/src/sdk/js/5/core-classes/security/fetch-profile/snippets/fetch-profile-1.js similarity index 100% rename from src/sdk/js/5/security/fetch-profile/snippets/fetch-profile-1.js rename to src/sdk/js/5/core-classes/security/fetch-profile/snippets/fetch-profile-1.js diff --git a/src/sdk/js/5/security/fetch-role/index.md b/src/sdk/js/5/core-classes/security/fetch-role/index.md similarity index 100% rename from src/sdk/js/5/security/fetch-role/index.md rename to src/sdk/js/5/core-classes/security/fetch-role/index.md diff --git a/src/sdk/js/5/security/fetch-role/snippets/fetch-role-1.js b/src/sdk/js/5/core-classes/security/fetch-role/snippets/fetch-role-1.js similarity index 100% rename from src/sdk/js/5/security/fetch-role/snippets/fetch-role-1.js rename to src/sdk/js/5/core-classes/security/fetch-role/snippets/fetch-role-1.js diff --git a/src/sdk/js/5/security/fetch-user/index.md b/src/sdk/js/5/core-classes/security/fetch-user/index.md similarity index 100% rename from src/sdk/js/5/security/fetch-user/index.md rename to src/sdk/js/5/core-classes/security/fetch-user/index.md diff --git a/src/sdk/js/5/security/fetch-user/snippets/fetch-user-1.js b/src/sdk/js/5/core-classes/security/fetch-user/snippets/fetch-user-1.js similarity index 100% rename from src/sdk/js/5/security/fetch-user/snippets/fetch-user-1.js rename to src/sdk/js/5/core-classes/security/fetch-user/snippets/fetch-user-1.js diff --git a/src/sdk/js/5/security/get-all-credential-fields/index.md b/src/sdk/js/5/core-classes/security/get-all-credential-fields/index.md similarity index 100% rename from src/sdk/js/5/security/get-all-credential-fields/index.md rename to src/sdk/js/5/core-classes/security/get-all-credential-fields/index.md diff --git a/src/sdk/js/5/security/get-all-credential-fields/snippets/get-all-credential-fields-1.js b/src/sdk/js/5/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.js similarity index 100% rename from src/sdk/js/5/security/get-all-credential-fields/snippets/get-all-credential-fields-1.js rename to src/sdk/js/5/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.js diff --git a/src/sdk/js/5/security/get-all-credential-fields/snippets/get-all-credential-fields-2.js b/src/sdk/js/5/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-2.js similarity index 100% rename from src/sdk/js/5/security/get-all-credential-fields/snippets/get-all-credential-fields-2.js rename to src/sdk/js/5/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-2.js diff --git a/src/sdk/js/5/security/get-credentials-fields/index.md b/src/sdk/js/5/core-classes/security/get-credentials-fields/index.md similarity index 100% rename from src/sdk/js/5/security/get-credentials-fields/index.md rename to src/sdk/js/5/core-classes/security/get-credentials-fields/index.md diff --git a/src/sdk/js/5/security/get-credentials-fields/snippets/get-credentials-fields-1.js b/src/sdk/js/5/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.js similarity index 100% rename from src/sdk/js/5/security/get-credentials-fields/snippets/get-credentials-fields-1.js rename to src/sdk/js/5/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.js diff --git a/src/sdk/js/5/security/get-credentials-fields/snippets/get-credentials-fields-2.js b/src/sdk/js/5/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-2.js similarity index 100% rename from src/sdk/js/5/security/get-credentials-fields/snippets/get-credentials-fields-2.js rename to src/sdk/js/5/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-2.js diff --git a/src/sdk/js/5/security/get-credentials/index.md b/src/sdk/js/5/core-classes/security/get-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/get-credentials/index.md rename to src/sdk/js/5/core-classes/security/get-credentials/index.md diff --git a/src/sdk/js/5/security/get-credentials/snippets/get-credentials-1.js b/src/sdk/js/5/core-classes/security/get-credentials/snippets/get-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/get-credentials/snippets/get-credentials-1.js rename to src/sdk/js/5/core-classes/security/get-credentials/snippets/get-credentials-1.js diff --git a/src/sdk/js/5/security/get-credentials/snippets/get-credentials-2.js b/src/sdk/js/5/core-classes/security/get-credentials/snippets/get-credentials-2.js similarity index 100% rename from src/sdk/js/5/security/get-credentials/snippets/get-credentials-2.js rename to src/sdk/js/5/core-classes/security/get-credentials/snippets/get-credentials-2.js diff --git a/src/sdk/js/5/security/get-user-rights/index.md b/src/sdk/js/5/core-classes/security/get-user-rights/index.md similarity index 100% rename from src/sdk/js/5/security/get-user-rights/index.md rename to src/sdk/js/5/core-classes/security/get-user-rights/index.md diff --git a/src/sdk/js/5/security/get-user-rights/snippets/get-user-rights-1.js b/src/sdk/js/5/core-classes/security/get-user-rights/snippets/get-user-rights-1.js similarity index 100% rename from src/sdk/js/5/security/get-user-rights/snippets/get-user-rights-1.js rename to src/sdk/js/5/core-classes/security/get-user-rights/snippets/get-user-rights-1.js diff --git a/src/sdk/js/5/security/get-user-rights/snippets/get-user-rights-2.js b/src/sdk/js/5/core-classes/security/get-user-rights/snippets/get-user-rights-2.js similarity index 100% rename from src/sdk/js/5/security/get-user-rights/snippets/get-user-rights-2.js rename to src/sdk/js/5/core-classes/security/get-user-rights/snippets/get-user-rights-2.js diff --git a/src/sdk/js/5/security/has-credentials/index.md b/src/sdk/js/5/core-classes/security/has-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/has-credentials/index.md rename to src/sdk/js/5/core-classes/security/has-credentials/index.md diff --git a/src/sdk/js/5/security/has-credentials/snippets/has-credentials-1.js b/src/sdk/js/5/core-classes/security/has-credentials/snippets/has-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/has-credentials/snippets/has-credentials-1.js rename to src/sdk/js/5/core-classes/security/has-credentials/snippets/has-credentials-1.js diff --git a/src/sdk/js/5/security/index.md b/src/sdk/js/5/core-classes/security/index.md similarity index 100% rename from src/sdk/js/5/security/index.md rename to src/sdk/js/5/core-classes/security/index.md diff --git a/src/sdk/js/5/security/is-action-allowed/index.md b/src/sdk/js/5/core-classes/security/is-action-allowed/index.md similarity index 100% rename from src/sdk/js/5/security/is-action-allowed/index.md rename to src/sdk/js/5/core-classes/security/is-action-allowed/index.md diff --git a/src/sdk/js/5/security/is-action-allowed/snippets/is-action-allowed-1.js b/src/sdk/js/5/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.js similarity index 100% rename from src/sdk/js/5/security/is-action-allowed/snippets/is-action-allowed-1.js rename to src/sdk/js/5/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.js diff --git a/src/sdk/js/5/security/profile/index.md b/src/sdk/js/5/core-classes/security/profile/index.md similarity index 100% rename from src/sdk/js/5/security/profile/index.md rename to src/sdk/js/5/core-classes/security/profile/index.md diff --git a/src/sdk/js/5/security/profile/snippets/profile-1.js b/src/sdk/js/5/core-classes/security/profile/snippets/profile-1.js similarity index 100% rename from src/sdk/js/5/security/profile/snippets/profile-1.js rename to src/sdk/js/5/core-classes/security/profile/snippets/profile-1.js diff --git a/src/sdk/js/5/security/replace-user/index.md b/src/sdk/js/5/core-classes/security/replace-user/index.md similarity index 100% rename from src/sdk/js/5/security/replace-user/index.md rename to src/sdk/js/5/core-classes/security/replace-user/index.md diff --git a/src/sdk/js/5/security/replace-user/snippets/replace-user-1.js b/src/sdk/js/5/core-classes/security/replace-user/snippets/replace-user-1.js similarity index 100% rename from src/sdk/js/5/security/replace-user/snippets/replace-user-1.js rename to src/sdk/js/5/core-classes/security/replace-user/snippets/replace-user-1.js diff --git a/src/sdk/js/5/security/role/index.md b/src/sdk/js/5/core-classes/security/role/index.md similarity index 100% rename from src/sdk/js/5/security/role/index.md rename to src/sdk/js/5/core-classes/security/role/index.md diff --git a/src/sdk/js/5/security/role/snippets/role-1.js b/src/sdk/js/5/core-classes/security/role/snippets/role-1.js similarity index 100% rename from src/sdk/js/5/security/role/snippets/role-1.js rename to src/sdk/js/5/core-classes/security/role/snippets/role-1.js diff --git a/src/sdk/js/5/security/scroll-profiles/index.md b/src/sdk/js/5/core-classes/security/scroll-profiles/index.md similarity index 100% rename from src/sdk/js/5/security/scroll-profiles/index.md rename to src/sdk/js/5/core-classes/security/scroll-profiles/index.md diff --git a/src/sdk/js/5/security/scroll-profiles/snippets/scroll-profiles-1.js b/src/sdk/js/5/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.js similarity index 100% rename from src/sdk/js/5/security/scroll-profiles/snippets/scroll-profiles-1.js rename to src/sdk/js/5/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.js diff --git a/src/sdk/js/5/security/scroll-users/index.md b/src/sdk/js/5/core-classes/security/scroll-users/index.md similarity index 100% rename from src/sdk/js/5/security/scroll-users/index.md rename to src/sdk/js/5/core-classes/security/scroll-users/index.md diff --git a/src/sdk/js/5/security/scroll-users/snippets/scroll-users-1.js b/src/sdk/js/5/core-classes/security/scroll-users/snippets/scroll-users-1.js similarity index 100% rename from src/sdk/js/5/security/scroll-users/snippets/scroll-users-1.js rename to src/sdk/js/5/core-classes/security/scroll-users/snippets/scroll-users-1.js diff --git a/src/sdk/js/5/security/search-profiles/index.md b/src/sdk/js/5/core-classes/security/search-profiles/index.md similarity index 100% rename from src/sdk/js/5/security/search-profiles/index.md rename to src/sdk/js/5/core-classes/security/search-profiles/index.md diff --git a/src/sdk/js/5/security/search-profiles/snippets/search-profiles-1.js b/src/sdk/js/5/core-classes/security/search-profiles/snippets/search-profiles-1.js similarity index 100% rename from src/sdk/js/5/security/search-profiles/snippets/search-profiles-1.js rename to src/sdk/js/5/core-classes/security/search-profiles/snippets/search-profiles-1.js diff --git a/src/sdk/js/5/security/search-profiles/snippets/search-profiles-2.js b/src/sdk/js/5/core-classes/security/search-profiles/snippets/search-profiles-2.js similarity index 100% rename from src/sdk/js/5/security/search-profiles/snippets/search-profiles-2.js rename to src/sdk/js/5/core-classes/security/search-profiles/snippets/search-profiles-2.js diff --git a/src/sdk/js/5/security/search-roles/index.md b/src/sdk/js/5/core-classes/security/search-roles/index.md similarity index 100% rename from src/sdk/js/5/security/search-roles/index.md rename to src/sdk/js/5/core-classes/security/search-roles/index.md diff --git a/src/sdk/js/5/security/search-roles/snippets/search-roles-1.js b/src/sdk/js/5/core-classes/security/search-roles/snippets/search-roles-1.js similarity index 100% rename from src/sdk/js/5/security/search-roles/snippets/search-roles-1.js rename to src/sdk/js/5/core-classes/security/search-roles/snippets/search-roles-1.js diff --git a/src/sdk/js/5/security/search-roles/snippets/search-roles-2.js b/src/sdk/js/5/core-classes/security/search-roles/snippets/search-roles-2.js similarity index 100% rename from src/sdk/js/5/security/search-roles/snippets/search-roles-2.js rename to src/sdk/js/5/core-classes/security/search-roles/snippets/search-roles-2.js diff --git a/src/sdk/js/5/security/search-users/index.md b/src/sdk/js/5/core-classes/security/search-users/index.md similarity index 100% rename from src/sdk/js/5/security/search-users/index.md rename to src/sdk/js/5/core-classes/security/search-users/index.md diff --git a/src/sdk/js/5/security/search-users/snippets/search-users-1.js b/src/sdk/js/5/core-classes/security/search-users/snippets/search-users-1.js similarity index 100% rename from src/sdk/js/5/security/search-users/snippets/search-users-1.js rename to src/sdk/js/5/core-classes/security/search-users/snippets/search-users-1.js diff --git a/src/sdk/js/5/security/search-users/snippets/search-users-2.js b/src/sdk/js/5/core-classes/security/search-users/snippets/search-users-2.js similarity index 100% rename from src/sdk/js/5/security/search-users/snippets/search-users-2.js rename to src/sdk/js/5/core-classes/security/search-users/snippets/search-users-2.js diff --git a/src/sdk/js/5/security/update-credentials/index.md b/src/sdk/js/5/core-classes/security/update-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/update-credentials/index.md rename to src/sdk/js/5/core-classes/security/update-credentials/index.md diff --git a/src/sdk/js/5/security/update-credentials/snippets/update-credentials-1.js b/src/sdk/js/5/core-classes/security/update-credentials/snippets/update-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/update-credentials/snippets/update-credentials-1.js rename to src/sdk/js/5/core-classes/security/update-credentials/snippets/update-credentials-1.js diff --git a/src/sdk/js/5/security/update-credentials/snippets/update-credentials-2.js b/src/sdk/js/5/core-classes/security/update-credentials/snippets/update-credentials-2.js similarity index 100% rename from src/sdk/js/5/security/update-credentials/snippets/update-credentials-2.js rename to src/sdk/js/5/core-classes/security/update-credentials/snippets/update-credentials-2.js diff --git a/src/sdk/js/5/security/update-profile/index.md b/src/sdk/js/5/core-classes/security/update-profile/index.md similarity index 100% rename from src/sdk/js/5/security/update-profile/index.md rename to src/sdk/js/5/core-classes/security/update-profile/index.md diff --git a/src/sdk/js/5/security/update-profile/snippets/update-profile-1.js b/src/sdk/js/5/core-classes/security/update-profile/snippets/update-profile-1.js similarity index 100% rename from src/sdk/js/5/security/update-profile/snippets/update-profile-1.js rename to src/sdk/js/5/core-classes/security/update-profile/snippets/update-profile-1.js diff --git a/src/sdk/js/5/security/update-role/index.md b/src/sdk/js/5/core-classes/security/update-role/index.md similarity index 100% rename from src/sdk/js/5/security/update-role/index.md rename to src/sdk/js/5/core-classes/security/update-role/index.md diff --git a/src/sdk/js/5/security/update-role/snippets/update-role-1.js b/src/sdk/js/5/core-classes/security/update-role/snippets/update-role-1.js similarity index 100% rename from src/sdk/js/5/security/update-role/snippets/update-role-1.js rename to src/sdk/js/5/core-classes/security/update-role/snippets/update-role-1.js diff --git a/src/sdk/js/5/security/update-user/index.md b/src/sdk/js/5/core-classes/security/update-user/index.md similarity index 100% rename from src/sdk/js/5/security/update-user/index.md rename to src/sdk/js/5/core-classes/security/update-user/index.md diff --git a/src/sdk/js/5/security/update-user/snippets/update-user-1.js b/src/sdk/js/5/core-classes/security/update-user/snippets/update-user-1.js similarity index 100% rename from src/sdk/js/5/security/update-user/snippets/update-user-1.js rename to src/sdk/js/5/core-classes/security/update-user/snippets/update-user-1.js diff --git a/src/sdk/js/5/security/user/index.md b/src/sdk/js/5/core-classes/security/user/index.md similarity index 100% rename from src/sdk/js/5/security/user/index.md rename to src/sdk/js/5/core-classes/security/user/index.md diff --git a/src/sdk/js/5/security/user/snippets/user-1.js b/src/sdk/js/5/core-classes/security/user/snippets/user-1.js similarity index 100% rename from src/sdk/js/5/security/user/snippets/user-1.js rename to src/sdk/js/5/core-classes/security/user/snippets/user-1.js diff --git a/src/sdk/js/5/security/validate-credentials/index.md b/src/sdk/js/5/core-classes/security/validate-credentials/index.md similarity index 100% rename from src/sdk/js/5/security/validate-credentials/index.md rename to src/sdk/js/5/core-classes/security/validate-credentials/index.md diff --git a/src/sdk/js/5/security/validate-credentials/snippets/validate-credentials-1.js b/src/sdk/js/5/core-classes/security/validate-credentials/snippets/validate-credentials-1.js similarity index 100% rename from src/sdk/js/5/security/validate-credentials/snippets/validate-credentials-1.js rename to src/sdk/js/5/core-classes/security/validate-credentials/snippets/validate-credentials-1.js diff --git a/src/sdk/js/5/security/validate-credentials/snippets/validate-credentials-2.js b/src/sdk/js/5/core-classes/security/validate-credentials/snippets/validate-credentials-2.js similarity index 100% rename from src/sdk/js/5/security/validate-credentials/snippets/validate-credentials-2.js rename to src/sdk/js/5/core-classes/security/validate-credentials/snippets/validate-credentials-2.js diff --git a/src/sdk/js/5/user/add-profile/index.md b/src/sdk/js/5/core-classes/user/add-profile/index.md similarity index 100% rename from src/sdk/js/5/user/add-profile/index.md rename to src/sdk/js/5/core-classes/user/add-profile/index.md diff --git a/src/sdk/js/5/user/add-profile/snippets/add-profile-1.js b/src/sdk/js/5/core-classes/user/add-profile/snippets/add-profile-1.js similarity index 100% rename from src/sdk/js/5/user/add-profile/snippets/add-profile-1.js rename to src/sdk/js/5/core-classes/user/add-profile/snippets/add-profile-1.js diff --git a/src/sdk/js/5/user/constructor/index.md b/src/sdk/js/5/core-classes/user/constructor/index.md similarity index 100% rename from src/sdk/js/5/user/constructor/index.md rename to src/sdk/js/5/core-classes/user/constructor/index.md diff --git a/src/sdk/js/5/user/constructor/snippets/constructor-1.js b/src/sdk/js/5/core-classes/user/constructor/snippets/constructor-1.js similarity index 100% rename from src/sdk/js/5/user/constructor/snippets/constructor-1.js rename to src/sdk/js/5/core-classes/user/constructor/snippets/constructor-1.js diff --git a/src/sdk/js/5/user/create/index.md b/src/sdk/js/5/core-classes/user/create/index.md similarity index 100% rename from src/sdk/js/5/user/create/index.md rename to src/sdk/js/5/core-classes/user/create/index.md diff --git a/src/sdk/js/5/user/create/snippets/create-1.js b/src/sdk/js/5/core-classes/user/create/snippets/create-1.js similarity index 100% rename from src/sdk/js/5/user/create/snippets/create-1.js rename to src/sdk/js/5/core-classes/user/create/snippets/create-1.js diff --git a/src/sdk/js/5/user/delete/index.md b/src/sdk/js/5/core-classes/user/delete/index.md similarity index 100% rename from src/sdk/js/5/user/delete/index.md rename to src/sdk/js/5/core-classes/user/delete/index.md diff --git a/src/sdk/js/5/user/delete/snippets/delete-1.js b/src/sdk/js/5/core-classes/user/delete/snippets/delete-1.js similarity index 100% rename from src/sdk/js/5/user/delete/snippets/delete-1.js rename to src/sdk/js/5/core-classes/user/delete/snippets/delete-1.js diff --git a/src/sdk/js/5/user/get-profileids/index.md b/src/sdk/js/5/core-classes/user/get-profileids/index.md similarity index 100% rename from src/sdk/js/5/user/get-profileids/index.md rename to src/sdk/js/5/core-classes/user/get-profileids/index.md diff --git a/src/sdk/js/5/user/get-profileids/snippets/get-profileids-1.js b/src/sdk/js/5/core-classes/user/get-profileids/snippets/get-profileids-1.js similarity index 100% rename from src/sdk/js/5/user/get-profileids/snippets/get-profileids-1.js rename to src/sdk/js/5/core-classes/user/get-profileids/snippets/get-profileids-1.js diff --git a/src/sdk/js/5/user/get-profiles/index.md b/src/sdk/js/5/core-classes/user/get-profiles/index.md similarity index 100% rename from src/sdk/js/5/user/get-profiles/index.md rename to src/sdk/js/5/core-classes/user/get-profiles/index.md diff --git a/src/sdk/js/5/user/get-profiles/snippets/get-profiles-1.js b/src/sdk/js/5/core-classes/user/get-profiles/snippets/get-profiles-1.js similarity index 100% rename from src/sdk/js/5/user/get-profiles/snippets/get-profiles-1.js rename to src/sdk/js/5/core-classes/user/get-profiles/snippets/get-profiles-1.js diff --git a/src/sdk/js/5/user/index.md b/src/sdk/js/5/core-classes/user/index.md similarity index 100% rename from src/sdk/js/5/user/index.md rename to src/sdk/js/5/core-classes/user/index.md diff --git a/src/sdk/js/5/user/replace/index.md b/src/sdk/js/5/core-classes/user/replace/index.md similarity index 100% rename from src/sdk/js/5/user/replace/index.md rename to src/sdk/js/5/core-classes/user/replace/index.md diff --git a/src/sdk/js/5/user/replace/snippets/replace-1.js b/src/sdk/js/5/core-classes/user/replace/snippets/replace-1.js similarity index 100% rename from src/sdk/js/5/user/replace/snippets/replace-1.js rename to src/sdk/js/5/core-classes/user/replace/snippets/replace-1.js diff --git a/src/sdk/js/5/user/save-restricted/index.md b/src/sdk/js/5/core-classes/user/save-restricted/index.md similarity index 100% rename from src/sdk/js/5/user/save-restricted/index.md rename to src/sdk/js/5/core-classes/user/save-restricted/index.md diff --git a/src/sdk/js/5/user/save-restricted/snippets/save-restricted-1.js b/src/sdk/js/5/core-classes/user/save-restricted/snippets/save-restricted-1.js similarity index 100% rename from src/sdk/js/5/user/save-restricted/snippets/save-restricted-1.js rename to src/sdk/js/5/core-classes/user/save-restricted/snippets/save-restricted-1.js diff --git a/src/sdk/js/5/user/save/index.md b/src/sdk/js/5/core-classes/user/save/index.md similarity index 100% rename from src/sdk/js/5/user/save/index.md rename to src/sdk/js/5/core-classes/user/save/index.md diff --git a/src/sdk/js/5/user/save/snippets/save-1.js b/src/sdk/js/5/core-classes/user/save/snippets/save-1.js similarity index 100% rename from src/sdk/js/5/user/save/snippets/save-1.js rename to src/sdk/js/5/core-classes/user/save/snippets/save-1.js diff --git a/src/sdk/js/5/user/set-content/index.md b/src/sdk/js/5/core-classes/user/set-content/index.md similarity index 100% rename from src/sdk/js/5/user/set-content/index.md rename to src/sdk/js/5/core-classes/user/set-content/index.md diff --git a/src/sdk/js/5/user/set-content/snippets/set-content-1.js b/src/sdk/js/5/core-classes/user/set-content/snippets/set-content-1.js similarity index 100% rename from src/sdk/js/5/user/set-content/snippets/set-content-1.js rename to src/sdk/js/5/core-classes/user/set-content/snippets/set-content-1.js diff --git a/src/sdk/js/5/user/set-credentials/index.md b/src/sdk/js/5/core-classes/user/set-credentials/index.md similarity index 100% rename from src/sdk/js/5/user/set-credentials/index.md rename to src/sdk/js/5/core-classes/user/set-credentials/index.md diff --git a/src/sdk/js/5/user/set-credentials/snippets/set-credentials-1.js b/src/sdk/js/5/core-classes/user/set-credentials/snippets/set-credentials-1.js similarity index 100% rename from src/sdk/js/5/user/set-credentials/snippets/set-credentials-1.js rename to src/sdk/js/5/core-classes/user/set-credentials/snippets/set-credentials-1.js diff --git a/src/sdk/js/5/user/set-profiles/index.md b/src/sdk/js/5/core-classes/user/set-profiles/index.md similarity index 100% rename from src/sdk/js/5/user/set-profiles/index.md rename to src/sdk/js/5/core-classes/user/set-profiles/index.md diff --git a/src/sdk/js/5/user/set-profiles/snippets/set-profiles-1.js b/src/sdk/js/5/core-classes/user/set-profiles/snippets/set-profiles-1.js similarity index 100% rename from src/sdk/js/5/user/set-profiles/snippets/set-profiles-1.js rename to src/sdk/js/5/core-classes/user/set-profiles/snippets/set-profiles-1.js diff --git a/src/sdk/js/5/user/update/index.md b/src/sdk/js/5/core-classes/user/update/index.md similarity index 100% rename from src/sdk/js/5/user/update/index.md rename to src/sdk/js/5/core-classes/user/update/index.md diff --git a/src/sdk/js/5/user/update/snippets/update-1.js b/src/sdk/js/5/core-classes/user/update/snippets/update-1.js similarity index 100% rename from src/sdk/js/5/user/update/snippets/update-1.js rename to src/sdk/js/5/core-classes/user/update/snippets/update-1.js diff --git a/src/sdk/js/5/handling-errors/index.md b/src/sdk/js/5/essentials/error-handling/index.md similarity index 100% rename from src/sdk/js/5/handling-errors/index.md rename to src/sdk/js/5/essentials/error-handling/index.md diff --git a/src/sdk/js/5/handling-errors/snippets/handling-errors-1.js b/src/sdk/js/5/essentials/error-handling/snippets/handling-errors-1.js similarity index 100% rename from src/sdk/js/5/handling-errors/snippets/handling-errors-1.js rename to src/sdk/js/5/essentials/error-handling/snippets/handling-errors-1.js diff --git a/src/sdk/js/5/events/index.md b/src/sdk/js/5/essentials/events/index.md similarity index 100% rename from src/sdk/js/5/events/index.md rename to src/sdk/js/5/essentials/events/index.md diff --git a/src/sdk/js/5/essentials/index.md b/src/sdk/js/5/essentials/index.md new file mode 100644 index 000000000..20d0cd882 --- /dev/null +++ b/src/sdk/js/5/essentials/index.md @@ -0,0 +1,7 @@ +--- +code: false +type: branch +order: 0 +title: Essentials +description: Javascript SDK v5.x essential notions +--- diff --git a/src/sdk/js/5/offline-first/index.md b/src/sdk/js/5/essentials/offline-tools/index.md similarity index 98% rename from src/sdk/js/5/offline-first/index.md rename to src/sdk/js/5/essentials/offline-tools/index.md index 5ab404293..3fc39b16b 100644 --- a/src/sdk/js/5/offline-first/index.md +++ b/src/sdk/js/5/essentials/offline-tools/index.md @@ -1,11 +1,11 @@ --- code: false type: page -title: Offline First +title: Offline Tools order: 400 --- -# Offline First +# Offline Tools When using an unstable network connection, an application must maintain a normal behavior when it is disconnected. Our goal is to provide the right toolkit to handle such situations. @@ -32,7 +32,7 @@ While in offline mode, the Kuzzle SDK client maintains all subscriptions configu ## API Requests -While in offline mode, API requests can be queued, and then executed once the network connection has been reestablished. +While in offline mode, API requests can be queued, and then executed once the network connection has been reestablished. By default, there is no request queuing. - Queue all requests automatically when going offline by setting the `autoQueue` option to `true` (see [Kuzzle SDK constructor](/sdk/js/5/kuzzle)) @@ -76,7 +76,7 @@ The `offlineQueuePush` event is fired whenever a request is queued. It will emit The `offlineQueuePop` event is fired whenever a request has been removed from the queue, either because the queue limits have been reached, or because the request has been replayed. It provides the removed request to its listeners. -The `offlineQueueLoader` property of the Kuzzle SDK instance loads requests to the queue, **before any previously queued request**. It is invoked every time the Kuzzle SDK starts dequeuing requests. +The `offlineQueueLoader` property of the Kuzzle SDK instance loads requests to the queue, **before any previously queued request**. It is invoked every time the Kuzzle SDK starts dequeuing requests. This property must be set with a function that returns an array of objects with the following accessible properties: - a `query` property, containing the request to be replayed diff --git a/src/sdk/js/5/notifications/index.md b/src/sdk/js/5/essentials/realtime-notifications/index.md similarity index 98% rename from src/sdk/js/5/notifications/index.md rename to src/sdk/js/5/essentials/realtime-notifications/index.md index 1d4873d98..678d3b4b9 100644 --- a/src/sdk/js/5/notifications/index.md +++ b/src/sdk/js/5/essentials/realtime-notifications/index.md @@ -1,11 +1,11 @@ --- code: false type: page -title: Notifications +title: Realtime Notifications order: 300 --- -# Notifications +# Realtime Notifications With Kuzzle, you don't [subscribe](/sdk/js/5/collection/subscribe) to a room or a topic but, instead, you subscribe to documents. This means, that when you want to subscribe you must provide a set of filter definitions, using [Koncorde](/core/1/koncorde), that tell Kuzzle what documents should trigger a notification. Then, any time a document matches the defined filters, Kuzzle will send a notification to the subscriber. diff --git a/src/sdk/js/5/notifications/snippets/notifications-1.js b/src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-1.js similarity index 100% rename from src/sdk/js/5/notifications/snippets/notifications-1.js rename to src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-1.js diff --git a/src/sdk/js/5/notifications/snippets/notifications-2.js b/src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-2.js similarity index 100% rename from src/sdk/js/5/notifications/snippets/notifications-2.js rename to src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-2.js diff --git a/src/sdk/js/5/notifications/snippets/notifications-3.js b/src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-3.js similarity index 100% rename from src/sdk/js/5/notifications/snippets/notifications-3.js rename to src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-3.js diff --git a/src/sdk/js/5/notifications/snippets/notifications-4.js b/src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-4.js similarity index 100% rename from src/sdk/js/5/notifications/snippets/notifications-4.js rename to src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-4.js diff --git a/src/sdk/js/5/notifications/snippets/notifications-5.js b/src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-5.js similarity index 100% rename from src/sdk/js/5/notifications/snippets/notifications-5.js rename to src/sdk/js/5/essentials/realtime-notifications/snippets/notifications-5.js diff --git a/src/sdk/js/6/controllers/auth/login/index.md b/src/sdk/js/6/controllers/auth/login/index.md index 9d51b5701..5d92dc8a8 100644 --- a/src/sdk/js/6/controllers/auth/login/index.md +++ b/src/sdk/js/6/controllers/auth/login/index.md @@ -34,7 +34,7 @@ The name of the [authentication strategy](/core/1/guide/guides/kuzzle-depth/auth Depending on the chosen authentication strategy, additional credential arguments may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn From d237e73ee394b23ccfaf34ce7bf36c1078a402ae Mon Sep 17 00:00:00 2001 From: Aschen Date: Fri, 31 May 2019 16:27:06 +0200 Subject: [PATCH 02/10] Fix missing redirections --- check_redirections.rb | 42 ++++ redirections.yml | 207 ++++++++++-------- src/create.js | 39 ---- .../collection-mapping/apply/index.md | 0 .../apply/snippets/apply-1.php | 0 .../collection-mapping/constructor/index.md | 4 +- .../constructor/snippets/constructor-1.php | 0 .../collection-mapping/index.md | 0 .../collection-mapping/refresh/index.md | 0 .../refresh/snippets/refresh-1.php | 0 .../collection-mapping/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.php | 0 .../collection-mapping/set/index.md | 0 .../collection-mapping/set/snippets/set-1.php | 0 .../collection/collection-mapping/index.md | 4 +- .../snippets/collection-mapping-1.php | 0 .../collection/constructor/index.md | 2 +- .../constructor/snippets/constructor-1.php | 0 .../collection/count/index.md | 0 .../collection/count/snippets/count-1.php | 0 .../collection/create-document/index.md | 6 +- .../snippets/create-document-1.php | 0 .../collection/create/index.md | 0 .../collection/create/snippets/create-1.php | 0 .../collection/delete-document/index.md | 0 .../snippets/delete-document-1.php | 0 .../collection/delete-specifications/index.md | 0 .../snippets/delete-specifications-1.php | 0 .../collection/document/index.md | 2 +- .../document/snippets/document-1.php | 0 .../collection/fetch-document/index.md | 4 +- .../snippets/fetch-document-1.php | 0 .../collection/get-mapping/index.md | 4 +- .../get-mapping/snippets/get-mapping-1.php | 0 .../collection/get-specifications/index.md | 0 .../snippets/get-specifications-1.php | 0 .../collection/index.md | 0 .../collection/mcreate-document/index.md | 4 +- .../snippets/mcreate-document-1.php | 0 .../mcreate-or-replace-document/index.md | 4 +- .../mcreate-or-replace-document-1.php | 0 .../collection/mdelete-document/index.md | 2 +- .../snippets/mdelete-document-1.php | 0 .../collection/mget-document/index.md | 2 +- .../snippets/mget-document-1.php | 0 .../collection/mreplace-document/index.md | 4 +- .../snippets/mreplace-document-1.php | 0 .../collection/mupdate-document/index.md | 4 +- .../snippets/mupdate-document-1.php | 0 .../collection/publish-message/index.md | 2 +- .../snippets/publish-message-1.php | 0 .../collection/replace-document/index.md | 4 +- .../snippets/replace-document-1.php | 0 .../collection/scroll-specifications/index.md | 0 .../snippets/scroll-specifications-1.php | 0 .../collection/scroll/index.md | 2 +- .../collection/scroll/snippets/scroll-1.php | 0 .../collection/search-specifications/index.md | 0 .../snippets/search-specifications-1.php | 0 .../collection/search/index.md | 4 +- .../collection/search/snippets/search-1.php | 0 .../collection/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.php | 0 .../collection/truncate/index.md | 0 .../truncate/snippets/truncate-1.php | 0 .../collection/update-document/index.md | 4 +- .../snippets/update-document-1.php | 0 .../collection/update-specifications/index.md | 0 .../snippets/update-specifications-1.php | 0 .../validate-specifications/index.md | 0 .../snippets/validate-specifications-1.php | 0 .../document/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../document/delete/index.md | 0 .../document/delete/snippets/delete-1.php | 0 .../document/exists/index.md | 0 .../document/exists/snippets/exists-1.php | 0 .../document/index.md | 0 .../document/publish/index.md | 0 .../document/publish/snippets/publish-1.php | 0 .../document/refresh/index.md | 0 .../document/refresh/snippets/refresh-1.php | 0 .../document/save/index.md | 0 .../document/save/snippets/save-1.php | 0 .../document/set-content/index.md | 0 .../set-content/snippets/set-content-1.php | 0 .../document/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.php | 0 .../php/3/{classes => core-classes}/index.md | 0 .../kuzzle/add-listener/index.md | 0 .../add-listener/snippets/add-listener-1.php | 0 .../kuzzle/check-token/index.md | 0 .../check-token/snippets/check-token-1.php | 0 .../kuzzle/collection/index.md | 0 .../collection/snippets/collection-1.php | 0 .../kuzzle/connect/index.md | 0 .../kuzzle/connect/snippets/connect-1.php | 0 .../kuzzle/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../kuzzle/create-index/index.md | 0 .../create-index/snippets/create-index-1.php | 0 .../kuzzle/create-my-credentials/index.md | 0 .../snippets/create-my-credentials-1.php | 0 .../kuzzle/delete-my-credentials/index.md | 0 .../snippets/delete-my-credentials-1.php | 0 .../kuzzle/disconnect/index.md | 4 +- .../disconnect/snippets/disconnect-1.php | 0 .../kuzzle/flush-queue/index.md | 0 .../flush-queue/snippets/flush-queue-1.php | 0 .../kuzzle/get-all-statistics/index.md | 0 .../snippets/get-all-statistics-1.php | 0 .../kuzzle/get-auto-refresh/index.md | 0 .../snippets/get-auto-refresh-1.php | 0 .../kuzzle/get-jwt-token/index.md | 0 .../snippets/get-jwt-token-1.php | 0 .../kuzzle/get-my-credentials/index.md | 0 .../snippets/get-my-credentials-1.php | 0 .../kuzzle/get-my-rights/index.md | 0 .../snippets/get-my-rights-1.php | 0 .../kuzzle/get-server-info/index.md | 0 .../snippets/get-server-info-1.php | 0 .../kuzzle/get-statistics/index.md | 0 .../snippets/get-statistics-1.php | 0 .../snippets/get-statistics-2.php | 0 .../{classes => core-classes}/kuzzle/index.md | 0 .../kuzzle/list-collections/index.md | 0 .../snippets/list-collections-1.php | 0 .../kuzzle/list-indexes/index.md | 0 .../list-indexes/snippets/list-indexes-1.php | 0 .../kuzzle/login/index.md | 0 .../kuzzle/login/snippets/login-1.php | 0 .../kuzzle/logout/index.md | 0 .../kuzzle/logout/snippets/logout-1.php | 0 .../kuzzle/memory-storage/index.md | 0 .../kuzzle/now/index.md | 0 .../kuzzle/now/snippets/now-1.php | 0 .../kuzzle/query/index.md | 0 .../kuzzle/query/snippets/query-1.php | 0 .../kuzzle/refresh-index/index.md | 0 .../snippets/refresh-index-1.php | 0 .../kuzzle/remove-all-listeners/index.md | 0 .../snippets/remove-all-listeners-1.php | 0 .../kuzzle/remove-listener/index.md | 0 .../snippets/remove-listener-1.php | 0 .../kuzzle/replay-queue/index.md | 0 .../replay-queue/snippets/replay-queue-1.php | 0 .../kuzzle/security/index.md | 0 .../kuzzle/set-auto-refresh/index.md | 0 .../snippets/set-auto-refresh-1.php | 0 .../kuzzle/set-default-index/index.md | 0 .../snippets/set-default-index-1.php | 0 .../kuzzle/set-headers/index.md | 0 .../set-headers/snippets/set-headers-1.php | 0 .../kuzzle/set-jwt-token/index.md | 0 .../snippets/set-jwt-token-1.php | 0 .../kuzzle/start-queuing/index.md | 0 .../snippets/start-queuing-1.php | 0 .../kuzzle/stop-queuing/index.md | 0 .../stop-queuing/snippets/stop-queuing-1.php | 0 .../kuzzle/unset-jwt-token/index.md | 0 .../snippets/unset-jwt-token-1.php | 0 .../kuzzle/update-my-credentials/index.md | 0 .../snippets/update-my-credentials-1.php | 0 .../kuzzle/update-self/index.md | 0 .../update-self/snippets/update-self-1.php | 0 .../kuzzle/validate-my-credentials/index.md | 0 .../snippets/validate-my-credentials-1.php | 0 .../kuzzle/who-am-i/index.md | 0 .../kuzzle/who-am-i/snippets/who-am-i-1.php | 0 .../memory-storage/append/index.md | 0 .../append/snippets/append-1.php | 0 .../memory-storage/bitcount/index.md | 0 .../bitcount/snippets/bitcount-1.php | 0 .../memory-storage/bitop/index.md | 0 .../memory-storage/bitop/snippets/bitop-1.php | 0 .../memory-storage/bitpos/index.md | 0 .../bitpos/snippets/bitpos-1.php | 0 .../memory-storage/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../memory-storage/dbsize/index.md | 0 .../dbsize/snippets/dbsize-1.php | 0 .../memory-storage/decr/index.md | 0 .../memory-storage/decr/snippets/decr-1.php | 0 .../memory-storage/decrby/index.md | 0 .../decrby/snippets/decrby-1.php | 0 .../memory-storage/del/index.md | 0 .../memory-storage/del/snippets/del-1.php | 0 .../memory-storage/exists/index.md | 0 .../exists/snippets/exists-1.php | 0 .../memory-storage/expire/index.md | 0 .../expire/snippets/expire-1.php | 0 .../memory-storage/expireat/index.md | 0 .../expireat/snippets/expireat-1.php | 0 .../memory-storage/flushdb/index.md | 0 .../flushdb/snippets/flushdb-1.php | 0 .../memory-storage/geoadd/index.md | 0 .../geoadd/snippets/geoadd-1.php | 0 .../memory-storage/geodist/index.md | 2 +- .../geodist/snippets/geodist-1.php | 0 .../memory-storage/geohash/index.md | 2 +- .../geohash/snippets/geohash-1.php | 0 .../memory-storage/geopos/index.md | 2 +- .../geopos/snippets/geopos-1.php | 0 .../memory-storage/georadius/index.md | 2 +- .../georadius/snippets/georadius-1.php | 0 .../memory-storage/georadiusbymember/index.md | 2 +- .../snippets/georadiusbymember-1.php | 0 .../memory-storage/get/index.md | 0 .../memory-storage/get/snippets/get-1.php | 0 .../memory-storage/getbit/index.md | 0 .../getbit/snippets/getbit-1.php | 0 .../memory-storage/getrange/index.md | 0 .../getrange/snippets/getrange-1.php | 0 .../memory-storage/getset/index.md | 0 .../getset/snippets/getset-1.php | 0 .../memory-storage/hdel/index.md | 0 .../memory-storage/hdel/snippets/hdel-1.php | 0 .../memory-storage/hexists/index.md | 0 .../hexists/snippets/hexists-1.php | 0 .../memory-storage/hget/index.md | 0 .../memory-storage/hget/snippets/hget-1.php | 0 .../memory-storage/hgetall/index.md | 0 .../hgetall/snippets/hgetall-1.php | 0 .../memory-storage/hincrby/index.md | 0 .../hincrby/snippets/hincrby-1.php | 0 .../memory-storage/hincrbyfloat/index.md | 0 .../hincrbyfloat/snippets/hincrbyfloat-1.php | 0 .../memory-storage/hkeys/index.md | 0 .../memory-storage/hkeys/snippets/hkeys-1.php | 0 .../memory-storage/hlen/index.md | 0 .../memory-storage/hlen/snippets/hlen-1.php | 0 .../memory-storage/hmget/index.md | 0 .../memory-storage/hmget/snippets/hmget-1.php | 0 .../memory-storage/hmset/index.md | 0 .../memory-storage/hmset/snippets/hmset-1.php | 0 .../memory-storage/hscan/index.md | 2 +- .../memory-storage/hscan/snippets/hscan-1.php | 0 .../memory-storage/hset/index.md | 0 .../memory-storage/hset/snippets/hset-1.php | 0 .../memory-storage/hsetnx/index.md | 0 .../hsetnx/snippets/hsetnx-1.php | 0 .../memory-storage/hstrlen/index.md | 0 .../hstrlen/snippets/hstrlen-1.php | 0 .../memory-storage/hvals/index.md | 0 .../memory-storage/hvals/snippets/hvals-1.php | 0 .../memory-storage/incr/index.md | 0 .../memory-storage/incr/snippets/incr-1.php | 0 .../memory-storage/incrby/index.md | 0 .../incrby/snippets/incrby-1.php | 0 .../memory-storage/incrbyfloat/index.md | 0 .../incrbyfloat/snippets/incrbyfloat-1.php | 0 .../memory-storage/index.md | 0 .../memory-storage/keys/index.md | 0 .../memory-storage/keys/snippets/keys-1.php | 0 .../memory-storage/lindex/index.md | 0 .../lindex/snippets/lindex-1.php | 0 .../memory-storage/linsert/index.md | 0 .../linsert/snippets/linsert-1.php | 0 .../memory-storage/llen/index.md | 0 .../memory-storage/llen/snippets/llen-1.php | 0 .../memory-storage/lpop/index.md | 0 .../memory-storage/lpop/snippets/lpop-1.php | 0 .../memory-storage/lpush/index.md | 0 .../memory-storage/lpush/snippets/lpush-1.php | 0 .../memory-storage/lpushx/index.md | 0 .../lpushx/snippets/lpushx-1.php | 0 .../memory-storage/lrange/index.md | 0 .../lrange/snippets/lrange-1.php | 0 .../memory-storage/lrem/index.md | 0 .../memory-storage/lrem/snippets/lrem-1.php | 0 .../memory-storage/lset/index.md | 0 .../memory-storage/lset/snippets/lset-1.php | 0 .../memory-storage/ltrim/index.md | 0 .../memory-storage/ltrim/snippets/ltrim-1.php | 0 .../memory-storage/mget/index.md | 0 .../memory-storage/mget/snippets/mget-1.php | 0 .../memory-storage/mset/index.md | 0 .../memory-storage/mset/snippets/mset-1.php | 0 .../memory-storage/msetnx/index.md | 0 .../msetnx/snippets/msetnx-1.php | 0 .../memory-storage/object/index.md | 0 .../object/snippets/object-1.php | 0 .../memory-storage/persist/index.md | 0 .../persist/snippets/persist-1.php | 0 .../memory-storage/pexpire/index.md | 0 .../pexpire/snippets/pexpire-1.php | 0 .../memory-storage/pexpireat/index.md | 0 .../pexpireat/snippets/pexpireat-1.php | 0 .../memory-storage/pfadd/index.md | 0 .../memory-storage/pfadd/snippets/pfadd-1.php | 0 .../memory-storage/pfcount/index.md | 2 +- .../pfcount/snippets/pfcount-1.php | 0 .../memory-storage/pfmerge/index.md | 0 .../pfmerge/snippets/pfmerge-1.php | 0 .../memory-storage/ping/index.md | 0 .../memory-storage/ping/snippets/ping-1.php | 0 .../memory-storage/psetex/index.md | 0 .../psetex/snippets/psetex-1.php | 0 .../memory-storage/pttl/index.md | 0 .../memory-storage/pttl/snippets/pttl-1.php | 0 .../memory-storage/randomkey/index.md | 0 .../randomkey/snippets/randomkey-1.php | 0 .../memory-storage/rename/index.md | 0 .../rename/snippets/rename-1.php | 0 .../memory-storage/renamenx/index.md | 0 .../renamenx/snippets/renamenx-1.php | 0 .../memory-storage/rpop/index.md | 0 .../memory-storage/rpop/snippets/rpop-1.php | 0 .../memory-storage/rpoplpush/index.md | 0 .../rpoplpush/snippets/rpoplpush-1.php | 0 .../memory-storage/rpush/index.md | 0 .../memory-storage/rpush/snippets/rpush-1.php | 0 .../memory-storage/rpushx/index.md | 0 .../rpushx/snippets/rpushx-1.php | 0 .../memory-storage/sadd/index.md | 0 .../memory-storage/sadd/snippets/sadd-1.php | 0 .../memory-storage/scan/index.md | 0 .../memory-storage/scan/snippets/scan-1.php | 0 .../memory-storage/scard/index.md | 0 .../memory-storage/scard/snippets/scard-1.php | 0 .../memory-storage/sdiff/index.md | 0 .../memory-storage/sdiff/snippets/sdiff-1.php | 0 .../memory-storage/sdiffstore/index.md | 0 .../sdiffstore/snippets/sdiffstore-1.php | 0 .../memory-storage/set/index.md | 0 .../memory-storage/set/snippets/set-1.php | 0 .../memory-storage/setex/index.md | 0 .../memory-storage/setex/snippets/setex-1.php | 0 .../memory-storage/setnx/index.md | 0 .../memory-storage/setnx/snippets/setnx-1.php | 0 .../memory-storage/sinter/index.md | 0 .../sinter/snippets/sinter-1.php | 0 .../memory-storage/sinterstore/index.md | 0 .../sinterstore/snippets/sinterstore-1.php | 0 .../memory-storage/sismember/index.md | 0 .../sismember/snippets/sismember-1.php | 0 .../memory-storage/smembers/index.md | 0 .../smembers/snippets/smembers-1.php | 0 .../memory-storage/smove/index.md | 0 .../memory-storage/smove/snippets/smove-1.php | 0 .../memory-storage/sort/index.md | 2 +- .../memory-storage/sort/snippets/sort-1.php | 0 .../memory-storage/spop/index.md | 0 .../memory-storage/spop/snippets/spop-1.php | 0 .../memory-storage/srandmember/index.md | 0 .../srandmember/snippets/srandmember-1.php | 0 .../memory-storage/srem/index.md | 0 .../memory-storage/srem/snippets/srem-1.php | 0 .../memory-storage/sscan/index.md | 2 +- .../memory-storage/sscan/snippets/sscan-1.php | 0 .../memory-storage/strlen/index.md | 0 .../strlen/snippets/strlen-1.php | 0 .../memory-storage/sunion/index.md | 0 .../sunion/snippets/sunion-1.php | 0 .../memory-storage/sunionstore/index.md | 0 .../sunionstore/snippets/sunionstore-1.php | 0 .../memory-storage/time/index.md | 0 .../memory-storage/time/snippets/time-1.php | 0 .../memory-storage/touch/index.md | 0 .../memory-storage/touch/snippets/touch-1.php | 0 .../memory-storage/ttl/index.md | 0 .../memory-storage/ttl/snippets/ttl-1.php | 0 .../memory-storage/type/index.md | 0 .../memory-storage/type/snippets/type-1.php | 0 .../memory-storage/zadd/index.md | 0 .../memory-storage/zadd/snippets/zadd-1.php | 0 .../memory-storage/zcard/index.md | 0 .../memory-storage/zcard/snippets/zcard-1.php | 0 .../memory-storage/zcount/index.md | 0 .../zcount/snippets/zcount-1.php | 0 .../memory-storage/zincrby/index.md | 0 .../zincrby/snippets/zincrby-1.php | 0 .../memory-storage/zinterstore/index.md | 0 .../zinterstore/snippets/zinterstore-1.php | 0 .../memory-storage/zlexcount/index.md | 0 .../zlexcount/snippets/zlexcount-1.php | 0 .../memory-storage/zrange/index.md | 0 .../zrange/snippets/zrange-1.php | 0 .../memory-storage/zrangebylex/index.md | 0 .../zrangebylex/snippets/zrangebylex-1.php | 0 .../memory-storage/zrangebyscore/index.md | 0 .../snippets/zrangebyscore-1.php | 0 .../memory-storage/zrank/index.md | 0 .../memory-storage/zrank/snippets/zrank-1.php | 0 .../memory-storage/zrem/index.md | 0 .../memory-storage/zrem/snippets/zrem-1.php | 0 .../memory-storage/zremrangebylex/index.md | 0 .../snippets/zremrangebylex-1.php | 0 .../memory-storage/zremrangebyrank/index.md | 0 .../snippets/zremrangebyrank-1.php | 0 .../memory-storage/zremrangebyscore/index.md | 0 .../snippets/zremrangebyscore-1.php | 0 .../memory-storage/zrevrange/index.md | 2 +- .../zrevrange/snippets/zrevrange-1.php | 0 .../memory-storage/zrevrangebylex/index.md | 2 +- .../snippets/zrevrangebylex-1.php | 0 .../memory-storage/zrevrangebyscore/index.md | 2 +- .../snippets/zrevrangebyscore-1.php | 0 .../memory-storage/zrevrank/index.md | 0 .../zrevrank/snippets/zrevrank-1.php | 0 .../memory-storage/zscan/index.md | 2 +- .../memory-storage/zscan/snippets/zscan-1.php | 0 .../memory-storage/zscore/index.md | 0 .../zscore/snippets/zscore-1.php | 0 .../memory-storage/zunionstore/index.md | 0 .../zunionstore/snippets/zunionstore-1.php | 0 .../profile/add-policy/index.md | 2 +- .../profile/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../profile/delete/index.md | 0 .../profile/delete/snippets/delete-1.php | 0 .../profile/get-policies/index.md | 0 .../get-policies/snippets/get-policies-1.php | 0 .../profile/index.md | 0 .../profile/save/index.md | 0 .../profile/save/snippets/save-1.php | 0 .../profile/set-content/index.md | 0 .../set-content/snippets/set-content-1.php | 0 .../profile/set-policies/index.md | 0 .../profile/update/index.md | 0 .../profile/update/snippets/update-1.php | 0 .../role/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../role/delete/index.md | 0 .../role/delete/snippets/delete-1.php | 0 .../3/{classes => core-classes}/role/index.md | 0 .../role/save/index.md | 0 .../role/save/snippets/save-1.php | 0 .../role/set-content/index.md | 2 +- .../set-content/snippets/set-content-1.php | 0 .../role/update/index.md | 2 +- .../role/update/snippets/update-1.php | 0 .../search-result/constructor/index.md | 2 +- .../search-result/fetch-next/index.md | 0 .../fetch-next/snippets/fetch-next-1.php | 0 .../fetch-next/snippets/fetch-next-2.php | 0 .../search-result/index.md | 0 .../security/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../security/create-credentials/index.md | 0 .../snippets/create-credentials-1.php | 0 .../security/create-profile/index.md | 0 .../snippets/create-profile-1.php | 0 .../security/create-restricted-user/index.md | 0 .../snippets/create-restricted-user-1.php | 0 .../security/create-role/index.md | 0 .../create-role/snippets/create-role-1.php | 0 .../security/create-user/index.md | 0 .../create-user/snippets/create-user-1.php | 0 .../security/delete-credentials/index.md | 0 .../snippets/delete-credentials-1.php | 0 .../security/delete-profile/index.md | 0 .../snippets/delete-profile-1.php | 0 .../security/delete-role/index.md | 0 .../delete-role/snippets/delete-role-1.php | 0 .../security/delete-user/index.md | 0 .../delete-user/snippets/delete-user-1.php | 0 .../security/fetch-profile/index.md | 0 .../snippets/fetch-profile-1.php | 0 .../security/fetch-role/index.md | 0 .../fetch-role/snippets/fetch-role-1.php | 0 .../security/fetch-user/index.md | 0 .../fetch-user/snippets/fetch-user-1.php | 0 .../get-all-credential-fields/index.md | 0 .../snippets/get-all-credential-fields-1.php | 0 .../security/get-credentials-fields/index.md | 0 .../snippets/get-credentials-fields-1.php | 0 .../security/get-credentials/index.md | 0 .../snippets/get-credentials-1.php | 0 .../security/get-user-rights/index.md | 0 .../snippets/get-user-rights-1.php | 0 .../security/has-credentials/index.md | 0 .../snippets/has-credentials-1.php | 0 .../security/index.md | 0 .../security/is-action-allowed/index.md | 2 +- .../snippets/is-action-allowed-1.php | 0 .../security/profile/index.md | 0 .../security/profile/snippets/profile-1.php | 0 .../security/replace-user/index.md | 0 .../replace-user/snippets/replace-user-1.php | 0 .../security/role/index.md | 0 .../security/role/snippets/role-1.php | 0 .../security/scroll-profiles/index.md | 0 .../snippets/scroll-profiles-1.php | 0 .../security/scroll-users/index.md | 0 .../scroll-users/snippets/scroll-users-1.php | 0 .../security/search-profiles/index.md | 0 .../snippets/search-profiles-1.php | 0 .../security/search-roles/index.md | 0 .../search-roles/snippets/search-roles-1.php | 0 .../security/search-users/index.md | 0 .../search-users/snippets/search-users-1.php | 0 .../security/update-credentials/index.md | 0 .../snippets/update-credentials-1.php | 0 .../security/update-profile/index.md | 0 .../snippets/update-profile-1.php | 0 .../security/update-role/index.md | 0 .../update-role/snippets/update-role-1.php | 0 .../security/update-user/index.md | 0 .../update-user/snippets/update-user-1.php | 0 .../security/user/index.md | 0 .../security/user/snippets/user-1.php | 0 .../security/validate-credentials/index.md | 0 .../snippets/validate-credentials-1.php | 0 .../user/add-profile/index.md | 2 +- .../add-profile/snippets/add-profile-1.php | 0 .../user/constructor/index.md | 0 .../constructor/snippets/constructor-1.php | 0 .../user/create/index.md | 2 +- .../user/create/snippets/create-1.php | 0 .../user/delete/index.md | 0 .../user/delete/snippets/delete-1.php | 0 .../user/get-profileids/index.md | 0 .../snippets/get-profileids-1.php | 0 .../user/get-profiles/index.md | 0 .../get-profiles/snippets/get-profiles-1.php | 0 .../3/{classes => core-classes}/user/index.md | 0 .../user/replace/index.md | 0 .../user/replace/snippets/replace-1.php | 0 .../user/save-restricted/index.md | 0 .../snippets/save-restricted-1.php | 0 .../user/save/index.md | 0 .../user/save/snippets/save-1.php | 0 .../user/set-content/index.md | 2 +- .../set-content/snippets/set-content-1.php | 0 .../user/set-credentials/index.md | 2 +- .../snippets/set-credentials-1.php | 0 .../user/set-profiles/index.md | 0 .../set-profiles/snippets/set-profiles-1.php | 0 .../user/update/index.md | 0 .../user/update/snippets/update-1.php | 0 .../index.md | 0 .../snippets/handling-errors-1.php | 0 src/sdk/php/3/essentials/events/index.md | 2 +- 534 files changed, 216 insertions(+), 184 deletions(-) create mode 100644 check_redirections.rb delete mode 100644 src/create.js rename src/sdk/php/3/{classes => core-classes}/collection-mapping/apply/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/apply/snippets/apply-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/constructor/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/refresh/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/refresh/snippets/refresh-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/set-headers/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/set-headers/snippets/set-headers-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/set/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection-mapping/set/snippets/set-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/collection-mapping/index.md (64%) rename src/sdk/php/3/{classes => core-classes}/collection/collection-mapping/snippets/collection-mapping-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/constructor/index.md (93%) rename src/sdk/php/3/{classes => core-classes}/collection/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/count/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/count/snippets/count-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/create-document/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/collection/create-document/snippets/create-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/create/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/create/snippets/create-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/delete-document/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/delete-document/snippets/delete-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/delete-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/delete-specifications/snippets/delete-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/document/index.md (84%) rename src/sdk/php/3/{classes => core-classes}/collection/document/snippets/document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/fetch-document/index.md (86%) rename src/sdk/php/3/{classes => core-classes}/collection/fetch-document/snippets/fetch-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/get-mapping/index.md (83%) rename src/sdk/php/3/{classes => core-classes}/collection/get-mapping/snippets/get-mapping-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/get-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/get-specifications/snippets/get-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mcreate-document/index.md (87%) rename src/sdk/php/3/{classes => core-classes}/collection/mcreate-document/snippets/mcreate-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mcreate-or-replace-document/index.md (87%) rename src/sdk/php/3/{classes => core-classes}/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mdelete-document/index.md (91%) rename src/sdk/php/3/{classes => core-classes}/collection/mdelete-document/snippets/mdelete-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mget-document/index.md (91%) rename src/sdk/php/3/{classes => core-classes}/collection/mget-document/snippets/mget-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mreplace-document/index.md (87%) rename src/sdk/php/3/{classes => core-classes}/collection/mreplace-document/snippets/mreplace-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/mupdate-document/index.md (87%) rename src/sdk/php/3/{classes => core-classes}/collection/mupdate-document/snippets/mupdate-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/publish-message/index.md (94%) rename src/sdk/php/3/{classes => core-classes}/collection/publish-message/snippets/publish-message-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/replace-document/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/collection/replace-document/snippets/replace-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/scroll-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/scroll-specifications/snippets/scroll-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/scroll/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/collection/scroll/snippets/scroll-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/search-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/search-specifications/snippets/search-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/search/index.md (91%) rename src/sdk/php/3/{classes => core-classes}/collection/search/snippets/search-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/set-headers/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/set-headers/snippets/set-headers-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/truncate/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/truncate/snippets/truncate-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/update-document/index.md (95%) rename src/sdk/php/3/{classes => core-classes}/collection/update-document/snippets/update-document-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/update-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/update-specifications/snippets/update-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/collection/validate-specifications/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/collection/validate-specifications/snippets/validate-specifications-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/delete/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/delete/snippets/delete-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/exists/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/exists/snippets/exists-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/publish/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/publish/snippets/publish-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/refresh/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/refresh/snippets/refresh-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/save/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/save/snippets/save-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/set-content/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/set-content/snippets/set-content-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/document/set-headers/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/document/set-headers/snippets/set-headers-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/add-listener/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/add-listener/snippets/add-listener-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/check-token/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/check-token/snippets/check-token-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/collection/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/collection/snippets/collection-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/connect/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/connect/snippets/connect-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/create-index/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/create-index/snippets/create-index-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/create-my-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/create-my-credentials/snippets/create-my-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/delete-my-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/disconnect/index.md (81%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/disconnect/snippets/disconnect-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/flush-queue/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/flush-queue/snippets/flush-queue-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-all-statistics/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-all-statistics/snippets/get-all-statistics-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-auto-refresh/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-jwt-token/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-jwt-token/snippets/get-jwt-token-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-my-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-my-credentials/snippets/get-my-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-my-rights/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-my-rights/snippets/get-my-rights-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-server-info/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-server-info/snippets/get-server-info-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-statistics/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-statistics/snippets/get-statistics-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/get-statistics/snippets/get-statistics-2.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/list-collections/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/list-collections/snippets/list-collections-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/list-indexes/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/list-indexes/snippets/list-indexes-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/login/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/login/snippets/login-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/logout/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/logout/snippets/logout-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/memory-storage/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/now/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/now/snippets/now-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/query/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/query/snippets/query-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/refresh-index/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/refresh-index/snippets/refresh-index-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/remove-all-listeners/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/remove-listener/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/remove-listener/snippets/remove-listener-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/replay-queue/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/replay-queue/snippets/replay-queue-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/security/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-auto-refresh/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-default-index/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-default-index/snippets/set-default-index-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-headers/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-headers/snippets/set-headers-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-jwt-token/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/set-jwt-token/snippets/set-jwt-token-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/start-queuing/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/start-queuing/snippets/start-queuing-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/stop-queuing/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/stop-queuing/snippets/stop-queuing-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/unset-jwt-token/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/update-my-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/update-my-credentials/snippets/update-my-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/update-self/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/update-self/snippets/update-self-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/validate-my-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/who-am-i/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/kuzzle/who-am-i/snippets/who-am-i-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/append/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/append/snippets/append-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitcount/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitcount/snippets/bitcount-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitop/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitop/snippets/bitop-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitpos/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/bitpos/snippets/bitpos-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/dbsize/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/dbsize/snippets/dbsize-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/decr/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/decr/snippets/decr-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/decrby/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/decrby/snippets/decrby-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/del/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/del/snippets/del-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/exists/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/exists/snippets/exists-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/expire/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/expire/snippets/expire-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/expireat/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/expireat/snippets/expireat-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/flushdb/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/flushdb/snippets/flushdb-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geoadd/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geoadd/snippets/geoadd-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geodist/index.md (95%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geodist/snippets/geodist-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geohash/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geohash/snippets/geohash-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geopos/index.md (94%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/geopos/snippets/geopos-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/georadius/index.md (94%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/georadius/snippets/georadius-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/georadiusbymember/index.md (93%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/georadiusbymember/snippets/georadiusbymember-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/get/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/get/snippets/get-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getbit/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getbit/snippets/getbit-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getrange/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getrange/snippets/getrange-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getset/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/getset/snippets/getset-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hdel/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hdel/snippets/hdel-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hexists/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hexists/snippets/hexists-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hget/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hget/snippets/hget-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hgetall/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hgetall/snippets/hgetall-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hincrby/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hincrby/snippets/hincrby-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hincrbyfloat/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hkeys/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hkeys/snippets/hkeys-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hlen/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hlen/snippets/hlen-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hmget/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hmget/snippets/hmget-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hmset/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hmset/snippets/hmset-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hscan/index.md (93%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hscan/snippets/hscan-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hset/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hset/snippets/hset-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hsetnx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hsetnx/snippets/hsetnx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hstrlen/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hstrlen/snippets/hstrlen-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hvals/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/hvals/snippets/hvals-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incr/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incr/snippets/incr-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incrby/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incrby/snippets/incrby-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incrbyfloat/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/incrbyfloat/snippets/incrbyfloat-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/keys/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/keys/snippets/keys-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lindex/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lindex/snippets/lindex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/linsert/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/linsert/snippets/linsert-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/llen/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/llen/snippets/llen-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpop/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpop/snippets/lpop-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpush/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpush/snippets/lpush-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpushx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lpushx/snippets/lpushx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lrange/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lrange/snippets/lrange-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lrem/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lrem/snippets/lrem-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lset/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/lset/snippets/lset-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ltrim/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ltrim/snippets/ltrim-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/mget/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/mget/snippets/mget-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/mset/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/mset/snippets/mset-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/msetnx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/msetnx/snippets/msetnx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/object/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/object/snippets/object-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/persist/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/persist/snippets/persist-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pexpire/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pexpire/snippets/pexpire-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pexpireat/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pexpireat/snippets/pexpireat-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfadd/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfadd/snippets/pfadd-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfcount/index.md (95%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfcount/snippets/pfcount-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfmerge/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pfmerge/snippets/pfmerge-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ping/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ping/snippets/ping-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/psetex/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/psetex/snippets/psetex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pttl/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/pttl/snippets/pttl-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/randomkey/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/randomkey/snippets/randomkey-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rename/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rename/snippets/rename-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/renamenx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/renamenx/snippets/renamenx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpop/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpop/snippets/rpop-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpoplpush/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpoplpush/snippets/rpoplpush-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpush/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpush/snippets/rpush-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpushx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/rpushx/snippets/rpushx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sadd/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sadd/snippets/sadd-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/scan/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/scan/snippets/scan-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/scard/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/scard/snippets/scard-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sdiff/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sdiff/snippets/sdiff-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sdiffstore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sdiffstore/snippets/sdiffstore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/set/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/set/snippets/set-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/setex/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/setex/snippets/setex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/setnx/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/setnx/snippets/setnx-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sinter/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sinter/snippets/sinter-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sinterstore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sinterstore/snippets/sinterstore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sismember/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sismember/snippets/sismember-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/smembers/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/smembers/snippets/smembers-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/smove/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/smove/snippets/smove-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sort/index.md (97%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sort/snippets/sort-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/spop/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/spop/snippets/spop-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/srandmember/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/srandmember/snippets/srandmember-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/srem/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/srem/snippets/srem-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sscan/index.md (93%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sscan/snippets/sscan-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/strlen/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/strlen/snippets/strlen-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sunion/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sunion/snippets/sunion-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sunionstore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/sunionstore/snippets/sunionstore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/time/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/time/snippets/time-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/touch/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/touch/snippets/touch-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ttl/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/ttl/snippets/ttl-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/type/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/type/snippets/type-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zadd/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zadd/snippets/zadd-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zcard/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zcard/snippets/zcard-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zcount/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zcount/snippets/zcount-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zincrby/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zincrby/snippets/zincrby-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zinterstore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zinterstore/snippets/zinterstore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zlexcount/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zlexcount/snippets/zlexcount-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrange/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrange/snippets/zrange-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrangebylex/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrangebylex/snippets/zrangebylex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrangebyscore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrangebyscore/snippets/zrangebyscore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrank/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrank/snippets/zrank-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrem/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrem/snippets/zrem-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebylex/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebylex/snippets/zremrangebylex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebyrank/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebyscore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrange/index.md (91%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrange/snippets/zrevrange-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrangebylex/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrangebyscore/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrank/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zrevrank/snippets/zrevrank-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zscan/index.md (93%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zscan/snippets/zscan-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zscore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zscore/snippets/zscore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zunionstore/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/memory-storage/zunionstore/snippets/zunionstore-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/add-policy/index.md (92%) rename src/sdk/php/3/{classes => core-classes}/profile/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/delete/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/delete/snippets/delete-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/get-policies/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/get-policies/snippets/get-policies-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/save/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/save/snippets/save-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/set-content/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/set-content/snippets/set-content-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/profile/set-policies/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/update/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/profile/update/snippets/update-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/role/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/role/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/role/delete/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/role/delete/snippets/delete-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/role/save/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/role/save/snippets/save-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/role/set-content/index.md (88%) rename src/sdk/php/3/{classes => core-classes}/role/set-content/snippets/set-content-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/role/update/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/role/update/snippets/update-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/search-result/constructor/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/search-result/fetch-next/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/search-result/fetch-next/snippets/fetch-next-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/search-result/fetch-next/snippets/fetch-next-2.php (100%) rename src/sdk/php/3/{classes => core-classes}/search-result/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-credentials/snippets/create-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-profile/snippets/create-profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-restricted-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-restricted-user/snippets/create-restricted-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-role/snippets/create-role-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/create-user/snippets/create-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-credentials/snippets/delete-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-profile/snippets/delete-profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-role/snippets/delete-role-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/delete-user/snippets/delete-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-profile/snippets/fetch-profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-role/snippets/fetch-role-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/fetch-user/snippets/fetch-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-all-credential-fields/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-all-credential-fields/snippets/get-all-credential-fields-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-credentials-fields/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-credentials-fields/snippets/get-credentials-fields-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-credentials/snippets/get-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-user-rights/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/get-user-rights/snippets/get-user-rights-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/has-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/has-credentials/snippets/has-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/is-action-allowed/index.md (88%) rename src/sdk/php/3/{classes => core-classes}/security/is-action-allowed/snippets/is-action-allowed-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/profile/snippets/profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/replace-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/replace-user/snippets/replace-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/role/snippets/role-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/scroll-profiles/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/scroll-profiles/snippets/scroll-profiles-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/scroll-users/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/scroll-users/snippets/scroll-users-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-profiles/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-profiles/snippets/search-profiles-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-roles/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-roles/snippets/search-roles-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-users/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/search-users/snippets/search-users-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-credentials/snippets/update-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-profile/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-profile/snippets/update-profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-role/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-role/snippets/update-role-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/update-user/snippets/update-user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/user/snippets/user-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/security/validate-credentials/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/security/validate-credentials/snippets/validate-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/add-profile/index.md (83%) rename src/sdk/php/3/{classes => core-classes}/user/add-profile/snippets/add-profile-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/constructor/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/constructor/snippets/constructor-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/create/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/user/create/snippets/create-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/delete/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/delete/snippets/delete-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/get-profileids/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/get-profileids/snippets/get-profileids-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/get-profiles/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/get-profiles/snippets/get-profiles-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/replace/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/replace/snippets/replace-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/save-restricted/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/save-restricted/snippets/save-restricted-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/save/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/save/snippets/save-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/set-content/index.md (76%) rename src/sdk/php/3/{classes => core-classes}/user/set-content/snippets/set-content-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/set-credentials/index.md (90%) rename src/sdk/php/3/{classes => core-classes}/user/set-credentials/snippets/set-credentials-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/set-profiles/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/set-profiles/snippets/set-profiles-1.php (100%) rename src/sdk/php/3/{classes => core-classes}/user/update/index.md (100%) rename src/sdk/php/3/{classes => core-classes}/user/update/snippets/update-1.php (100%) rename src/sdk/php/3/essentials/{handling-errors => error-handling}/index.md (100%) rename src/sdk/php/3/essentials/{handling-errors => error-handling}/snippets/handling-errors-1.php (100%) diff --git a/check_redirections.rb b/check_redirections.rb new file mode 100644 index 000000000..3d0e2a13f --- /dev/null +++ b/check_redirections.rb @@ -0,0 +1,42 @@ +require 'yaml' +require 'json' + +def each_dir(start, &block) + directories = Dir["#{start}/*"] + + directories.each do |path| + if File.file?(path) + block.call(path) + else + each_dir(path, &block) + end + end +end + +redirections = YAML.load_file('./redirections.yml') + +v2_redir = [] +v2_pages = [] + +redirections['redirections'].each do |redirection| + each_dir("../documentation-v2/src/#{redirection['from']}") do |file| + v2_redir << file.gsub('../documentation-v2/', '') + end +end + +each_dir("../documentation-v2/src/") do |file| + next unless file.end_with?('.md') + v2_pages << file.gsub('../documentation-v2/', '').gsub(/\/\//, '/') +end + +v2_redir.uniq! +v2_pages.uniq! +missing_redirections = v2_pages - v2_redir + +puts "#{v2_redir.count} redirection from v2 to v3" +puts "#{v2_pages.count} pages for v2" +puts "#{missing_redirections.count} missing redirections" + +if missing_redirections.any? + File.write('./missing-redirections.json', JSON.pretty_generate(missing_redirections)) +end \ No newline at end of file diff --git a/redirections.yml b/redirections.yml index 1d6820dae..46aa43452 100644 --- a/redirections.yml +++ b/redirections.yml @@ -1,82 +1,35 @@ --- redirections: - # legacy - - from: api-documentation - to: core/1/api - - from: sdk-reference/essentials - to: sdk - - from: elasticsearch-cookbook/bool-query - to: core/1/guide/cookbooks/elasticsearch/bool-query - - from: guide/getting-started - to: core/1/guide/guides/getting-started - - from: guide/essentials/installing-kuzzle - to: core/1/guide/guides/essentials/installing-kuzzle - - from: guide/essentials/installing-console - to: core/1/guide/guides/essentials/installing-console - - from: guide/code-examples/geofencing/javascript - to: core/1/guide/code-examples/geofencing/javascript - - from: guide/essentials - to: core/1/guide/guides/essentials - - from: sdk-reference/collection - to: sdk - - from: elasticsearch-cookbook/useful-commands - to: core/1/guide/cookbooks/elasticsearch/useful-commands - - from: guide/code-examples/dbsearch/javascript - to: core/1/guide/code-examples/dbsearch/javascript - - from: guide/essentials/plugins - to: core/1/plugins/plugins/essentials/available-plugins - - from: guide/kuzzle-depth - to: core/1/guide/guides/kuzzle-depth - - from: plugins-reference/plugins-features - to: core/1/plugins/plugins/essentials/getting-started - - from: sdk-reference/essentials/events - to: sdk/js/6/essentials/events - - from: sdk-reference/essentials/notifications - to: sdk/js/6/essentials/realtime-notifications - - from: elasticsearch-cookbook/basic-queries - to: core/1/guide/cookbooks/elasticsearch/basic-queries - - from: guide/essentials/real-time - to: core/1/guide/guides/essentials/real-time - - from: sdk-reference/collection/search - to: sdk - - from: sdk-reference/kuzzle - to: sdk - - from: api-documentation/query-syntax - to: core/1/api/essentials/query-syntax - - from: kuzzle-events/plugin-events - to: core/1/plugins/plugins/events - - from: sdk-reference/kuzzle/login - to: sdk/js/6/controllers/auth/login - - from: sdk-reference/memory-storage/pfadd - to: sdk/js/6/controllers/ms/pfadd + # API + - from: api/1/controller-admin + to: core/1/api/controllers/admin - # protocols methods - - from: protocols/1/essentials/broadcast - to: core/1/protocols/methods/broadcast - - from: protocols/1/essentials/disconnect - to: core/1/protocols/methods/disconnect - - from: protocols/1/essentials/init - to: core/1/protocols/methods/init - - from: protocols/1/essentials/joinchannel - to: core/1/protocols/methods/joinchannel - - from: protocols/1/essentials/leavechannel - to: core/1/protocols/methods/leavechannel - - from: protocols/1/essentials/notify - to: core/1/protocols/methods/notify - - # plugins: essentials -> dedicated section - - from: plugins/1/essentials/strategies - to: core/1/plugins/plugins/strategies/overview - - from: plugins/1/essentials/pipes - to: core/1/plugins/plugins/pipes - - from: plugins/1/plugin-layout/init-function - to: core/1/plugins/plugins/manual-setup/init-function - - from: plugins/1/essentials/controllers - to: core/1/plugins/plugins/controllers + - from: api/1/controller-auth + to: core/1/api/controllers/auth - # API - - from: api/1/controller-(.+) - to: core/1/api/controllers/$1 + - from: api/1/controller-bulk + to: core/1/api/controllers/bulk + + - from: api/1/controller-collection + to: core/1/api/controllers/collection + + - from: api/1/controller-document + to: core/1/api/controllers/document + + - from: api/1/controller-index + to: core/1/api/controllers/index + + - from: api/1/controller-memory-storage + to: core/1/api/controllers/memory-storage + + - from: api/1/controller-realtime + to: core/1/api/controllers/realtime + + - from: api/1/controller-security + to: core/1/api/controllers/security + + - from: api/1/controller-server + to: core/1/api/controllers/server - from: api/1/essentials to: core/1/api/essentials @@ -323,15 +276,9 @@ redirections: to: sdk/java/1/core-classes/search-result # Java 1 protocols - - from: sdk-reference/java/1/http - to: sdk/java/1/protocols/http - - - from: sdk-reference/java/1/websocket + - from: sdk-reference/java/1/protocol/websocket to: sdk/java/1/protocols/websocket - - from: sdk-reference/java/1/socketio - to: sdk/java/1/protocols/socketio - # Java 1 controllers - from: sdk-reference/java/1/auth to: sdk/java/1/controllers/auth @@ -378,15 +325,9 @@ redirections: to: sdk/go/1/core-structs/kuzzle-event-emitter # Go 1 protocols - - from: sdk-reference/go/1/http - to: sdk/go/1/protocols/http - - - from: sdk-reference/go/1/websocket + - from: sdk-reference/go/1/protocols/websocket to: sdk/go/1/protocols/websocket - - from: sdk-reference/go/1/socketio - to: sdk/go/1/protocols/socketio - # Go 1 controllers - from: sdk-reference/go/1/auth to: sdk/go/1/controllers/auth @@ -508,3 +449,91 @@ redirections: - from: sdk-reference/android/3/user to: sdk/android/3/core-classes/user + + # PHP 3 essentials + - from: sdk-reference/php/3/handling-errors + to: sdk/php/3/essentials/error-handling + + - from: sdk-reference/php/3/events + to: sdk/php/3/essentials/events + + # PHP 3 core classes + - from: sdk-reference/php/3/collection + to: sdk/php/3/core-classes/collection + + - from: sdk-reference/php/3/collection-mapping + to: sdk/php/3/core-classes/collection-mapping + + - from: sdk-reference/php/3/document + to: sdk/php/3/core-classes/document + + - from: sdk-reference/php/3/kuzzle + to: sdk/php/3/core-classes/kuzzle + + - from: sdk-reference/php/3/memory-storage + to: sdk/php/3/core-classes/memory-storage + + - from: sdk-reference/php/3/profile + to: sdk/php/3/core-classes/profile + + - from: sdk-reference/php/3/role + to: sdk/php/3/core-classes/role + + - from: sdk-reference/php/3/search-result + to: sdk/php/3/core-classes/search-result + + - from: sdk-reference/php/3/security + to: sdk/php/3/core-classes/security + + - from: sdk-reference/php/3/user + to: sdk/php/3/core-classes/user + +redirectionslegacy: + - from: api-documentation + to: core/1/api + - from: sdk-reference/essentials + to: sdk + - from: elasticsearch-cookbook/bool-query + to: core/1/guide/cookbooks/elasticsearch/bool-query + - from: guide/getting-started + to: core/1/guide/guides/getting-started + - from: guide/essentials/installing-kuzzle + to: core/1/guide/guides/essentials/installing-kuzzle + - from: guide/essentials/installing-console + to: core/1/guide/guides/essentials/installing-console + - from: guide/code-examples/geofencing/javascript + to: core/1/guide/code-examples/geofencing/javascript + - from: guide/essentials + to: core/1/guide/guides/essentials + - from: sdk-reference/collection + to: sdk + - from: elasticsearch-cookbook/useful-commands + to: core/1/guide/cookbooks/elasticsearch/useful-commands + - from: guide/code-examples/dbsearch/javascript + to: core/1/guide/code-examples/dbsearch/javascript + - from: guide/essentials/plugins + to: core/1/plugins/plugins/essentials/available-plugins + - from: guide/kuzzle-depth + to: core/1/guide/guides/kuzzle-depth + - from: plugins-reference/plugins-features + to: core/1/plugins/plugins/essentials/getting-started + - from: sdk-reference/essentials/events + to: sdk/js/6/essentials/events + - from: sdk-reference/essentials/notifications + to: sdk/js/6/essentials/realtime-notifications + - from: elasticsearch-cookbook/basic-queries + to: core/1/guide/cookbooks/elasticsearch/basic-queries + - from: guide/essentials/real-time + to: core/1/guide/guides/essentials/real-time + - from: sdk-reference/collection/search + to: sdk + - from: sdk-reference/kuzzle + to: sdk + - from: api-documentation/query-syntax + to: core/1/api/essentials/query-syntax + - from: kuzzle-events/plugin-events + to: core/1/plugins/plugins/events + - from: sdk-reference/kuzzle/login + to: sdk/js/6/controllers/auth/login + - from: sdk-reference/memory-storage/pfadd + to: sdk/js/6/controllers/ms/pfadd diff --git a/src/create.js b/src/create.js deleted file mode 100644 index abd761b20..000000000 --- a/src/create.js +++ /dev/null @@ -1,39 +0,0 @@ -// Loads the Kuzzle SDK modules -const { - Kuzzle, - WebSocket -} = require('kuzzle-sdk'); - -// Instantiates a Kuzzle client with the WebSocket protocol -// Replace 'kuzzle' with your Kuzzle server hostname (e.g. 'localhost') -const kuzzle = new Kuzzle( - new WebSocket('kuzzle') -); - -// Adds a listener to detect connection problems -kuzzle.on('networkError', error => { - console.error('Network Error:', error); -}); - -const run = async () => { - try { - // Connects to the Kuzzle server - await kuzzle.connect(); - - // Creates a document - const driver = { - name: 'Sirkis', - birthday: '1959-06-22', - license: 'B' - }; - - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', driver); - console.log('New document successfully created!'); - } catch (error) { - console.error(error.message); - } finally { - kuzzle.disconnect(); - } -}; - -run(); diff --git a/src/sdk/php/3/classes/collection-mapping/apply/index.md b/src/sdk/php/3/core-classes/collection-mapping/apply/index.md similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/apply/index.md rename to src/sdk/php/3/core-classes/collection-mapping/apply/index.md diff --git a/src/sdk/php/3/classes/collection-mapping/apply/snippets/apply-1.php b/src/sdk/php/3/core-classes/collection-mapping/apply/snippets/apply-1.php similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/apply/snippets/apply-1.php rename to src/sdk/php/3/core-classes/collection-mapping/apply/snippets/apply-1.php diff --git a/src/sdk/php/3/classes/collection-mapping/constructor/index.md b/src/sdk/php/3/core-classes/collection-mapping/constructor/index.md similarity index 90% rename from src/sdk/php/3/classes/collection-mapping/constructor/index.md rename to src/sdk/php/3/core-classes/collection-mapping/constructor/index.md index 3579ab5c6..384766818 100644 --- a/src/sdk/php/3/classes/collection-mapping/constructor/index.md +++ b/src/sdk/php/3/core-classes/collection-mapping/constructor/index.md @@ -23,7 +23,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | Arguments | Type | Description | | ------------ | -------------------------------------------- | --------------------------------- | -| `Collection` | [Collection](/sdk/php/3/classes/collection/) | An instantiated Collection object | +| `Collection` | [Collection](/sdk/php/3/core-classes/collection/) | An instantiated Collection object | | `mapping` | JSON Object | Optional mapping | --- @@ -35,7 +35,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | `headers` | JSON Object | Common headers for all sent documents. | get/set | | `mapping` | object | Easy-to-understand list of mappings per field | get/set | -**Note:** the `headers` property is inherited from the provided [Collection](/sdk/php/3/classes/collection/) object and can be overrided +**Note:** the `headers` property is inherited from the provided [Collection](/sdk/php/3/core-classes/collection/) object and can be overrided ## Usage diff --git a/src/sdk/php/3/classes/collection-mapping/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/collection-mapping/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/collection-mapping/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/collection-mapping/index.md b/src/sdk/php/3/core-classes/collection-mapping/index.md similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/index.md rename to src/sdk/php/3/core-classes/collection-mapping/index.md diff --git a/src/sdk/php/3/classes/collection-mapping/refresh/index.md b/src/sdk/php/3/core-classes/collection-mapping/refresh/index.md similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/refresh/index.md rename to src/sdk/php/3/core-classes/collection-mapping/refresh/index.md diff --git a/src/sdk/php/3/classes/collection-mapping/refresh/snippets/refresh-1.php b/src/sdk/php/3/core-classes/collection-mapping/refresh/snippets/refresh-1.php similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/refresh/snippets/refresh-1.php rename to src/sdk/php/3/core-classes/collection-mapping/refresh/snippets/refresh-1.php diff --git a/src/sdk/php/3/classes/collection-mapping/set-headers/index.md b/src/sdk/php/3/core-classes/collection-mapping/set-headers/index.md similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/set-headers/index.md rename to src/sdk/php/3/core-classes/collection-mapping/set-headers/index.md diff --git a/src/sdk/php/3/classes/collection-mapping/set-headers/snippets/set-headers-1.php b/src/sdk/php/3/core-classes/collection-mapping/set-headers/snippets/set-headers-1.php similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/set-headers/snippets/set-headers-1.php rename to src/sdk/php/3/core-classes/collection-mapping/set-headers/snippets/set-headers-1.php diff --git a/src/sdk/php/3/classes/collection-mapping/set/index.md b/src/sdk/php/3/core-classes/collection-mapping/set/index.md similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/set/index.md rename to src/sdk/php/3/core-classes/collection-mapping/set/index.md diff --git a/src/sdk/php/3/classes/collection-mapping/set/snippets/set-1.php b/src/sdk/php/3/core-classes/collection-mapping/set/snippets/set-1.php similarity index 100% rename from src/sdk/php/3/classes/collection-mapping/set/snippets/set-1.php rename to src/sdk/php/3/core-classes/collection-mapping/set/snippets/set-1.php diff --git a/src/sdk/php/3/classes/collection/collection-mapping/index.md b/src/sdk/php/3/core-classes/collection/collection-mapping/index.md similarity index 64% rename from src/sdk/php/3/classes/collection/collection-mapping/index.md rename to src/sdk/php/3/core-classes/collection/collection-mapping/index.md index cd5fe1a33..e154c5718 100644 --- a/src/sdk/php/3/classes/collection/collection-mapping/index.md +++ b/src/sdk/php/3/core-classes/collection/collection-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:collectionMapping # collectionMapping -Creates a new [CollectionMapping](/sdk/php/3/classes/collection-mapping/) object, using its constructor. +Creates a new [CollectionMapping](/sdk/php/3/core-classes/collection-mapping/) object, using its constructor. --- @@ -21,7 +21,7 @@ Creates a new [CollectionMapping](/sdk/php/3/classes/collection-mapping/) object ## Return Value -Returns the newly created [CollectionMapping](/sdk/php/3/classes/collection-mapping/) object. +Returns the newly created [CollectionMapping](/sdk/php/3/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/php/3/classes/collection/collection-mapping/snippets/collection-mapping-1.php b/src/sdk/php/3/core-classes/collection/collection-mapping/snippets/collection-mapping-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/collection-mapping/snippets/collection-mapping-1.php rename to src/sdk/php/3/core-classes/collection/collection-mapping/snippets/collection-mapping-1.php diff --git a/src/sdk/php/3/classes/collection/constructor/index.md b/src/sdk/php/3/core-classes/collection/constructor/index.md similarity index 93% rename from src/sdk/php/3/classes/collection/constructor/index.md rename to src/sdk/php/3/core-classes/collection/constructor/index.md index cc9ee1f39..7281279cf 100644 --- a/src/sdk/php/3/classes/collection/constructor/index.md +++ b/src/sdk/php/3/core-classes/collection/constructor/index.md @@ -22,7 +22,7 @@ A collection is a set of data managed by Kuzzle. It acts like a data table for p | `collection` | string | The name of the collection you want to manipulate | | `index` | string | Name of the index containing the collection | -**Note:** We recommend you instantiate a Collection object by calling [Kuzzle.collection](/sdk/php/3/classes/kuzzle/collection/) rather than using the constructor directly +**Note:** We recommend you instantiate a Collection object by calling [Kuzzle.collection](/sdk/php/3/core-classes/kuzzle/collection/) rather than using the constructor directly --- diff --git a/src/sdk/php/3/classes/collection/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/collection/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/collection/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/collection/count/index.md b/src/sdk/php/3/core-classes/collection/count/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/count/index.md rename to src/sdk/php/3/core-classes/collection/count/index.md diff --git a/src/sdk/php/3/classes/collection/count/snippets/count-1.php b/src/sdk/php/3/core-classes/collection/count/snippets/count-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/count/snippets/count-1.php rename to src/sdk/php/3/core-classes/collection/count/snippets/count-1.php diff --git a/src/sdk/php/3/classes/collection/create-document/index.md b/src/sdk/php/3/core-classes/collection/create-document/index.md similarity index 90% rename from src/sdk/php/3/classes/collection/create-document/index.md rename to src/sdk/php/3/core-classes/collection/create-document/index.md index 4c2c89e09..95f34fd7a 100644 --- a/src/sdk/php/3/classes/collection/create-document/index.md +++ b/src/sdk/php/3/core-classes/collection/create-document/index.md @@ -7,7 +7,7 @@ description: Collection:createDocument # createDocument -Create a new document in Kuzzle and instantiate a [Document](/sdk/php/3/classes/document/) object. +Create a new document in Kuzzle and instantiate a [Document](/sdk/php/3/core-classes/document/) object. --- @@ -15,7 +15,7 @@ Create a new document in Kuzzle and instantiate a [Document](/sdk/php/3/classes/ | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------- | -| `Document` | object | [Document](/sdk/php/3/classes/document/) object | +| `Document` | object | [Document](/sdk/php/3/core-classes/document/) object | | `options` | JSON object | Optional parameters | | `callback` | function | Optional callback | @@ -51,7 +51,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns a [Document](/sdk/php/3/classes/document/) object containing the newly created document. +Returns a [Document](/sdk/php/3/core-classes/document/) object containing the newly created document. ## Usage diff --git a/src/sdk/php/3/classes/collection/create-document/snippets/create-document-1.php b/src/sdk/php/3/core-classes/collection/create-document/snippets/create-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/create-document/snippets/create-document-1.php rename to src/sdk/php/3/core-classes/collection/create-document/snippets/create-document-1.php diff --git a/src/sdk/php/3/classes/collection/create/index.md b/src/sdk/php/3/core-classes/collection/create/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/create/index.md rename to src/sdk/php/3/core-classes/collection/create/index.md diff --git a/src/sdk/php/3/classes/collection/create/snippets/create-1.php b/src/sdk/php/3/core-classes/collection/create/snippets/create-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/create/snippets/create-1.php rename to src/sdk/php/3/core-classes/collection/create/snippets/create-1.php diff --git a/src/sdk/php/3/classes/collection/delete-document/index.md b/src/sdk/php/3/core-classes/collection/delete-document/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/delete-document/index.md rename to src/sdk/php/3/core-classes/collection/delete-document/index.md diff --git a/src/sdk/php/3/classes/collection/delete-document/snippets/delete-document-1.php b/src/sdk/php/3/core-classes/collection/delete-document/snippets/delete-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/delete-document/snippets/delete-document-1.php rename to src/sdk/php/3/core-classes/collection/delete-document/snippets/delete-document-1.php diff --git a/src/sdk/php/3/classes/collection/delete-specifications/index.md b/src/sdk/php/3/core-classes/collection/delete-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/delete-specifications/index.md rename to src/sdk/php/3/core-classes/collection/delete-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/delete-specifications/snippets/delete-specifications-1.php b/src/sdk/php/3/core-classes/collection/delete-specifications/snippets/delete-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/delete-specifications/snippets/delete-specifications-1.php rename to src/sdk/php/3/core-classes/collection/delete-specifications/snippets/delete-specifications-1.php diff --git a/src/sdk/php/3/classes/collection/document/index.md b/src/sdk/php/3/core-classes/collection/document/index.md similarity index 84% rename from src/sdk/php/3/classes/collection/document/index.md rename to src/sdk/php/3/core-classes/collection/document/index.md index 9f38a5829..56f0a3cd9 100644 --- a/src/sdk/php/3/classes/collection/document/index.md +++ b/src/sdk/php/3/core-classes/collection/document/index.md @@ -7,7 +7,7 @@ description: Collection:document # document -Creates a new [Document](/sdk/php/3/classes/document/) object, using its constructor. +Creates a new [Document](/sdk/php/3/core-classes/document/) object, using its constructor. --- diff --git a/src/sdk/php/3/classes/collection/document/snippets/document-1.php b/src/sdk/php/3/core-classes/collection/document/snippets/document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/document/snippets/document-1.php rename to src/sdk/php/3/core-classes/collection/document/snippets/document-1.php diff --git a/src/sdk/php/3/classes/collection/fetch-document/index.md b/src/sdk/php/3/core-classes/collection/fetch-document/index.md similarity index 86% rename from src/sdk/php/3/classes/collection/fetch-document/index.md rename to src/sdk/php/3/core-classes/collection/fetch-document/index.md index 1032c324c..5367c0f35 100644 --- a/src/sdk/php/3/classes/collection/fetch-document/index.md +++ b/src/sdk/php/3/core-classes/collection/fetch-document/index.md @@ -7,7 +7,7 @@ description: Collection:fetchDocument # fetchDocument -Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/php/3/classes/document/) object. +Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/php/3/core-classes/document/) object. --- @@ -31,7 +31,7 @@ Retrieves a single stored document using its unique document ID, and returns it ## Callback Response -Returns a [Document](/sdk/php/3/classes/document/) object. +Returns a [Document](/sdk/php/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/php/3/classes/collection/fetch-document/snippets/fetch-document-1.php b/src/sdk/php/3/core-classes/collection/fetch-document/snippets/fetch-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/fetch-document/snippets/fetch-document-1.php rename to src/sdk/php/3/core-classes/collection/fetch-document/snippets/fetch-document-1.php diff --git a/src/sdk/php/3/classes/collection/get-mapping/index.md b/src/sdk/php/3/core-classes/collection/get-mapping/index.md similarity index 83% rename from src/sdk/php/3/classes/collection/get-mapping/index.md rename to src/sdk/php/3/core-classes/collection/get-mapping/index.md index 21b8352c1..79a58fb59 100644 --- a/src/sdk/php/3/classes/collection/get-mapping/index.md +++ b/src/sdk/php/3/core-classes/collection/get-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:getMapping # getMapping -Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/php/3/classes/collection-mapping/) object. +Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/php/3/core-classes/collection-mapping/) object. --- @@ -30,7 +30,7 @@ Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/p ## Callback Response -Returns a [CollectionMapping](/sdk/php/3/classes/collection-mapping/) object. +Returns a [CollectionMapping](/sdk/php/3/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/php/3/classes/collection/get-mapping/snippets/get-mapping-1.php b/src/sdk/php/3/core-classes/collection/get-mapping/snippets/get-mapping-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/get-mapping/snippets/get-mapping-1.php rename to src/sdk/php/3/core-classes/collection/get-mapping/snippets/get-mapping-1.php diff --git a/src/sdk/php/3/classes/collection/get-specifications/index.md b/src/sdk/php/3/core-classes/collection/get-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/get-specifications/index.md rename to src/sdk/php/3/core-classes/collection/get-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/get-specifications/snippets/get-specifications-1.php b/src/sdk/php/3/core-classes/collection/get-specifications/snippets/get-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/get-specifications/snippets/get-specifications-1.php rename to src/sdk/php/3/core-classes/collection/get-specifications/snippets/get-specifications-1.php diff --git a/src/sdk/php/3/classes/collection/index.md b/src/sdk/php/3/core-classes/collection/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/index.md rename to src/sdk/php/3/core-classes/collection/index.md diff --git a/src/sdk/php/3/classes/collection/mcreate-document/index.md b/src/sdk/php/3/core-classes/collection/mcreate-document/index.md similarity index 87% rename from src/sdk/php/3/classes/collection/mcreate-document/index.md rename to src/sdk/php/3/core-classes/collection/mcreate-document/index.md index 342146dbc..1040e4193 100644 --- a/src/sdk/php/3/classes/collection/mcreate-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mcreate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateDocument # mCreateDocument -Create the input [Documents](/sdk/php/3/classes/document/). +Create the input [Documents](/sdk/php/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Create the input [Documents](/sdk/php/3/classes/document/). | Arguments | Type | Description | | ----------- | ----------- | ----------------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/php/3/classes/document/) to create | +| `documents` | Document[] | Array of [Document](/sdk/php/3/core-classes/document/) to create | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/php/3/classes/collection/mcreate-document/snippets/mcreate-document-1.php b/src/sdk/php/3/core-classes/collection/mcreate-document/snippets/mcreate-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mcreate-document/snippets/mcreate-document-1.php rename to src/sdk/php/3/core-classes/collection/mcreate-document/snippets/mcreate-document-1.php diff --git a/src/sdk/php/3/classes/collection/mcreate-or-replace-document/index.md b/src/sdk/php/3/core-classes/collection/mcreate-or-replace-document/index.md similarity index 87% rename from src/sdk/php/3/classes/collection/mcreate-or-replace-document/index.md rename to src/sdk/php/3/core-classes/collection/mcreate-or-replace-document/index.md index d601724f5..eb868e786 100644 --- a/src/sdk/php/3/classes/collection/mcreate-or-replace-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mcreate-or-replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateOrReplaceDocument # mCreateOrReplaceDocument -Create or replace the input [Documents](/sdk/php/3/classes/document/). +Create or replace the input [Documents](/sdk/php/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Create or replace the input [Documents](/sdk/php/3/classes/document/). | Arguments | Type | Description | | ----------- | ----------- | ---------------------------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/php/3/classes/document/) to create or replace | +| `documents` | Document[] | Array of [Document](/sdk/php/3/core-classes/document/) to create or replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/php/3/classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.php b/src/sdk/php/3/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.php rename to src/sdk/php/3/core-classes/collection/mcreate-or-replace-document/snippets/mcreate-or-replace-document-1.php diff --git a/src/sdk/php/3/classes/collection/mdelete-document/index.md b/src/sdk/php/3/core-classes/collection/mdelete-document/index.md similarity index 91% rename from src/sdk/php/3/classes/collection/mdelete-document/index.md rename to src/sdk/php/3/core-classes/collection/mdelete-document/index.md index d265323e2..4970ab715 100644 --- a/src/sdk/php/3/classes/collection/mdelete-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mdelete-document/index.md @@ -7,7 +7,7 @@ description: Collection:mdeleteDocument # mDeleteDocument -Delete multiple [Documents](/sdk/php/3/classes/document/) according to the input IDs. +Delete multiple [Documents](/sdk/php/3/core-classes/document/) according to the input IDs. --- diff --git a/src/sdk/php/3/classes/collection/mdelete-document/snippets/mdelete-document-1.php b/src/sdk/php/3/core-classes/collection/mdelete-document/snippets/mdelete-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mdelete-document/snippets/mdelete-document-1.php rename to src/sdk/php/3/core-classes/collection/mdelete-document/snippets/mdelete-document-1.php diff --git a/src/sdk/php/3/classes/collection/mget-document/index.md b/src/sdk/php/3/core-classes/collection/mget-document/index.md similarity index 91% rename from src/sdk/php/3/classes/collection/mget-document/index.md rename to src/sdk/php/3/core-classes/collection/mget-document/index.md index 3b66c221c..3ba9d6b03 100644 --- a/src/sdk/php/3/classes/collection/mget-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mget-document/index.md @@ -7,7 +7,7 @@ description: Collection:mgetDocument # mGetDocument -Get multiple [Documents](/sdk/php/3/classes/document/) according to the input document IDs. +Get multiple [Documents](/sdk/php/3/core-classes/document/) according to the input document IDs. --- diff --git a/src/sdk/php/3/classes/collection/mget-document/snippets/mget-document-1.php b/src/sdk/php/3/core-classes/collection/mget-document/snippets/mget-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mget-document/snippets/mget-document-1.php rename to src/sdk/php/3/core-classes/collection/mget-document/snippets/mget-document-1.php diff --git a/src/sdk/php/3/classes/collection/mreplace-document/index.md b/src/sdk/php/3/core-classes/collection/mreplace-document/index.md similarity index 87% rename from src/sdk/php/3/classes/collection/mreplace-document/index.md rename to src/sdk/php/3/core-classes/collection/mreplace-document/index.md index acb70c1d4..7f067bd09 100644 --- a/src/sdk/php/3/classes/collection/mreplace-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mreplace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mreplaceDocument # mReplaceDocument -Replace the provided [Documents](/sdk/php/3/classes/document/). +Replace the provided [Documents](/sdk/php/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Replace the provided [Documents](/sdk/php/3/classes/document/). | Arguments | Type | Description | | ----------- | ----------- | ------------------------------------------------------------ | -| `documents` | Document[] | Array of [Document](/sdk/php/3/classes/document/) to replace | +| `documents` | Document[] | Array of [Document](/sdk/php/3/core-classes/document/) to replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/php/3/classes/collection/mreplace-document/snippets/mreplace-document-1.php b/src/sdk/php/3/core-classes/collection/mreplace-document/snippets/mreplace-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mreplace-document/snippets/mreplace-document-1.php rename to src/sdk/php/3/core-classes/collection/mreplace-document/snippets/mreplace-document-1.php diff --git a/src/sdk/php/3/classes/collection/mupdate-document/index.md b/src/sdk/php/3/core-classes/collection/mupdate-document/index.md similarity index 87% rename from src/sdk/php/3/classes/collection/mupdate-document/index.md rename to src/sdk/php/3/core-classes/collection/mupdate-document/index.md index 7b81d5f7e..00505303e 100644 --- a/src/sdk/php/3/classes/collection/mupdate-document/index.md +++ b/src/sdk/php/3/core-classes/collection/mupdate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mupdateDocument # mUpdateDocument -Update the provided [Documents](/sdk/php/3/classes/document/). +Update the provided [Documents](/sdk/php/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Update the provided [Documents](/sdk/php/3/classes/document/). | Arguments | Type | Description | | ----------- | ----------- | ------------------------------------------------------------ | -| `documents` | Document[] | Array of [Documents](/sdk/php/3/classes/document/) to update | +| `documents` | Document[] | Array of [Documents](/sdk/php/3/core-classes/document/) to update | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/php/3/classes/collection/mupdate-document/snippets/mupdate-document-1.php b/src/sdk/php/3/core-classes/collection/mupdate-document/snippets/mupdate-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/mupdate-document/snippets/mupdate-document-1.php rename to src/sdk/php/3/core-classes/collection/mupdate-document/snippets/mupdate-document-1.php diff --git a/src/sdk/php/3/classes/collection/publish-message/index.md b/src/sdk/php/3/core-classes/collection/publish-message/index.md similarity index 94% rename from src/sdk/php/3/classes/collection/publish-message/index.md rename to src/sdk/php/3/core-classes/collection/publish-message/index.md index 871ab31d0..89f9ea398 100644 --- a/src/sdk/php/3/classes/collection/publish-message/index.md +++ b/src/sdk/php/3/core-classes/collection/publish-message/index.md @@ -15,7 +15,7 @@ Publish a real-time message. | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------- | -| `Document` | object | [Document](/sdk/php/3/classes/document/) object | +| `Document` | object | [Document](/sdk/php/3/core-classes/document/) object | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/php/3/classes/collection/publish-message/snippets/publish-message-1.php b/src/sdk/php/3/core-classes/collection/publish-message/snippets/publish-message-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/publish-message/snippets/publish-message-1.php rename to src/sdk/php/3/core-classes/collection/publish-message/snippets/publish-message-1.php diff --git a/src/sdk/php/3/classes/collection/replace-document/index.md b/src/sdk/php/3/core-classes/collection/replace-document/index.md similarity index 92% rename from src/sdk/php/3/classes/collection/replace-document/index.md rename to src/sdk/php/3/core-classes/collection/replace-document/index.md index 8fcb72a26..a8c29eb96 100644 --- a/src/sdk/php/3/classes/collection/replace-document/index.md +++ b/src/sdk/php/3/core-classes/collection/replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:replaceDocument # replaceDocument -Replace an existing document and return the updated version as a [Document](/sdk/php/3/classes/document/) object. +Replace an existing document and return the updated version as a [Document](/sdk/php/3/core-classes/document/) object. --- @@ -40,7 +40,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an updated [Document](/sdk/php/3/classes/document/) object. +Returns an updated [Document](/sdk/php/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/php/3/classes/collection/replace-document/snippets/replace-document-1.php b/src/sdk/php/3/core-classes/collection/replace-document/snippets/replace-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/replace-document/snippets/replace-document-1.php rename to src/sdk/php/3/core-classes/collection/replace-document/snippets/replace-document-1.php diff --git a/src/sdk/php/3/classes/collection/scroll-specifications/index.md b/src/sdk/php/3/core-classes/collection/scroll-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/scroll-specifications/index.md rename to src/sdk/php/3/core-classes/collection/scroll-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/scroll-specifications/snippets/scroll-specifications-1.php b/src/sdk/php/3/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/scroll-specifications/snippets/scroll-specifications-1.php rename to src/sdk/php/3/core-classes/collection/scroll-specifications/snippets/scroll-specifications-1.php diff --git a/src/sdk/php/3/classes/collection/scroll/index.md b/src/sdk/php/3/core-classes/collection/scroll/index.md similarity index 92% rename from src/sdk/php/3/classes/collection/scroll/index.md rename to src/sdk/php/3/core-classes/collection/scroll/index.md index db5c1d0ca..48d74395d 100644 --- a/src/sdk/php/3/classes/collection/scroll/index.md +++ b/src/sdk/php/3/core-classes/collection/scroll/index.md @@ -7,7 +7,7 @@ description: Collection:scroll # scroll -Returns a [SearchResult](/sdk/php/3/classes/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. +Returns a [SearchResult](/sdk/php/3/core-classes/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. A scroll session is always initiated by a `search` action and including the `scroll` argument; more information below.
diff --git a/src/sdk/php/3/classes/collection/scroll/snippets/scroll-1.php b/src/sdk/php/3/core-classes/collection/scroll/snippets/scroll-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/scroll/snippets/scroll-1.php rename to src/sdk/php/3/core-classes/collection/scroll/snippets/scroll-1.php diff --git a/src/sdk/php/3/classes/collection/search-specifications/index.md b/src/sdk/php/3/core-classes/collection/search-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/search-specifications/index.md rename to src/sdk/php/3/core-classes/collection/search-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/search-specifications/snippets/search-specifications-1.php b/src/sdk/php/3/core-classes/collection/search-specifications/snippets/search-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/search-specifications/snippets/search-specifications-1.php rename to src/sdk/php/3/core-classes/collection/search-specifications/snippets/search-specifications-1.php diff --git a/src/sdk/php/3/classes/collection/search/index.md b/src/sdk/php/3/core-classes/collection/search/index.md similarity index 91% rename from src/sdk/php/3/classes/collection/search/index.md rename to src/sdk/php/3/core-classes/collection/search/index.md index 3b05e7188..1ba678b89 100644 --- a/src/sdk/php/3/classes/collection/search/index.md +++ b/src/sdk/php/3/core-classes/collection/search/index.md @@ -19,9 +19,9 @@ When processing a large number of documents (i.e. more than 1000), using `search Pagination of results can be done by using the from and size but the cost becomes prohibitive when deep pagination is reached. In fact, Elasticsearch, Kuzzle's embedded database, limits results to 10,000 records by default. -Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/php/3/classes/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/php/3/classes/search-result/fetch-next/). +Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/php/3/core-classes/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/php/3/core-classes/search-result/fetch-next/). -See [`SearchResult.fetchNext`](/sdk/php/3/classes/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. +See [`SearchResult.fetchNext`](/sdk/php/3/core-classes/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. --- diff --git a/src/sdk/php/3/classes/collection/search/snippets/search-1.php b/src/sdk/php/3/core-classes/collection/search/snippets/search-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/search/snippets/search-1.php rename to src/sdk/php/3/core-classes/collection/search/snippets/search-1.php diff --git a/src/sdk/php/3/classes/collection/set-headers/index.md b/src/sdk/php/3/core-classes/collection/set-headers/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/set-headers/index.md rename to src/sdk/php/3/core-classes/collection/set-headers/index.md diff --git a/src/sdk/php/3/classes/collection/set-headers/snippets/set-headers-1.php b/src/sdk/php/3/core-classes/collection/set-headers/snippets/set-headers-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/set-headers/snippets/set-headers-1.php rename to src/sdk/php/3/core-classes/collection/set-headers/snippets/set-headers-1.php diff --git a/src/sdk/php/3/classes/collection/truncate/index.md b/src/sdk/php/3/core-classes/collection/truncate/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/truncate/index.md rename to src/sdk/php/3/core-classes/collection/truncate/index.md diff --git a/src/sdk/php/3/classes/collection/truncate/snippets/truncate-1.php b/src/sdk/php/3/core-classes/collection/truncate/snippets/truncate-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/truncate/snippets/truncate-1.php rename to src/sdk/php/3/core-classes/collection/truncate/snippets/truncate-1.php diff --git a/src/sdk/php/3/classes/collection/update-document/index.md b/src/sdk/php/3/core-classes/collection/update-document/index.md similarity index 95% rename from src/sdk/php/3/classes/collection/update-document/index.md rename to src/sdk/php/3/core-classes/collection/update-document/index.md index 4cc365dfa..fd36e886c 100644 --- a/src/sdk/php/3/classes/collection/update-document/index.md +++ b/src/sdk/php/3/core-classes/collection/update-document/index.md @@ -7,7 +7,7 @@ description: Collection:updateDocument # updateDocument -Update parts of a document, by replacing some fields or adding new ones. +Update parts of a document, by replacing some fields or adding new ones. Note that you cannot remove fields this way: missing fields will simply be left unchanged. --- @@ -42,7 +42,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an up-to-date [Document](/sdk/php/3/classes/document/) object. +Returns an up-to-date [Document](/sdk/php/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/php/3/classes/collection/update-document/snippets/update-document-1.php b/src/sdk/php/3/core-classes/collection/update-document/snippets/update-document-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/update-document/snippets/update-document-1.php rename to src/sdk/php/3/core-classes/collection/update-document/snippets/update-document-1.php diff --git a/src/sdk/php/3/classes/collection/update-specifications/index.md b/src/sdk/php/3/core-classes/collection/update-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/update-specifications/index.md rename to src/sdk/php/3/core-classes/collection/update-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/update-specifications/snippets/update-specifications-1.php b/src/sdk/php/3/core-classes/collection/update-specifications/snippets/update-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/update-specifications/snippets/update-specifications-1.php rename to src/sdk/php/3/core-classes/collection/update-specifications/snippets/update-specifications-1.php diff --git a/src/sdk/php/3/classes/collection/validate-specifications/index.md b/src/sdk/php/3/core-classes/collection/validate-specifications/index.md similarity index 100% rename from src/sdk/php/3/classes/collection/validate-specifications/index.md rename to src/sdk/php/3/core-classes/collection/validate-specifications/index.md diff --git a/src/sdk/php/3/classes/collection/validate-specifications/snippets/validate-specifications-1.php b/src/sdk/php/3/core-classes/collection/validate-specifications/snippets/validate-specifications-1.php similarity index 100% rename from src/sdk/php/3/classes/collection/validate-specifications/snippets/validate-specifications-1.php rename to src/sdk/php/3/core-classes/collection/validate-specifications/snippets/validate-specifications-1.php diff --git a/src/sdk/php/3/classes/document/constructor/index.md b/src/sdk/php/3/core-classes/document/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/document/constructor/index.md rename to src/sdk/php/3/core-classes/document/constructor/index.md diff --git a/src/sdk/php/3/classes/document/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/document/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/document/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/document/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/document/delete/index.md b/src/sdk/php/3/core-classes/document/delete/index.md similarity index 100% rename from src/sdk/php/3/classes/document/delete/index.md rename to src/sdk/php/3/core-classes/document/delete/index.md diff --git a/src/sdk/php/3/classes/document/delete/snippets/delete-1.php b/src/sdk/php/3/core-classes/document/delete/snippets/delete-1.php similarity index 100% rename from src/sdk/php/3/classes/document/delete/snippets/delete-1.php rename to src/sdk/php/3/core-classes/document/delete/snippets/delete-1.php diff --git a/src/sdk/php/3/classes/document/exists/index.md b/src/sdk/php/3/core-classes/document/exists/index.md similarity index 100% rename from src/sdk/php/3/classes/document/exists/index.md rename to src/sdk/php/3/core-classes/document/exists/index.md diff --git a/src/sdk/php/3/classes/document/exists/snippets/exists-1.php b/src/sdk/php/3/core-classes/document/exists/snippets/exists-1.php similarity index 100% rename from src/sdk/php/3/classes/document/exists/snippets/exists-1.php rename to src/sdk/php/3/core-classes/document/exists/snippets/exists-1.php diff --git a/src/sdk/php/3/classes/document/index.md b/src/sdk/php/3/core-classes/document/index.md similarity index 100% rename from src/sdk/php/3/classes/document/index.md rename to src/sdk/php/3/core-classes/document/index.md diff --git a/src/sdk/php/3/classes/document/publish/index.md b/src/sdk/php/3/core-classes/document/publish/index.md similarity index 100% rename from src/sdk/php/3/classes/document/publish/index.md rename to src/sdk/php/3/core-classes/document/publish/index.md diff --git a/src/sdk/php/3/classes/document/publish/snippets/publish-1.php b/src/sdk/php/3/core-classes/document/publish/snippets/publish-1.php similarity index 100% rename from src/sdk/php/3/classes/document/publish/snippets/publish-1.php rename to src/sdk/php/3/core-classes/document/publish/snippets/publish-1.php diff --git a/src/sdk/php/3/classes/document/refresh/index.md b/src/sdk/php/3/core-classes/document/refresh/index.md similarity index 100% rename from src/sdk/php/3/classes/document/refresh/index.md rename to src/sdk/php/3/core-classes/document/refresh/index.md diff --git a/src/sdk/php/3/classes/document/refresh/snippets/refresh-1.php b/src/sdk/php/3/core-classes/document/refresh/snippets/refresh-1.php similarity index 100% rename from src/sdk/php/3/classes/document/refresh/snippets/refresh-1.php rename to src/sdk/php/3/core-classes/document/refresh/snippets/refresh-1.php diff --git a/src/sdk/php/3/classes/document/save/index.md b/src/sdk/php/3/core-classes/document/save/index.md similarity index 100% rename from src/sdk/php/3/classes/document/save/index.md rename to src/sdk/php/3/core-classes/document/save/index.md diff --git a/src/sdk/php/3/classes/document/save/snippets/save-1.php b/src/sdk/php/3/core-classes/document/save/snippets/save-1.php similarity index 100% rename from src/sdk/php/3/classes/document/save/snippets/save-1.php rename to src/sdk/php/3/core-classes/document/save/snippets/save-1.php diff --git a/src/sdk/php/3/classes/document/set-content/index.md b/src/sdk/php/3/core-classes/document/set-content/index.md similarity index 100% rename from src/sdk/php/3/classes/document/set-content/index.md rename to src/sdk/php/3/core-classes/document/set-content/index.md diff --git a/src/sdk/php/3/classes/document/set-content/snippets/set-content-1.php b/src/sdk/php/3/core-classes/document/set-content/snippets/set-content-1.php similarity index 100% rename from src/sdk/php/3/classes/document/set-content/snippets/set-content-1.php rename to src/sdk/php/3/core-classes/document/set-content/snippets/set-content-1.php diff --git a/src/sdk/php/3/classes/document/set-headers/index.md b/src/sdk/php/3/core-classes/document/set-headers/index.md similarity index 100% rename from src/sdk/php/3/classes/document/set-headers/index.md rename to src/sdk/php/3/core-classes/document/set-headers/index.md diff --git a/src/sdk/php/3/classes/document/set-headers/snippets/set-headers-1.php b/src/sdk/php/3/core-classes/document/set-headers/snippets/set-headers-1.php similarity index 100% rename from src/sdk/php/3/classes/document/set-headers/snippets/set-headers-1.php rename to src/sdk/php/3/core-classes/document/set-headers/snippets/set-headers-1.php diff --git a/src/sdk/php/3/classes/index.md b/src/sdk/php/3/core-classes/index.md similarity index 100% rename from src/sdk/php/3/classes/index.md rename to src/sdk/php/3/core-classes/index.md diff --git a/src/sdk/php/3/classes/kuzzle/add-listener/index.md b/src/sdk/php/3/core-classes/kuzzle/add-listener/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/add-listener/index.md rename to src/sdk/php/3/core-classes/kuzzle/add-listener/index.md diff --git a/src/sdk/php/3/classes/kuzzle/add-listener/snippets/add-listener-1.php b/src/sdk/php/3/core-classes/kuzzle/add-listener/snippets/add-listener-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/add-listener/snippets/add-listener-1.php rename to src/sdk/php/3/core-classes/kuzzle/add-listener/snippets/add-listener-1.php diff --git a/src/sdk/php/3/classes/kuzzle/check-token/index.md b/src/sdk/php/3/core-classes/kuzzle/check-token/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/check-token/index.md rename to src/sdk/php/3/core-classes/kuzzle/check-token/index.md diff --git a/src/sdk/php/3/classes/kuzzle/check-token/snippets/check-token-1.php b/src/sdk/php/3/core-classes/kuzzle/check-token/snippets/check-token-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/check-token/snippets/check-token-1.php rename to src/sdk/php/3/core-classes/kuzzle/check-token/snippets/check-token-1.php diff --git a/src/sdk/php/3/classes/kuzzle/collection/index.md b/src/sdk/php/3/core-classes/kuzzle/collection/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/collection/index.md rename to src/sdk/php/3/core-classes/kuzzle/collection/index.md diff --git a/src/sdk/php/3/classes/kuzzle/collection/snippets/collection-1.php b/src/sdk/php/3/core-classes/kuzzle/collection/snippets/collection-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/collection/snippets/collection-1.php rename to src/sdk/php/3/core-classes/kuzzle/collection/snippets/collection-1.php diff --git a/src/sdk/php/3/classes/kuzzle/connect/index.md b/src/sdk/php/3/core-classes/kuzzle/connect/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/connect/index.md rename to src/sdk/php/3/core-classes/kuzzle/connect/index.md diff --git a/src/sdk/php/3/classes/kuzzle/connect/snippets/connect-1.php b/src/sdk/php/3/core-classes/kuzzle/connect/snippets/connect-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/connect/snippets/connect-1.php rename to src/sdk/php/3/core-classes/kuzzle/connect/snippets/connect-1.php diff --git a/src/sdk/php/3/classes/kuzzle/constructor/index.md b/src/sdk/php/3/core-classes/kuzzle/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/constructor/index.md rename to src/sdk/php/3/core-classes/kuzzle/constructor/index.md diff --git a/src/sdk/php/3/classes/kuzzle/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/kuzzle/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/kuzzle/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/kuzzle/create-index/index.md b/src/sdk/php/3/core-classes/kuzzle/create-index/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/create-index/index.md rename to src/sdk/php/3/core-classes/kuzzle/create-index/index.md diff --git a/src/sdk/php/3/classes/kuzzle/create-index/snippets/create-index-1.php b/src/sdk/php/3/core-classes/kuzzle/create-index/snippets/create-index-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/create-index/snippets/create-index-1.php rename to src/sdk/php/3/core-classes/kuzzle/create-index/snippets/create-index-1.php diff --git a/src/sdk/php/3/classes/kuzzle/create-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/create-my-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/create-my-credentials/index.md rename to src/sdk/php/3/core-classes/kuzzle/create-my-credentials/index.md diff --git a/src/sdk/php/3/classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.php b/src/sdk/php/3/core-classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.php rename to src/sdk/php/3/core-classes/kuzzle/create-my-credentials/snippets/create-my-credentials-1.php diff --git a/src/sdk/php/3/classes/kuzzle/delete-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/delete-my-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/delete-my-credentials/index.md rename to src/sdk/php/3/core-classes/kuzzle/delete-my-credentials/index.md diff --git a/src/sdk/php/3/classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.php b/src/sdk/php/3/core-classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.php rename to src/sdk/php/3/core-classes/kuzzle/delete-my-credentials/snippets/delete-my-credentials-1.php diff --git a/src/sdk/php/3/classes/kuzzle/disconnect/index.md b/src/sdk/php/3/core-classes/kuzzle/disconnect/index.md similarity index 81% rename from src/sdk/php/3/classes/kuzzle/disconnect/index.md rename to src/sdk/php/3/core-classes/kuzzle/disconnect/index.md index 470e8f5b9..db0f39f1e 100644 --- a/src/sdk/php/3/classes/kuzzle/disconnect/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/disconnect/index.md @@ -7,8 +7,8 @@ description: Kuzzle:disconnect # disconnect -Closes the current connection, and frees all allocated resources. -Contrary to the `offline` state (when the network connection is unexpectedly lost), `disconnect()` invalidates the instance, which cannot be used until [connect()](/sdk/php/3/classes/kuzzle/connect/) is explicitly called. +Closes the current connection, and frees all allocated resources. +Contrary to the `offline` state (when the network connection is unexpectedly lost), `disconnect()` invalidates the instance, which cannot be used until [connect()](/sdk/php/3/core-classes/kuzzle/connect/) is explicitly called. This action does not trigger a `disconnected` event since this event is triggered when an unexpected disconnection occur. ## Usage diff --git a/src/sdk/php/3/classes/kuzzle/disconnect/snippets/disconnect-1.php b/src/sdk/php/3/core-classes/kuzzle/disconnect/snippets/disconnect-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/disconnect/snippets/disconnect-1.php rename to src/sdk/php/3/core-classes/kuzzle/disconnect/snippets/disconnect-1.php diff --git a/src/sdk/php/3/classes/kuzzle/flush-queue/index.md b/src/sdk/php/3/core-classes/kuzzle/flush-queue/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/flush-queue/index.md rename to src/sdk/php/3/core-classes/kuzzle/flush-queue/index.md diff --git a/src/sdk/php/3/classes/kuzzle/flush-queue/snippets/flush-queue-1.php b/src/sdk/php/3/core-classes/kuzzle/flush-queue/snippets/flush-queue-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/flush-queue/snippets/flush-queue-1.php rename to src/sdk/php/3/core-classes/kuzzle/flush-queue/snippets/flush-queue-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-all-statistics/index.md b/src/sdk/php/3/core-classes/kuzzle/get-all-statistics/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-all-statistics/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-all-statistics/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.php b/src/sdk/php/3/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-all-statistics/snippets/get-all-statistics-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-auto-refresh/index.md b/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-auto-refresh/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.php b/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/snippets/get-auto-refresh-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-jwt-token/index.md b/src/sdk/php/3/core-classes/kuzzle/get-jwt-token/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-jwt-token/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-jwt-token/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.php b/src/sdk/php/3/core-classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-jwt-token/snippets/get-jwt-token-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-my-credentials/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.php b/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-my-credentials/snippets/get-my-credentials-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-my-rights/index.md b/src/sdk/php/3/core-classes/kuzzle/get-my-rights/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-my-rights/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-my-rights/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-my-rights/snippets/get-my-rights-1.php b/src/sdk/php/3/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-my-rights/snippets/get-my-rights-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-my-rights/snippets/get-my-rights-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-server-info/index.md b/src/sdk/php/3/core-classes/kuzzle/get-server-info/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-server-info/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-server-info/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-server-info/snippets/get-server-info-1.php b/src/sdk/php/3/core-classes/kuzzle/get-server-info/snippets/get-server-info-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-server-info/snippets/get-server-info-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-server-info/snippets/get-server-info-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-statistics/index.md b/src/sdk/php/3/core-classes/kuzzle/get-statistics/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-statistics/index.md rename to src/sdk/php/3/core-classes/kuzzle/get-statistics/index.md diff --git a/src/sdk/php/3/classes/kuzzle/get-statistics/snippets/get-statistics-1.php b/src/sdk/php/3/core-classes/kuzzle/get-statistics/snippets/get-statistics-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-statistics/snippets/get-statistics-1.php rename to src/sdk/php/3/core-classes/kuzzle/get-statistics/snippets/get-statistics-1.php diff --git a/src/sdk/php/3/classes/kuzzle/get-statistics/snippets/get-statistics-2.php b/src/sdk/php/3/core-classes/kuzzle/get-statistics/snippets/get-statistics-2.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/get-statistics/snippets/get-statistics-2.php rename to src/sdk/php/3/core-classes/kuzzle/get-statistics/snippets/get-statistics-2.php diff --git a/src/sdk/php/3/classes/kuzzle/index.md b/src/sdk/php/3/core-classes/kuzzle/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/index.md rename to src/sdk/php/3/core-classes/kuzzle/index.md diff --git a/src/sdk/php/3/classes/kuzzle/list-collections/index.md b/src/sdk/php/3/core-classes/kuzzle/list-collections/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/list-collections/index.md rename to src/sdk/php/3/core-classes/kuzzle/list-collections/index.md diff --git a/src/sdk/php/3/classes/kuzzle/list-collections/snippets/list-collections-1.php b/src/sdk/php/3/core-classes/kuzzle/list-collections/snippets/list-collections-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/list-collections/snippets/list-collections-1.php rename to src/sdk/php/3/core-classes/kuzzle/list-collections/snippets/list-collections-1.php diff --git a/src/sdk/php/3/classes/kuzzle/list-indexes/index.md b/src/sdk/php/3/core-classes/kuzzle/list-indexes/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/list-indexes/index.md rename to src/sdk/php/3/core-classes/kuzzle/list-indexes/index.md diff --git a/src/sdk/php/3/classes/kuzzle/list-indexes/snippets/list-indexes-1.php b/src/sdk/php/3/core-classes/kuzzle/list-indexes/snippets/list-indexes-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/list-indexes/snippets/list-indexes-1.php rename to src/sdk/php/3/core-classes/kuzzle/list-indexes/snippets/list-indexes-1.php diff --git a/src/sdk/php/3/classes/kuzzle/login/index.md b/src/sdk/php/3/core-classes/kuzzle/login/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/login/index.md rename to src/sdk/php/3/core-classes/kuzzle/login/index.md diff --git a/src/sdk/php/3/classes/kuzzle/login/snippets/login-1.php b/src/sdk/php/3/core-classes/kuzzle/login/snippets/login-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/login/snippets/login-1.php rename to src/sdk/php/3/core-classes/kuzzle/login/snippets/login-1.php diff --git a/src/sdk/php/3/classes/kuzzle/logout/index.md b/src/sdk/php/3/core-classes/kuzzle/logout/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/logout/index.md rename to src/sdk/php/3/core-classes/kuzzle/logout/index.md diff --git a/src/sdk/php/3/classes/kuzzle/logout/snippets/logout-1.php b/src/sdk/php/3/core-classes/kuzzle/logout/snippets/logout-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/logout/snippets/logout-1.php rename to src/sdk/php/3/core-classes/kuzzle/logout/snippets/logout-1.php diff --git a/src/sdk/php/3/classes/kuzzle/memory-storage/index.md b/src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/memory-storage/index.md rename to src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md diff --git a/src/sdk/php/3/classes/kuzzle/now/index.md b/src/sdk/php/3/core-classes/kuzzle/now/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/now/index.md rename to src/sdk/php/3/core-classes/kuzzle/now/index.md diff --git a/src/sdk/php/3/classes/kuzzle/now/snippets/now-1.php b/src/sdk/php/3/core-classes/kuzzle/now/snippets/now-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/now/snippets/now-1.php rename to src/sdk/php/3/core-classes/kuzzle/now/snippets/now-1.php diff --git a/src/sdk/php/3/classes/kuzzle/query/index.md b/src/sdk/php/3/core-classes/kuzzle/query/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/query/index.md rename to src/sdk/php/3/core-classes/kuzzle/query/index.md diff --git a/src/sdk/php/3/classes/kuzzle/query/snippets/query-1.php b/src/sdk/php/3/core-classes/kuzzle/query/snippets/query-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/query/snippets/query-1.php rename to src/sdk/php/3/core-classes/kuzzle/query/snippets/query-1.php diff --git a/src/sdk/php/3/classes/kuzzle/refresh-index/index.md b/src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/refresh-index/index.md rename to src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md diff --git a/src/sdk/php/3/classes/kuzzle/refresh-index/snippets/refresh-index-1.php b/src/sdk/php/3/core-classes/kuzzle/refresh-index/snippets/refresh-index-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/refresh-index/snippets/refresh-index-1.php rename to src/sdk/php/3/core-classes/kuzzle/refresh-index/snippets/refresh-index-1.php diff --git a/src/sdk/php/3/classes/kuzzle/remove-all-listeners/index.md b/src/sdk/php/3/core-classes/kuzzle/remove-all-listeners/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/remove-all-listeners/index.md rename to src/sdk/php/3/core-classes/kuzzle/remove-all-listeners/index.md diff --git a/src/sdk/php/3/classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.php b/src/sdk/php/3/core-classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.php rename to src/sdk/php/3/core-classes/kuzzle/remove-all-listeners/snippets/remove-all-listeners-1.php diff --git a/src/sdk/php/3/classes/kuzzle/remove-listener/index.md b/src/sdk/php/3/core-classes/kuzzle/remove-listener/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/remove-listener/index.md rename to src/sdk/php/3/core-classes/kuzzle/remove-listener/index.md diff --git a/src/sdk/php/3/classes/kuzzle/remove-listener/snippets/remove-listener-1.php b/src/sdk/php/3/core-classes/kuzzle/remove-listener/snippets/remove-listener-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/remove-listener/snippets/remove-listener-1.php rename to src/sdk/php/3/core-classes/kuzzle/remove-listener/snippets/remove-listener-1.php diff --git a/src/sdk/php/3/classes/kuzzle/replay-queue/index.md b/src/sdk/php/3/core-classes/kuzzle/replay-queue/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/replay-queue/index.md rename to src/sdk/php/3/core-classes/kuzzle/replay-queue/index.md diff --git a/src/sdk/php/3/classes/kuzzle/replay-queue/snippets/replay-queue-1.php b/src/sdk/php/3/core-classes/kuzzle/replay-queue/snippets/replay-queue-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/replay-queue/snippets/replay-queue-1.php rename to src/sdk/php/3/core-classes/kuzzle/replay-queue/snippets/replay-queue-1.php diff --git a/src/sdk/php/3/classes/kuzzle/security/index.md b/src/sdk/php/3/core-classes/kuzzle/security/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/security/index.md rename to src/sdk/php/3/core-classes/kuzzle/security/index.md diff --git a/src/sdk/php/3/classes/kuzzle/set-auto-refresh/index.md b/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-auto-refresh/index.md rename to src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md diff --git a/src/sdk/php/3/classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.php b/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.php rename to src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/snippets/set-auto-refresh-1.php diff --git a/src/sdk/php/3/classes/kuzzle/set-default-index/index.md b/src/sdk/php/3/core-classes/kuzzle/set-default-index/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-default-index/index.md rename to src/sdk/php/3/core-classes/kuzzle/set-default-index/index.md diff --git a/src/sdk/php/3/classes/kuzzle/set-default-index/snippets/set-default-index-1.php b/src/sdk/php/3/core-classes/kuzzle/set-default-index/snippets/set-default-index-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-default-index/snippets/set-default-index-1.php rename to src/sdk/php/3/core-classes/kuzzle/set-default-index/snippets/set-default-index-1.php diff --git a/src/sdk/php/3/classes/kuzzle/set-headers/index.md b/src/sdk/php/3/core-classes/kuzzle/set-headers/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-headers/index.md rename to src/sdk/php/3/core-classes/kuzzle/set-headers/index.md diff --git a/src/sdk/php/3/classes/kuzzle/set-headers/snippets/set-headers-1.php b/src/sdk/php/3/core-classes/kuzzle/set-headers/snippets/set-headers-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-headers/snippets/set-headers-1.php rename to src/sdk/php/3/core-classes/kuzzle/set-headers/snippets/set-headers-1.php diff --git a/src/sdk/php/3/classes/kuzzle/set-jwt-token/index.md b/src/sdk/php/3/core-classes/kuzzle/set-jwt-token/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-jwt-token/index.md rename to src/sdk/php/3/core-classes/kuzzle/set-jwt-token/index.md diff --git a/src/sdk/php/3/classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.php b/src/sdk/php/3/core-classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.php rename to src/sdk/php/3/core-classes/kuzzle/set-jwt-token/snippets/set-jwt-token-1.php diff --git a/src/sdk/php/3/classes/kuzzle/start-queuing/index.md b/src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/start-queuing/index.md rename to src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md diff --git a/src/sdk/php/3/classes/kuzzle/start-queuing/snippets/start-queuing-1.php b/src/sdk/php/3/core-classes/kuzzle/start-queuing/snippets/start-queuing-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/start-queuing/snippets/start-queuing-1.php rename to src/sdk/php/3/core-classes/kuzzle/start-queuing/snippets/start-queuing-1.php diff --git a/src/sdk/php/3/classes/kuzzle/stop-queuing/index.md b/src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/stop-queuing/index.md rename to src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md diff --git a/src/sdk/php/3/classes/kuzzle/stop-queuing/snippets/stop-queuing-1.php b/src/sdk/php/3/core-classes/kuzzle/stop-queuing/snippets/stop-queuing-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/stop-queuing/snippets/stop-queuing-1.php rename to src/sdk/php/3/core-classes/kuzzle/stop-queuing/snippets/stop-queuing-1.php diff --git a/src/sdk/php/3/classes/kuzzle/unset-jwt-token/index.md b/src/sdk/php/3/core-classes/kuzzle/unset-jwt-token/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/unset-jwt-token/index.md rename to src/sdk/php/3/core-classes/kuzzle/unset-jwt-token/index.md diff --git a/src/sdk/php/3/classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.php b/src/sdk/php/3/core-classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.php rename to src/sdk/php/3/core-classes/kuzzle/unset-jwt-token/snippets/unset-jwt-token-1.php diff --git a/src/sdk/php/3/classes/kuzzle/update-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/update-my-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/update-my-credentials/index.md rename to src/sdk/php/3/core-classes/kuzzle/update-my-credentials/index.md diff --git a/src/sdk/php/3/classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.php b/src/sdk/php/3/core-classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.php rename to src/sdk/php/3/core-classes/kuzzle/update-my-credentials/snippets/update-my-credentials-1.php diff --git a/src/sdk/php/3/classes/kuzzle/update-self/index.md b/src/sdk/php/3/core-classes/kuzzle/update-self/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/update-self/index.md rename to src/sdk/php/3/core-classes/kuzzle/update-self/index.md diff --git a/src/sdk/php/3/classes/kuzzle/update-self/snippets/update-self-1.php b/src/sdk/php/3/core-classes/kuzzle/update-self/snippets/update-self-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/update-self/snippets/update-self-1.php rename to src/sdk/php/3/core-classes/kuzzle/update-self/snippets/update-self-1.php diff --git a/src/sdk/php/3/classes/kuzzle/validate-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/validate-my-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/validate-my-credentials/index.md rename to src/sdk/php/3/core-classes/kuzzle/validate-my-credentials/index.md diff --git a/src/sdk/php/3/classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.php b/src/sdk/php/3/core-classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.php rename to src/sdk/php/3/core-classes/kuzzle/validate-my-credentials/snippets/validate-my-credentials-1.php diff --git a/src/sdk/php/3/classes/kuzzle/who-am-i/index.md b/src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md similarity index 100% rename from src/sdk/php/3/classes/kuzzle/who-am-i/index.md rename to src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md diff --git a/src/sdk/php/3/classes/kuzzle/who-am-i/snippets/who-am-i-1.php b/src/sdk/php/3/core-classes/kuzzle/who-am-i/snippets/who-am-i-1.php similarity index 100% rename from src/sdk/php/3/classes/kuzzle/who-am-i/snippets/who-am-i-1.php rename to src/sdk/php/3/core-classes/kuzzle/who-am-i/snippets/who-am-i-1.php diff --git a/src/sdk/php/3/classes/memory-storage/append/index.md b/src/sdk/php/3/core-classes/memory-storage/append/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/append/index.md rename to src/sdk/php/3/core-classes/memory-storage/append/index.md diff --git a/src/sdk/php/3/classes/memory-storage/append/snippets/append-1.php b/src/sdk/php/3/core-classes/memory-storage/append/snippets/append-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/append/snippets/append-1.php rename to src/sdk/php/3/core-classes/memory-storage/append/snippets/append-1.php diff --git a/src/sdk/php/3/classes/memory-storage/bitcount/index.md b/src/sdk/php/3/core-classes/memory-storage/bitcount/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitcount/index.md rename to src/sdk/php/3/core-classes/memory-storage/bitcount/index.md diff --git a/src/sdk/php/3/classes/memory-storage/bitcount/snippets/bitcount-1.php b/src/sdk/php/3/core-classes/memory-storage/bitcount/snippets/bitcount-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitcount/snippets/bitcount-1.php rename to src/sdk/php/3/core-classes/memory-storage/bitcount/snippets/bitcount-1.php diff --git a/src/sdk/php/3/classes/memory-storage/bitop/index.md b/src/sdk/php/3/core-classes/memory-storage/bitop/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitop/index.md rename to src/sdk/php/3/core-classes/memory-storage/bitop/index.md diff --git a/src/sdk/php/3/classes/memory-storage/bitop/snippets/bitop-1.php b/src/sdk/php/3/core-classes/memory-storage/bitop/snippets/bitop-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitop/snippets/bitop-1.php rename to src/sdk/php/3/core-classes/memory-storage/bitop/snippets/bitop-1.php diff --git a/src/sdk/php/3/classes/memory-storage/bitpos/index.md b/src/sdk/php/3/core-classes/memory-storage/bitpos/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitpos/index.md rename to src/sdk/php/3/core-classes/memory-storage/bitpos/index.md diff --git a/src/sdk/php/3/classes/memory-storage/bitpos/snippets/bitpos-1.php b/src/sdk/php/3/core-classes/memory-storage/bitpos/snippets/bitpos-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/bitpos/snippets/bitpos-1.php rename to src/sdk/php/3/core-classes/memory-storage/bitpos/snippets/bitpos-1.php diff --git a/src/sdk/php/3/classes/memory-storage/constructor/index.md b/src/sdk/php/3/core-classes/memory-storage/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/constructor/index.md rename to src/sdk/php/3/core-classes/memory-storage/constructor/index.md diff --git a/src/sdk/php/3/classes/memory-storage/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/memory-storage/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/memory-storage/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/memory-storage/dbsize/index.md b/src/sdk/php/3/core-classes/memory-storage/dbsize/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/dbsize/index.md rename to src/sdk/php/3/core-classes/memory-storage/dbsize/index.md diff --git a/src/sdk/php/3/classes/memory-storage/dbsize/snippets/dbsize-1.php b/src/sdk/php/3/core-classes/memory-storage/dbsize/snippets/dbsize-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/dbsize/snippets/dbsize-1.php rename to src/sdk/php/3/core-classes/memory-storage/dbsize/snippets/dbsize-1.php diff --git a/src/sdk/php/3/classes/memory-storage/decr/index.md b/src/sdk/php/3/core-classes/memory-storage/decr/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/decr/index.md rename to src/sdk/php/3/core-classes/memory-storage/decr/index.md diff --git a/src/sdk/php/3/classes/memory-storage/decr/snippets/decr-1.php b/src/sdk/php/3/core-classes/memory-storage/decr/snippets/decr-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/decr/snippets/decr-1.php rename to src/sdk/php/3/core-classes/memory-storage/decr/snippets/decr-1.php diff --git a/src/sdk/php/3/classes/memory-storage/decrby/index.md b/src/sdk/php/3/core-classes/memory-storage/decrby/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/decrby/index.md rename to src/sdk/php/3/core-classes/memory-storage/decrby/index.md diff --git a/src/sdk/php/3/classes/memory-storage/decrby/snippets/decrby-1.php b/src/sdk/php/3/core-classes/memory-storage/decrby/snippets/decrby-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/decrby/snippets/decrby-1.php rename to src/sdk/php/3/core-classes/memory-storage/decrby/snippets/decrby-1.php diff --git a/src/sdk/php/3/classes/memory-storage/del/index.md b/src/sdk/php/3/core-classes/memory-storage/del/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/del/index.md rename to src/sdk/php/3/core-classes/memory-storage/del/index.md diff --git a/src/sdk/php/3/classes/memory-storage/del/snippets/del-1.php b/src/sdk/php/3/core-classes/memory-storage/del/snippets/del-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/del/snippets/del-1.php rename to src/sdk/php/3/core-classes/memory-storage/del/snippets/del-1.php diff --git a/src/sdk/php/3/classes/memory-storage/exists/index.md b/src/sdk/php/3/core-classes/memory-storage/exists/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/exists/index.md rename to src/sdk/php/3/core-classes/memory-storage/exists/index.md diff --git a/src/sdk/php/3/classes/memory-storage/exists/snippets/exists-1.php b/src/sdk/php/3/core-classes/memory-storage/exists/snippets/exists-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/exists/snippets/exists-1.php rename to src/sdk/php/3/core-classes/memory-storage/exists/snippets/exists-1.php diff --git a/src/sdk/php/3/classes/memory-storage/expire/index.md b/src/sdk/php/3/core-classes/memory-storage/expire/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/expire/index.md rename to src/sdk/php/3/core-classes/memory-storage/expire/index.md diff --git a/src/sdk/php/3/classes/memory-storage/expire/snippets/expire-1.php b/src/sdk/php/3/core-classes/memory-storage/expire/snippets/expire-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/expire/snippets/expire-1.php rename to src/sdk/php/3/core-classes/memory-storage/expire/snippets/expire-1.php diff --git a/src/sdk/php/3/classes/memory-storage/expireat/index.md b/src/sdk/php/3/core-classes/memory-storage/expireat/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/expireat/index.md rename to src/sdk/php/3/core-classes/memory-storage/expireat/index.md diff --git a/src/sdk/php/3/classes/memory-storage/expireat/snippets/expireat-1.php b/src/sdk/php/3/core-classes/memory-storage/expireat/snippets/expireat-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/expireat/snippets/expireat-1.php rename to src/sdk/php/3/core-classes/memory-storage/expireat/snippets/expireat-1.php diff --git a/src/sdk/php/3/classes/memory-storage/flushdb/index.md b/src/sdk/php/3/core-classes/memory-storage/flushdb/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/flushdb/index.md rename to src/sdk/php/3/core-classes/memory-storage/flushdb/index.md diff --git a/src/sdk/php/3/classes/memory-storage/flushdb/snippets/flushdb-1.php b/src/sdk/php/3/core-classes/memory-storage/flushdb/snippets/flushdb-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/flushdb/snippets/flushdb-1.php rename to src/sdk/php/3/core-classes/memory-storage/flushdb/snippets/flushdb-1.php diff --git a/src/sdk/php/3/classes/memory-storage/geoadd/index.md b/src/sdk/php/3/core-classes/memory-storage/geoadd/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/geoadd/index.md rename to src/sdk/php/3/core-classes/memory-storage/geoadd/index.md diff --git a/src/sdk/php/3/classes/memory-storage/geoadd/snippets/geoadd-1.php b/src/sdk/php/3/core-classes/memory-storage/geoadd/snippets/geoadd-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/geoadd/snippets/geoadd-1.php rename to src/sdk/php/3/core-classes/memory-storage/geoadd/snippets/geoadd-1.php diff --git a/src/sdk/php/3/classes/memory-storage/geodist/index.md b/src/sdk/php/3/core-classes/memory-storage/geodist/index.md similarity index 95% rename from src/sdk/php/3/classes/memory-storage/geodist/index.md rename to src/sdk/php/3/core-classes/memory-storage/geodist/index.md index 34d505e32..2209b6b9e 100644 --- a/src/sdk/php/3/classes/memory-storage/geodist/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/geodist/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geodist # geodist -Returns the distance between two geospatial members of a key (see [geoadd](/sdk/php/3/classes/memory-storage/geoadd/)). +Returns the distance between two geospatial members of a key (see [geoadd](/sdk/php/3/core-classes/memory-storage/geoadd/)). The returned distance is expressed in meters by default. [[_Redis documentation_]](https://redis.io/commands/geodist) diff --git a/src/sdk/php/3/classes/memory-storage/geodist/snippets/geodist-1.php b/src/sdk/php/3/core-classes/memory-storage/geodist/snippets/geodist-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/geodist/snippets/geodist-1.php rename to src/sdk/php/3/core-classes/memory-storage/geodist/snippets/geodist-1.php diff --git a/src/sdk/php/3/classes/memory-storage/geohash/index.md b/src/sdk/php/3/core-classes/memory-storage/geohash/index.md similarity index 92% rename from src/sdk/php/3/classes/memory-storage/geohash/index.md rename to src/sdk/php/3/core-classes/memory-storage/geohash/index.md index 2875d29a9..78beb64b6 100644 --- a/src/sdk/php/3/classes/memory-storage/geohash/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/geohash/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geohash # geohash -Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/php/3/classes/memory-storage/geoadd/)). +Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/php/3/core-classes/memory-storage/geoadd/)). [[_Redis documentation_]](https://redis.io/commands/geohash) diff --git a/src/sdk/php/3/classes/memory-storage/geohash/snippets/geohash-1.php b/src/sdk/php/3/core-classes/memory-storage/geohash/snippets/geohash-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/geohash/snippets/geohash-1.php rename to src/sdk/php/3/core-classes/memory-storage/geohash/snippets/geohash-1.php diff --git a/src/sdk/php/3/classes/memory-storage/geopos/index.md b/src/sdk/php/3/core-classes/memory-storage/geopos/index.md similarity index 94% rename from src/sdk/php/3/classes/memory-storage/geopos/index.md rename to src/sdk/php/3/core-classes/memory-storage/geopos/index.md index 24c15e0dc..c0e42aa85 100644 --- a/src/sdk/php/3/classes/memory-storage/geopos/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/geopos/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geopos # geopos -Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/php/3/classes/memory-storage/geoadd/)). +Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/php/3/core-classes/memory-storage/geoadd/)). [[_Redis documentation_]](https://redis.io/commands/geopos) diff --git a/src/sdk/php/3/classes/memory-storage/geopos/snippets/geopos-1.php b/src/sdk/php/3/core-classes/memory-storage/geopos/snippets/geopos-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/geopos/snippets/geopos-1.php rename to src/sdk/php/3/core-classes/memory-storage/geopos/snippets/geopos-1.php diff --git a/src/sdk/php/3/classes/memory-storage/georadius/index.md b/src/sdk/php/3/core-classes/memory-storage/georadius/index.md similarity index 94% rename from src/sdk/php/3/classes/memory-storage/georadius/index.md rename to src/sdk/php/3/core-classes/memory-storage/georadius/index.md index d13d0f741..3c651c910 100644 --- a/src/sdk/php/3/classes/memory-storage/georadius/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/georadius/index.md @@ -31,7 +31,7 @@ description: MemoryStorage:georadius ] ``` -Returns the members (added with [geoadd](/sdk/php/3/classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius. +Returns the members (added with [geoadd](/sdk/php/3/core-classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius. [[_Redis documentation_]](https://redis.io/commands/georadius) diff --git a/src/sdk/php/3/classes/memory-storage/georadius/snippets/georadius-1.php b/src/sdk/php/3/core-classes/memory-storage/georadius/snippets/georadius-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/georadius/snippets/georadius-1.php rename to src/sdk/php/3/core-classes/memory-storage/georadius/snippets/georadius-1.php diff --git a/src/sdk/php/3/classes/memory-storage/georadiusbymember/index.md b/src/sdk/php/3/core-classes/memory-storage/georadiusbymember/index.md similarity index 93% rename from src/sdk/php/3/classes/memory-storage/georadiusbymember/index.md rename to src/sdk/php/3/core-classes/memory-storage/georadiusbymember/index.md index c341a706f..ff4640e90 100644 --- a/src/sdk/php/3/classes/memory-storage/georadiusbymember/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/georadiusbymember/index.md @@ -25,7 +25,7 @@ description: MemoryStorage:georadiusbymember ] ``` -Returns the members (added with [geoadd](/sdk/php/3/classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. +Returns the members (added with [geoadd](/sdk/php/3/core-classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. [[_Redis documentation_]](https://redis.io/commands/georadiusbymember) --- diff --git a/src/sdk/php/3/classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.php b/src/sdk/php/3/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.php rename to src/sdk/php/3/core-classes/memory-storage/georadiusbymember/snippets/georadiusbymember-1.php diff --git a/src/sdk/php/3/classes/memory-storage/get/index.md b/src/sdk/php/3/core-classes/memory-storage/get/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/get/index.md rename to src/sdk/php/3/core-classes/memory-storage/get/index.md diff --git a/src/sdk/php/3/classes/memory-storage/get/snippets/get-1.php b/src/sdk/php/3/core-classes/memory-storage/get/snippets/get-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/get/snippets/get-1.php rename to src/sdk/php/3/core-classes/memory-storage/get/snippets/get-1.php diff --git a/src/sdk/php/3/classes/memory-storage/getbit/index.md b/src/sdk/php/3/core-classes/memory-storage/getbit/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getbit/index.md rename to src/sdk/php/3/core-classes/memory-storage/getbit/index.md diff --git a/src/sdk/php/3/classes/memory-storage/getbit/snippets/getbit-1.php b/src/sdk/php/3/core-classes/memory-storage/getbit/snippets/getbit-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getbit/snippets/getbit-1.php rename to src/sdk/php/3/core-classes/memory-storage/getbit/snippets/getbit-1.php diff --git a/src/sdk/php/3/classes/memory-storage/getrange/index.md b/src/sdk/php/3/core-classes/memory-storage/getrange/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getrange/index.md rename to src/sdk/php/3/core-classes/memory-storage/getrange/index.md diff --git a/src/sdk/php/3/classes/memory-storage/getrange/snippets/getrange-1.php b/src/sdk/php/3/core-classes/memory-storage/getrange/snippets/getrange-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getrange/snippets/getrange-1.php rename to src/sdk/php/3/core-classes/memory-storage/getrange/snippets/getrange-1.php diff --git a/src/sdk/php/3/classes/memory-storage/getset/index.md b/src/sdk/php/3/core-classes/memory-storage/getset/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getset/index.md rename to src/sdk/php/3/core-classes/memory-storage/getset/index.md diff --git a/src/sdk/php/3/classes/memory-storage/getset/snippets/getset-1.php b/src/sdk/php/3/core-classes/memory-storage/getset/snippets/getset-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/getset/snippets/getset-1.php rename to src/sdk/php/3/core-classes/memory-storage/getset/snippets/getset-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hdel/index.md b/src/sdk/php/3/core-classes/memory-storage/hdel/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hdel/index.md rename to src/sdk/php/3/core-classes/memory-storage/hdel/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hdel/snippets/hdel-1.php b/src/sdk/php/3/core-classes/memory-storage/hdel/snippets/hdel-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hdel/snippets/hdel-1.php rename to src/sdk/php/3/core-classes/memory-storage/hdel/snippets/hdel-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hexists/index.md b/src/sdk/php/3/core-classes/memory-storage/hexists/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hexists/index.md rename to src/sdk/php/3/core-classes/memory-storage/hexists/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hexists/snippets/hexists-1.php b/src/sdk/php/3/core-classes/memory-storage/hexists/snippets/hexists-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hexists/snippets/hexists-1.php rename to src/sdk/php/3/core-classes/memory-storage/hexists/snippets/hexists-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hget/index.md b/src/sdk/php/3/core-classes/memory-storage/hget/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hget/index.md rename to src/sdk/php/3/core-classes/memory-storage/hget/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hget/snippets/hget-1.php b/src/sdk/php/3/core-classes/memory-storage/hget/snippets/hget-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hget/snippets/hget-1.php rename to src/sdk/php/3/core-classes/memory-storage/hget/snippets/hget-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hgetall/index.md b/src/sdk/php/3/core-classes/memory-storage/hgetall/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hgetall/index.md rename to src/sdk/php/3/core-classes/memory-storage/hgetall/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hgetall/snippets/hgetall-1.php b/src/sdk/php/3/core-classes/memory-storage/hgetall/snippets/hgetall-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hgetall/snippets/hgetall-1.php rename to src/sdk/php/3/core-classes/memory-storage/hgetall/snippets/hgetall-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hincrby/index.md b/src/sdk/php/3/core-classes/memory-storage/hincrby/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hincrby/index.md rename to src/sdk/php/3/core-classes/memory-storage/hincrby/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hincrby/snippets/hincrby-1.php b/src/sdk/php/3/core-classes/memory-storage/hincrby/snippets/hincrby-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hincrby/snippets/hincrby-1.php rename to src/sdk/php/3/core-classes/memory-storage/hincrby/snippets/hincrby-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hincrbyfloat/index.md b/src/sdk/php/3/core-classes/memory-storage/hincrbyfloat/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hincrbyfloat/index.md rename to src/sdk/php/3/core-classes/memory-storage/hincrbyfloat/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.php b/src/sdk/php/3/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.php rename to src/sdk/php/3/core-classes/memory-storage/hincrbyfloat/snippets/hincrbyfloat-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hkeys/index.md b/src/sdk/php/3/core-classes/memory-storage/hkeys/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hkeys/index.md rename to src/sdk/php/3/core-classes/memory-storage/hkeys/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hkeys/snippets/hkeys-1.php b/src/sdk/php/3/core-classes/memory-storage/hkeys/snippets/hkeys-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hkeys/snippets/hkeys-1.php rename to src/sdk/php/3/core-classes/memory-storage/hkeys/snippets/hkeys-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hlen/index.md b/src/sdk/php/3/core-classes/memory-storage/hlen/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hlen/index.md rename to src/sdk/php/3/core-classes/memory-storage/hlen/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hlen/snippets/hlen-1.php b/src/sdk/php/3/core-classes/memory-storage/hlen/snippets/hlen-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hlen/snippets/hlen-1.php rename to src/sdk/php/3/core-classes/memory-storage/hlen/snippets/hlen-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hmget/index.md b/src/sdk/php/3/core-classes/memory-storage/hmget/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hmget/index.md rename to src/sdk/php/3/core-classes/memory-storage/hmget/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hmget/snippets/hmget-1.php b/src/sdk/php/3/core-classes/memory-storage/hmget/snippets/hmget-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hmget/snippets/hmget-1.php rename to src/sdk/php/3/core-classes/memory-storage/hmget/snippets/hmget-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hmset/index.md b/src/sdk/php/3/core-classes/memory-storage/hmset/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hmset/index.md rename to src/sdk/php/3/core-classes/memory-storage/hmset/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hmset/snippets/hmset-1.php b/src/sdk/php/3/core-classes/memory-storage/hmset/snippets/hmset-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hmset/snippets/hmset-1.php rename to src/sdk/php/3/core-classes/memory-storage/hmset/snippets/hmset-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hscan/index.md b/src/sdk/php/3/core-classes/memory-storage/hscan/index.md similarity index 93% rename from src/sdk/php/3/classes/memory-storage/hscan/index.md rename to src/sdk/php/3/core-classes/memory-storage/hscan/index.md index 78fffb860..c9b40bb0c 100644 --- a/src/sdk/php/3/classes/memory-storage/hscan/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/hscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:hscan # hscan -Identical to [scan](/sdk/php/3/classes/memory-storage/scan/), except that `hscan` iterates over the fields contained in a hash. +Identical to [scan](/sdk/php/3/core-classes/memory-storage/scan/), except that `hscan` iterates over the fields contained in a hash. [[_Redis documentation_]](https://redis.io/commands/hscan) diff --git a/src/sdk/php/3/classes/memory-storage/hscan/snippets/hscan-1.php b/src/sdk/php/3/core-classes/memory-storage/hscan/snippets/hscan-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hscan/snippets/hscan-1.php rename to src/sdk/php/3/core-classes/memory-storage/hscan/snippets/hscan-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hset/index.md b/src/sdk/php/3/core-classes/memory-storage/hset/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hset/index.md rename to src/sdk/php/3/core-classes/memory-storage/hset/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hset/snippets/hset-1.php b/src/sdk/php/3/core-classes/memory-storage/hset/snippets/hset-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hset/snippets/hset-1.php rename to src/sdk/php/3/core-classes/memory-storage/hset/snippets/hset-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hsetnx/index.md b/src/sdk/php/3/core-classes/memory-storage/hsetnx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hsetnx/index.md rename to src/sdk/php/3/core-classes/memory-storage/hsetnx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hsetnx/snippets/hsetnx-1.php b/src/sdk/php/3/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hsetnx/snippets/hsetnx-1.php rename to src/sdk/php/3/core-classes/memory-storage/hsetnx/snippets/hsetnx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hstrlen/index.md b/src/sdk/php/3/core-classes/memory-storage/hstrlen/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hstrlen/index.md rename to src/sdk/php/3/core-classes/memory-storage/hstrlen/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hstrlen/snippets/hstrlen-1.php b/src/sdk/php/3/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hstrlen/snippets/hstrlen-1.php rename to src/sdk/php/3/core-classes/memory-storage/hstrlen/snippets/hstrlen-1.php diff --git a/src/sdk/php/3/classes/memory-storage/hvals/index.md b/src/sdk/php/3/core-classes/memory-storage/hvals/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hvals/index.md rename to src/sdk/php/3/core-classes/memory-storage/hvals/index.md diff --git a/src/sdk/php/3/classes/memory-storage/hvals/snippets/hvals-1.php b/src/sdk/php/3/core-classes/memory-storage/hvals/snippets/hvals-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/hvals/snippets/hvals-1.php rename to src/sdk/php/3/core-classes/memory-storage/hvals/snippets/hvals-1.php diff --git a/src/sdk/php/3/classes/memory-storage/incr/index.md b/src/sdk/php/3/core-classes/memory-storage/incr/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incr/index.md rename to src/sdk/php/3/core-classes/memory-storage/incr/index.md diff --git a/src/sdk/php/3/classes/memory-storage/incr/snippets/incr-1.php b/src/sdk/php/3/core-classes/memory-storage/incr/snippets/incr-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incr/snippets/incr-1.php rename to src/sdk/php/3/core-classes/memory-storage/incr/snippets/incr-1.php diff --git a/src/sdk/php/3/classes/memory-storage/incrby/index.md b/src/sdk/php/3/core-classes/memory-storage/incrby/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incrby/index.md rename to src/sdk/php/3/core-classes/memory-storage/incrby/index.md diff --git a/src/sdk/php/3/classes/memory-storage/incrby/snippets/incrby-1.php b/src/sdk/php/3/core-classes/memory-storage/incrby/snippets/incrby-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incrby/snippets/incrby-1.php rename to src/sdk/php/3/core-classes/memory-storage/incrby/snippets/incrby-1.php diff --git a/src/sdk/php/3/classes/memory-storage/incrbyfloat/index.md b/src/sdk/php/3/core-classes/memory-storage/incrbyfloat/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incrbyfloat/index.md rename to src/sdk/php/3/core-classes/memory-storage/incrbyfloat/index.md diff --git a/src/sdk/php/3/classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.php b/src/sdk/php/3/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.php rename to src/sdk/php/3/core-classes/memory-storage/incrbyfloat/snippets/incrbyfloat-1.php diff --git a/src/sdk/php/3/classes/memory-storage/index.md b/src/sdk/php/3/core-classes/memory-storage/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/index.md rename to src/sdk/php/3/core-classes/memory-storage/index.md diff --git a/src/sdk/php/3/classes/memory-storage/keys/index.md b/src/sdk/php/3/core-classes/memory-storage/keys/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/keys/index.md rename to src/sdk/php/3/core-classes/memory-storage/keys/index.md diff --git a/src/sdk/php/3/classes/memory-storage/keys/snippets/keys-1.php b/src/sdk/php/3/core-classes/memory-storage/keys/snippets/keys-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/keys/snippets/keys-1.php rename to src/sdk/php/3/core-classes/memory-storage/keys/snippets/keys-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lindex/index.md b/src/sdk/php/3/core-classes/memory-storage/lindex/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lindex/index.md rename to src/sdk/php/3/core-classes/memory-storage/lindex/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lindex/snippets/lindex-1.php b/src/sdk/php/3/core-classes/memory-storage/lindex/snippets/lindex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lindex/snippets/lindex-1.php rename to src/sdk/php/3/core-classes/memory-storage/lindex/snippets/lindex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/linsert/index.md b/src/sdk/php/3/core-classes/memory-storage/linsert/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/linsert/index.md rename to src/sdk/php/3/core-classes/memory-storage/linsert/index.md diff --git a/src/sdk/php/3/classes/memory-storage/linsert/snippets/linsert-1.php b/src/sdk/php/3/core-classes/memory-storage/linsert/snippets/linsert-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/linsert/snippets/linsert-1.php rename to src/sdk/php/3/core-classes/memory-storage/linsert/snippets/linsert-1.php diff --git a/src/sdk/php/3/classes/memory-storage/llen/index.md b/src/sdk/php/3/core-classes/memory-storage/llen/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/llen/index.md rename to src/sdk/php/3/core-classes/memory-storage/llen/index.md diff --git a/src/sdk/php/3/classes/memory-storage/llen/snippets/llen-1.php b/src/sdk/php/3/core-classes/memory-storage/llen/snippets/llen-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/llen/snippets/llen-1.php rename to src/sdk/php/3/core-classes/memory-storage/llen/snippets/llen-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lpop/index.md b/src/sdk/php/3/core-classes/memory-storage/lpop/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpop/index.md rename to src/sdk/php/3/core-classes/memory-storage/lpop/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lpop/snippets/lpop-1.php b/src/sdk/php/3/core-classes/memory-storage/lpop/snippets/lpop-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpop/snippets/lpop-1.php rename to src/sdk/php/3/core-classes/memory-storage/lpop/snippets/lpop-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lpush/index.md b/src/sdk/php/3/core-classes/memory-storage/lpush/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpush/index.md rename to src/sdk/php/3/core-classes/memory-storage/lpush/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lpush/snippets/lpush-1.php b/src/sdk/php/3/core-classes/memory-storage/lpush/snippets/lpush-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpush/snippets/lpush-1.php rename to src/sdk/php/3/core-classes/memory-storage/lpush/snippets/lpush-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lpushx/index.md b/src/sdk/php/3/core-classes/memory-storage/lpushx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpushx/index.md rename to src/sdk/php/3/core-classes/memory-storage/lpushx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lpushx/snippets/lpushx-1.php b/src/sdk/php/3/core-classes/memory-storage/lpushx/snippets/lpushx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lpushx/snippets/lpushx-1.php rename to src/sdk/php/3/core-classes/memory-storage/lpushx/snippets/lpushx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lrange/index.md b/src/sdk/php/3/core-classes/memory-storage/lrange/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lrange/index.md rename to src/sdk/php/3/core-classes/memory-storage/lrange/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lrange/snippets/lrange-1.php b/src/sdk/php/3/core-classes/memory-storage/lrange/snippets/lrange-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lrange/snippets/lrange-1.php rename to src/sdk/php/3/core-classes/memory-storage/lrange/snippets/lrange-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lrem/index.md b/src/sdk/php/3/core-classes/memory-storage/lrem/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lrem/index.md rename to src/sdk/php/3/core-classes/memory-storage/lrem/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lrem/snippets/lrem-1.php b/src/sdk/php/3/core-classes/memory-storage/lrem/snippets/lrem-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lrem/snippets/lrem-1.php rename to src/sdk/php/3/core-classes/memory-storage/lrem/snippets/lrem-1.php diff --git a/src/sdk/php/3/classes/memory-storage/lset/index.md b/src/sdk/php/3/core-classes/memory-storage/lset/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lset/index.md rename to src/sdk/php/3/core-classes/memory-storage/lset/index.md diff --git a/src/sdk/php/3/classes/memory-storage/lset/snippets/lset-1.php b/src/sdk/php/3/core-classes/memory-storage/lset/snippets/lset-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/lset/snippets/lset-1.php rename to src/sdk/php/3/core-classes/memory-storage/lset/snippets/lset-1.php diff --git a/src/sdk/php/3/classes/memory-storage/ltrim/index.md b/src/sdk/php/3/core-classes/memory-storage/ltrim/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ltrim/index.md rename to src/sdk/php/3/core-classes/memory-storage/ltrim/index.md diff --git a/src/sdk/php/3/classes/memory-storage/ltrim/snippets/ltrim-1.php b/src/sdk/php/3/core-classes/memory-storage/ltrim/snippets/ltrim-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ltrim/snippets/ltrim-1.php rename to src/sdk/php/3/core-classes/memory-storage/ltrim/snippets/ltrim-1.php diff --git a/src/sdk/php/3/classes/memory-storage/mget/index.md b/src/sdk/php/3/core-classes/memory-storage/mget/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/mget/index.md rename to src/sdk/php/3/core-classes/memory-storage/mget/index.md diff --git a/src/sdk/php/3/classes/memory-storage/mget/snippets/mget-1.php b/src/sdk/php/3/core-classes/memory-storage/mget/snippets/mget-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/mget/snippets/mget-1.php rename to src/sdk/php/3/core-classes/memory-storage/mget/snippets/mget-1.php diff --git a/src/sdk/php/3/classes/memory-storage/mset/index.md b/src/sdk/php/3/core-classes/memory-storage/mset/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/mset/index.md rename to src/sdk/php/3/core-classes/memory-storage/mset/index.md diff --git a/src/sdk/php/3/classes/memory-storage/mset/snippets/mset-1.php b/src/sdk/php/3/core-classes/memory-storage/mset/snippets/mset-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/mset/snippets/mset-1.php rename to src/sdk/php/3/core-classes/memory-storage/mset/snippets/mset-1.php diff --git a/src/sdk/php/3/classes/memory-storage/msetnx/index.md b/src/sdk/php/3/core-classes/memory-storage/msetnx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/msetnx/index.md rename to src/sdk/php/3/core-classes/memory-storage/msetnx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/msetnx/snippets/msetnx-1.php b/src/sdk/php/3/core-classes/memory-storage/msetnx/snippets/msetnx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/msetnx/snippets/msetnx-1.php rename to src/sdk/php/3/core-classes/memory-storage/msetnx/snippets/msetnx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/object/index.md b/src/sdk/php/3/core-classes/memory-storage/object/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/object/index.md rename to src/sdk/php/3/core-classes/memory-storage/object/index.md diff --git a/src/sdk/php/3/classes/memory-storage/object/snippets/object-1.php b/src/sdk/php/3/core-classes/memory-storage/object/snippets/object-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/object/snippets/object-1.php rename to src/sdk/php/3/core-classes/memory-storage/object/snippets/object-1.php diff --git a/src/sdk/php/3/classes/memory-storage/persist/index.md b/src/sdk/php/3/core-classes/memory-storage/persist/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/persist/index.md rename to src/sdk/php/3/core-classes/memory-storage/persist/index.md diff --git a/src/sdk/php/3/classes/memory-storage/persist/snippets/persist-1.php b/src/sdk/php/3/core-classes/memory-storage/persist/snippets/persist-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/persist/snippets/persist-1.php rename to src/sdk/php/3/core-classes/memory-storage/persist/snippets/persist-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pexpire/index.md b/src/sdk/php/3/core-classes/memory-storage/pexpire/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pexpire/index.md rename to src/sdk/php/3/core-classes/memory-storage/pexpire/index.md diff --git a/src/sdk/php/3/classes/memory-storage/pexpire/snippets/pexpire-1.php b/src/sdk/php/3/core-classes/memory-storage/pexpire/snippets/pexpire-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pexpire/snippets/pexpire-1.php rename to src/sdk/php/3/core-classes/memory-storage/pexpire/snippets/pexpire-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pexpireat/index.md b/src/sdk/php/3/core-classes/memory-storage/pexpireat/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pexpireat/index.md rename to src/sdk/php/3/core-classes/memory-storage/pexpireat/index.md diff --git a/src/sdk/php/3/classes/memory-storage/pexpireat/snippets/pexpireat-1.php b/src/sdk/php/3/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pexpireat/snippets/pexpireat-1.php rename to src/sdk/php/3/core-classes/memory-storage/pexpireat/snippets/pexpireat-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pfadd/index.md b/src/sdk/php/3/core-classes/memory-storage/pfadd/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pfadd/index.md rename to src/sdk/php/3/core-classes/memory-storage/pfadd/index.md diff --git a/src/sdk/php/3/classes/memory-storage/pfadd/snippets/pfadd-1.php b/src/sdk/php/3/core-classes/memory-storage/pfadd/snippets/pfadd-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pfadd/snippets/pfadd-1.php rename to src/sdk/php/3/core-classes/memory-storage/pfadd/snippets/pfadd-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pfcount/index.md b/src/sdk/php/3/core-classes/memory-storage/pfcount/index.md similarity index 95% rename from src/sdk/php/3/classes/memory-storage/pfcount/index.md rename to src/sdk/php/3/core-classes/memory-storage/pfcount/index.md index d6e792388..d98bca11f 100644 --- a/src/sdk/php/3/classes/memory-storage/pfcount/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/pfcount/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:pfcount # pfcount -Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/php/3/classes/memory-storage/pfadd/)). +Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/php/3/core-classes/memory-storage/pfadd/)). [[_Redis documentation_]](https://redis.io/commands/pfcount) diff --git a/src/sdk/php/3/classes/memory-storage/pfcount/snippets/pfcount-1.php b/src/sdk/php/3/core-classes/memory-storage/pfcount/snippets/pfcount-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pfcount/snippets/pfcount-1.php rename to src/sdk/php/3/core-classes/memory-storage/pfcount/snippets/pfcount-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pfmerge/index.md b/src/sdk/php/3/core-classes/memory-storage/pfmerge/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pfmerge/index.md rename to src/sdk/php/3/core-classes/memory-storage/pfmerge/index.md diff --git a/src/sdk/php/3/classes/memory-storage/pfmerge/snippets/pfmerge-1.php b/src/sdk/php/3/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pfmerge/snippets/pfmerge-1.php rename to src/sdk/php/3/core-classes/memory-storage/pfmerge/snippets/pfmerge-1.php diff --git a/src/sdk/php/3/classes/memory-storage/ping/index.md b/src/sdk/php/3/core-classes/memory-storage/ping/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ping/index.md rename to src/sdk/php/3/core-classes/memory-storage/ping/index.md diff --git a/src/sdk/php/3/classes/memory-storage/ping/snippets/ping-1.php b/src/sdk/php/3/core-classes/memory-storage/ping/snippets/ping-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ping/snippets/ping-1.php rename to src/sdk/php/3/core-classes/memory-storage/ping/snippets/ping-1.php diff --git a/src/sdk/php/3/classes/memory-storage/psetex/index.md b/src/sdk/php/3/core-classes/memory-storage/psetex/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/psetex/index.md rename to src/sdk/php/3/core-classes/memory-storage/psetex/index.md diff --git a/src/sdk/php/3/classes/memory-storage/psetex/snippets/psetex-1.php b/src/sdk/php/3/core-classes/memory-storage/psetex/snippets/psetex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/psetex/snippets/psetex-1.php rename to src/sdk/php/3/core-classes/memory-storage/psetex/snippets/psetex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/pttl/index.md b/src/sdk/php/3/core-classes/memory-storage/pttl/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pttl/index.md rename to src/sdk/php/3/core-classes/memory-storage/pttl/index.md diff --git a/src/sdk/php/3/classes/memory-storage/pttl/snippets/pttl-1.php b/src/sdk/php/3/core-classes/memory-storage/pttl/snippets/pttl-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/pttl/snippets/pttl-1.php rename to src/sdk/php/3/core-classes/memory-storage/pttl/snippets/pttl-1.php diff --git a/src/sdk/php/3/classes/memory-storage/randomkey/index.md b/src/sdk/php/3/core-classes/memory-storage/randomkey/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/randomkey/index.md rename to src/sdk/php/3/core-classes/memory-storage/randomkey/index.md diff --git a/src/sdk/php/3/classes/memory-storage/randomkey/snippets/randomkey-1.php b/src/sdk/php/3/core-classes/memory-storage/randomkey/snippets/randomkey-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/randomkey/snippets/randomkey-1.php rename to src/sdk/php/3/core-classes/memory-storage/randomkey/snippets/randomkey-1.php diff --git a/src/sdk/php/3/classes/memory-storage/rename/index.md b/src/sdk/php/3/core-classes/memory-storage/rename/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rename/index.md rename to src/sdk/php/3/core-classes/memory-storage/rename/index.md diff --git a/src/sdk/php/3/classes/memory-storage/rename/snippets/rename-1.php b/src/sdk/php/3/core-classes/memory-storage/rename/snippets/rename-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rename/snippets/rename-1.php rename to src/sdk/php/3/core-classes/memory-storage/rename/snippets/rename-1.php diff --git a/src/sdk/php/3/classes/memory-storage/renamenx/index.md b/src/sdk/php/3/core-classes/memory-storage/renamenx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/renamenx/index.md rename to src/sdk/php/3/core-classes/memory-storage/renamenx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/renamenx/snippets/renamenx-1.php b/src/sdk/php/3/core-classes/memory-storage/renamenx/snippets/renamenx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/renamenx/snippets/renamenx-1.php rename to src/sdk/php/3/core-classes/memory-storage/renamenx/snippets/renamenx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/rpop/index.md b/src/sdk/php/3/core-classes/memory-storage/rpop/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpop/index.md rename to src/sdk/php/3/core-classes/memory-storage/rpop/index.md diff --git a/src/sdk/php/3/classes/memory-storage/rpop/snippets/rpop-1.php b/src/sdk/php/3/core-classes/memory-storage/rpop/snippets/rpop-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpop/snippets/rpop-1.php rename to src/sdk/php/3/core-classes/memory-storage/rpop/snippets/rpop-1.php diff --git a/src/sdk/php/3/classes/memory-storage/rpoplpush/index.md b/src/sdk/php/3/core-classes/memory-storage/rpoplpush/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpoplpush/index.md rename to src/sdk/php/3/core-classes/memory-storage/rpoplpush/index.md diff --git a/src/sdk/php/3/classes/memory-storage/rpoplpush/snippets/rpoplpush-1.php b/src/sdk/php/3/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpoplpush/snippets/rpoplpush-1.php rename to src/sdk/php/3/core-classes/memory-storage/rpoplpush/snippets/rpoplpush-1.php diff --git a/src/sdk/php/3/classes/memory-storage/rpush/index.md b/src/sdk/php/3/core-classes/memory-storage/rpush/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpush/index.md rename to src/sdk/php/3/core-classes/memory-storage/rpush/index.md diff --git a/src/sdk/php/3/classes/memory-storage/rpush/snippets/rpush-1.php b/src/sdk/php/3/core-classes/memory-storage/rpush/snippets/rpush-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpush/snippets/rpush-1.php rename to src/sdk/php/3/core-classes/memory-storage/rpush/snippets/rpush-1.php diff --git a/src/sdk/php/3/classes/memory-storage/rpushx/index.md b/src/sdk/php/3/core-classes/memory-storage/rpushx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpushx/index.md rename to src/sdk/php/3/core-classes/memory-storage/rpushx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/rpushx/snippets/rpushx-1.php b/src/sdk/php/3/core-classes/memory-storage/rpushx/snippets/rpushx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/rpushx/snippets/rpushx-1.php rename to src/sdk/php/3/core-classes/memory-storage/rpushx/snippets/rpushx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sadd/index.md b/src/sdk/php/3/core-classes/memory-storage/sadd/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sadd/index.md rename to src/sdk/php/3/core-classes/memory-storage/sadd/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sadd/snippets/sadd-1.php b/src/sdk/php/3/core-classes/memory-storage/sadd/snippets/sadd-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sadd/snippets/sadd-1.php rename to src/sdk/php/3/core-classes/memory-storage/sadd/snippets/sadd-1.php diff --git a/src/sdk/php/3/classes/memory-storage/scan/index.md b/src/sdk/php/3/core-classes/memory-storage/scan/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/scan/index.md rename to src/sdk/php/3/core-classes/memory-storage/scan/index.md diff --git a/src/sdk/php/3/classes/memory-storage/scan/snippets/scan-1.php b/src/sdk/php/3/core-classes/memory-storage/scan/snippets/scan-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/scan/snippets/scan-1.php rename to src/sdk/php/3/core-classes/memory-storage/scan/snippets/scan-1.php diff --git a/src/sdk/php/3/classes/memory-storage/scard/index.md b/src/sdk/php/3/core-classes/memory-storage/scard/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/scard/index.md rename to src/sdk/php/3/core-classes/memory-storage/scard/index.md diff --git a/src/sdk/php/3/classes/memory-storage/scard/snippets/scard-1.php b/src/sdk/php/3/core-classes/memory-storage/scard/snippets/scard-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/scard/snippets/scard-1.php rename to src/sdk/php/3/core-classes/memory-storage/scard/snippets/scard-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sdiff/index.md b/src/sdk/php/3/core-classes/memory-storage/sdiff/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sdiff/index.md rename to src/sdk/php/3/core-classes/memory-storage/sdiff/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sdiff/snippets/sdiff-1.php b/src/sdk/php/3/core-classes/memory-storage/sdiff/snippets/sdiff-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sdiff/snippets/sdiff-1.php rename to src/sdk/php/3/core-classes/memory-storage/sdiff/snippets/sdiff-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sdiffstore/index.md b/src/sdk/php/3/core-classes/memory-storage/sdiffstore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sdiffstore/index.md rename to src/sdk/php/3/core-classes/memory-storage/sdiffstore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sdiffstore/snippets/sdiffstore-1.php b/src/sdk/php/3/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sdiffstore/snippets/sdiffstore-1.php rename to src/sdk/php/3/core-classes/memory-storage/sdiffstore/snippets/sdiffstore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/set/index.md b/src/sdk/php/3/core-classes/memory-storage/set/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/set/index.md rename to src/sdk/php/3/core-classes/memory-storage/set/index.md diff --git a/src/sdk/php/3/classes/memory-storage/set/snippets/set-1.php b/src/sdk/php/3/core-classes/memory-storage/set/snippets/set-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/set/snippets/set-1.php rename to src/sdk/php/3/core-classes/memory-storage/set/snippets/set-1.php diff --git a/src/sdk/php/3/classes/memory-storage/setex/index.md b/src/sdk/php/3/core-classes/memory-storage/setex/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/setex/index.md rename to src/sdk/php/3/core-classes/memory-storage/setex/index.md diff --git a/src/sdk/php/3/classes/memory-storage/setex/snippets/setex-1.php b/src/sdk/php/3/core-classes/memory-storage/setex/snippets/setex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/setex/snippets/setex-1.php rename to src/sdk/php/3/core-classes/memory-storage/setex/snippets/setex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/setnx/index.md b/src/sdk/php/3/core-classes/memory-storage/setnx/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/setnx/index.md rename to src/sdk/php/3/core-classes/memory-storage/setnx/index.md diff --git a/src/sdk/php/3/classes/memory-storage/setnx/snippets/setnx-1.php b/src/sdk/php/3/core-classes/memory-storage/setnx/snippets/setnx-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/setnx/snippets/setnx-1.php rename to src/sdk/php/3/core-classes/memory-storage/setnx/snippets/setnx-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sinter/index.md b/src/sdk/php/3/core-classes/memory-storage/sinter/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sinter/index.md rename to src/sdk/php/3/core-classes/memory-storage/sinter/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sinter/snippets/sinter-1.php b/src/sdk/php/3/core-classes/memory-storage/sinter/snippets/sinter-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sinter/snippets/sinter-1.php rename to src/sdk/php/3/core-classes/memory-storage/sinter/snippets/sinter-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sinterstore/index.md b/src/sdk/php/3/core-classes/memory-storage/sinterstore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sinterstore/index.md rename to src/sdk/php/3/core-classes/memory-storage/sinterstore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sinterstore/snippets/sinterstore-1.php b/src/sdk/php/3/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sinterstore/snippets/sinterstore-1.php rename to src/sdk/php/3/core-classes/memory-storage/sinterstore/snippets/sinterstore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sismember/index.md b/src/sdk/php/3/core-classes/memory-storage/sismember/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sismember/index.md rename to src/sdk/php/3/core-classes/memory-storage/sismember/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sismember/snippets/sismember-1.php b/src/sdk/php/3/core-classes/memory-storage/sismember/snippets/sismember-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sismember/snippets/sismember-1.php rename to src/sdk/php/3/core-classes/memory-storage/sismember/snippets/sismember-1.php diff --git a/src/sdk/php/3/classes/memory-storage/smembers/index.md b/src/sdk/php/3/core-classes/memory-storage/smembers/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/smembers/index.md rename to src/sdk/php/3/core-classes/memory-storage/smembers/index.md diff --git a/src/sdk/php/3/classes/memory-storage/smembers/snippets/smembers-1.php b/src/sdk/php/3/core-classes/memory-storage/smembers/snippets/smembers-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/smembers/snippets/smembers-1.php rename to src/sdk/php/3/core-classes/memory-storage/smembers/snippets/smembers-1.php diff --git a/src/sdk/php/3/classes/memory-storage/smove/index.md b/src/sdk/php/3/core-classes/memory-storage/smove/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/smove/index.md rename to src/sdk/php/3/core-classes/memory-storage/smove/index.md diff --git a/src/sdk/php/3/classes/memory-storage/smove/snippets/smove-1.php b/src/sdk/php/3/core-classes/memory-storage/smove/snippets/smove-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/smove/snippets/smove-1.php rename to src/sdk/php/3/core-classes/memory-storage/smove/snippets/smove-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sort/index.md b/src/sdk/php/3/core-classes/memory-storage/sort/index.md similarity index 97% rename from src/sdk/php/3/classes/memory-storage/sort/index.md rename to src/sdk/php/3/core-classes/memory-storage/sort/index.md index 473bccfe7..ff4e1c4a1 100644 --- a/src/sdk/php/3/classes/memory-storage/sort/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/sort/index.md @@ -11,7 +11,7 @@ Sorts and returns elements contained in a list, a set of unique values or a sort By default, sorting is numeric and elements are compared by their value interpreted as double precision floating point number.
query method +While Kuzzle's API supports the "store" option for this command, Kuzzle SDK methods do not. To sort and store in the same process, use the query method
[[_Redis documentation_]](https://redis.io/commands/sort) diff --git a/src/sdk/php/3/classes/memory-storage/sort/snippets/sort-1.php b/src/sdk/php/3/core-classes/memory-storage/sort/snippets/sort-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sort/snippets/sort-1.php rename to src/sdk/php/3/core-classes/memory-storage/sort/snippets/sort-1.php diff --git a/src/sdk/php/3/classes/memory-storage/spop/index.md b/src/sdk/php/3/core-classes/memory-storage/spop/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/spop/index.md rename to src/sdk/php/3/core-classes/memory-storage/spop/index.md diff --git a/src/sdk/php/3/classes/memory-storage/spop/snippets/spop-1.php b/src/sdk/php/3/core-classes/memory-storage/spop/snippets/spop-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/spop/snippets/spop-1.php rename to src/sdk/php/3/core-classes/memory-storage/spop/snippets/spop-1.php diff --git a/src/sdk/php/3/classes/memory-storage/srandmember/index.md b/src/sdk/php/3/core-classes/memory-storage/srandmember/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/srandmember/index.md rename to src/sdk/php/3/core-classes/memory-storage/srandmember/index.md diff --git a/src/sdk/php/3/classes/memory-storage/srandmember/snippets/srandmember-1.php b/src/sdk/php/3/core-classes/memory-storage/srandmember/snippets/srandmember-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/srandmember/snippets/srandmember-1.php rename to src/sdk/php/3/core-classes/memory-storage/srandmember/snippets/srandmember-1.php diff --git a/src/sdk/php/3/classes/memory-storage/srem/index.md b/src/sdk/php/3/core-classes/memory-storage/srem/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/srem/index.md rename to src/sdk/php/3/core-classes/memory-storage/srem/index.md diff --git a/src/sdk/php/3/classes/memory-storage/srem/snippets/srem-1.php b/src/sdk/php/3/core-classes/memory-storage/srem/snippets/srem-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/srem/snippets/srem-1.php rename to src/sdk/php/3/core-classes/memory-storage/srem/snippets/srem-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sscan/index.md b/src/sdk/php/3/core-classes/memory-storage/sscan/index.md similarity index 93% rename from src/sdk/php/3/classes/memory-storage/sscan/index.md rename to src/sdk/php/3/core-classes/memory-storage/sscan/index.md index d0fa2e366..6f5d7ebb9 100644 --- a/src/sdk/php/3/classes/memory-storage/sscan/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/sscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:sscan # sscan -Identical to [scan](/sdk/php/3/classes/memory-storage/scan/), except that `sscan` iterates the members held by a set of unique values. +Identical to [scan](/sdk/php/3/core-classes/memory-storage/scan/), except that `sscan` iterates the members held by a set of unique values. [[_Redis documentation_]](https://redis.io/commands/sscan) diff --git a/src/sdk/php/3/classes/memory-storage/sscan/snippets/sscan-1.php b/src/sdk/php/3/core-classes/memory-storage/sscan/snippets/sscan-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sscan/snippets/sscan-1.php rename to src/sdk/php/3/core-classes/memory-storage/sscan/snippets/sscan-1.php diff --git a/src/sdk/php/3/classes/memory-storage/strlen/index.md b/src/sdk/php/3/core-classes/memory-storage/strlen/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/strlen/index.md rename to src/sdk/php/3/core-classes/memory-storage/strlen/index.md diff --git a/src/sdk/php/3/classes/memory-storage/strlen/snippets/strlen-1.php b/src/sdk/php/3/core-classes/memory-storage/strlen/snippets/strlen-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/strlen/snippets/strlen-1.php rename to src/sdk/php/3/core-classes/memory-storage/strlen/snippets/strlen-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sunion/index.md b/src/sdk/php/3/core-classes/memory-storage/sunion/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sunion/index.md rename to src/sdk/php/3/core-classes/memory-storage/sunion/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sunion/snippets/sunion-1.php b/src/sdk/php/3/core-classes/memory-storage/sunion/snippets/sunion-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sunion/snippets/sunion-1.php rename to src/sdk/php/3/core-classes/memory-storage/sunion/snippets/sunion-1.php diff --git a/src/sdk/php/3/classes/memory-storage/sunionstore/index.md b/src/sdk/php/3/core-classes/memory-storage/sunionstore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sunionstore/index.md rename to src/sdk/php/3/core-classes/memory-storage/sunionstore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/sunionstore/snippets/sunionstore-1.php b/src/sdk/php/3/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/sunionstore/snippets/sunionstore-1.php rename to src/sdk/php/3/core-classes/memory-storage/sunionstore/snippets/sunionstore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/time/index.md b/src/sdk/php/3/core-classes/memory-storage/time/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/time/index.md rename to src/sdk/php/3/core-classes/memory-storage/time/index.md diff --git a/src/sdk/php/3/classes/memory-storage/time/snippets/time-1.php b/src/sdk/php/3/core-classes/memory-storage/time/snippets/time-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/time/snippets/time-1.php rename to src/sdk/php/3/core-classes/memory-storage/time/snippets/time-1.php diff --git a/src/sdk/php/3/classes/memory-storage/touch/index.md b/src/sdk/php/3/core-classes/memory-storage/touch/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/touch/index.md rename to src/sdk/php/3/core-classes/memory-storage/touch/index.md diff --git a/src/sdk/php/3/classes/memory-storage/touch/snippets/touch-1.php b/src/sdk/php/3/core-classes/memory-storage/touch/snippets/touch-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/touch/snippets/touch-1.php rename to src/sdk/php/3/core-classes/memory-storage/touch/snippets/touch-1.php diff --git a/src/sdk/php/3/classes/memory-storage/ttl/index.md b/src/sdk/php/3/core-classes/memory-storage/ttl/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ttl/index.md rename to src/sdk/php/3/core-classes/memory-storage/ttl/index.md diff --git a/src/sdk/php/3/classes/memory-storage/ttl/snippets/ttl-1.php b/src/sdk/php/3/core-classes/memory-storage/ttl/snippets/ttl-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/ttl/snippets/ttl-1.php rename to src/sdk/php/3/core-classes/memory-storage/ttl/snippets/ttl-1.php diff --git a/src/sdk/php/3/classes/memory-storage/type/index.md b/src/sdk/php/3/core-classes/memory-storage/type/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/type/index.md rename to src/sdk/php/3/core-classes/memory-storage/type/index.md diff --git a/src/sdk/php/3/classes/memory-storage/type/snippets/type-1.php b/src/sdk/php/3/core-classes/memory-storage/type/snippets/type-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/type/snippets/type-1.php rename to src/sdk/php/3/core-classes/memory-storage/type/snippets/type-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zadd/index.md b/src/sdk/php/3/core-classes/memory-storage/zadd/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zadd/index.md rename to src/sdk/php/3/core-classes/memory-storage/zadd/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zadd/snippets/zadd-1.php b/src/sdk/php/3/core-classes/memory-storage/zadd/snippets/zadd-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zadd/snippets/zadd-1.php rename to src/sdk/php/3/core-classes/memory-storage/zadd/snippets/zadd-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zcard/index.md b/src/sdk/php/3/core-classes/memory-storage/zcard/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zcard/index.md rename to src/sdk/php/3/core-classes/memory-storage/zcard/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zcard/snippets/zcard-1.php b/src/sdk/php/3/core-classes/memory-storage/zcard/snippets/zcard-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zcard/snippets/zcard-1.php rename to src/sdk/php/3/core-classes/memory-storage/zcard/snippets/zcard-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zcount/index.md b/src/sdk/php/3/core-classes/memory-storage/zcount/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zcount/index.md rename to src/sdk/php/3/core-classes/memory-storage/zcount/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zcount/snippets/zcount-1.php b/src/sdk/php/3/core-classes/memory-storage/zcount/snippets/zcount-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zcount/snippets/zcount-1.php rename to src/sdk/php/3/core-classes/memory-storage/zcount/snippets/zcount-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zincrby/index.md b/src/sdk/php/3/core-classes/memory-storage/zincrby/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zincrby/index.md rename to src/sdk/php/3/core-classes/memory-storage/zincrby/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zincrby/snippets/zincrby-1.php b/src/sdk/php/3/core-classes/memory-storage/zincrby/snippets/zincrby-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zincrby/snippets/zincrby-1.php rename to src/sdk/php/3/core-classes/memory-storage/zincrby/snippets/zincrby-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zinterstore/index.md b/src/sdk/php/3/core-classes/memory-storage/zinterstore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zinterstore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zinterstore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zinterstore/snippets/zinterstore-1.php b/src/sdk/php/3/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zinterstore/snippets/zinterstore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zinterstore/snippets/zinterstore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zlexcount/index.md b/src/sdk/php/3/core-classes/memory-storage/zlexcount/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zlexcount/index.md rename to src/sdk/php/3/core-classes/memory-storage/zlexcount/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zlexcount/snippets/zlexcount-1.php b/src/sdk/php/3/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zlexcount/snippets/zlexcount-1.php rename to src/sdk/php/3/core-classes/memory-storage/zlexcount/snippets/zlexcount-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrange/index.md b/src/sdk/php/3/core-classes/memory-storage/zrange/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrange/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrange/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrange/snippets/zrange-1.php b/src/sdk/php/3/core-classes/memory-storage/zrange/snippets/zrange-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrange/snippets/zrange-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrange/snippets/zrange-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrangebylex/index.md b/src/sdk/php/3/core-classes/memory-storage/zrangebylex/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrangebylex/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrangebylex/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrangebylex/snippets/zrangebylex-1.php b/src/sdk/php/3/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrangebylex/snippets/zrangebylex-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrangebylex/snippets/zrangebylex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrangebyscore/index.md b/src/sdk/php/3/core-classes/memory-storage/zrangebyscore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrangebyscore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrangebyscore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.php b/src/sdk/php/3/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrangebyscore/snippets/zrangebyscore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrank/index.md b/src/sdk/php/3/core-classes/memory-storage/zrank/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrank/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrank/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrank/snippets/zrank-1.php b/src/sdk/php/3/core-classes/memory-storage/zrank/snippets/zrank-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrank/snippets/zrank-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrank/snippets/zrank-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrem/index.md b/src/sdk/php/3/core-classes/memory-storage/zrem/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrem/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrem/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrem/snippets/zrem-1.php b/src/sdk/php/3/core-classes/memory-storage/zrem/snippets/zrem-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrem/snippets/zrem-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrem/snippets/zrem-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebylex/index.md b/src/sdk/php/3/core-classes/memory-storage/zremrangebylex/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebylex/index.md rename to src/sdk/php/3/core-classes/memory-storage/zremrangebylex/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.php b/src/sdk/php/3/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.php rename to src/sdk/php/3/core-classes/memory-storage/zremrangebylex/snippets/zremrangebylex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebyrank/index.md b/src/sdk/php/3/core-classes/memory-storage/zremrangebyrank/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebyrank/index.md rename to src/sdk/php/3/core-classes/memory-storage/zremrangebyrank/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.php b/src/sdk/php/3/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.php rename to src/sdk/php/3/core-classes/memory-storage/zremrangebyrank/snippets/zremrangebyrank-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebyscore/index.md b/src/sdk/php/3/core-classes/memory-storage/zremrangebyscore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebyscore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zremrangebyscore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.php b/src/sdk/php/3/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zremrangebyscore/snippets/zremrangebyscore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrevrange/index.md b/src/sdk/php/3/core-classes/memory-storage/zrevrange/index.md similarity index 91% rename from src/sdk/php/3/classes/memory-storage/zrevrange/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrevrange/index.md index 366f243ca..11144ab76 100644 --- a/src/sdk/php/3/classes/memory-storage/zrevrange/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/zrevrange/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrange # zrevrange -Identical to [zrange](/sdk/php/3/classes/memory-storage/zrange/), except that the sorted set is traversed in descending order. +Identical to [zrange](/sdk/php/3/core-classes/memory-storage/zrange/), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrange) diff --git a/src/sdk/php/3/classes/memory-storage/zrevrange/snippets/zrevrange-1.php b/src/sdk/php/3/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrevrange/snippets/zrevrange-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrevrange/snippets/zrevrange-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrevrangebylex/index.md b/src/sdk/php/3/core-classes/memory-storage/zrevrangebylex/index.md similarity index 92% rename from src/sdk/php/3/classes/memory-storage/zrevrangebylex/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrevrangebylex/index.md index 20f2bc135..700a6cabc 100644 --- a/src/sdk/php/3/classes/memory-storage/zrevrangebylex/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/zrevrangebylex/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebylex # zrevrangebylex -Identical to [zrangebylex](/sdk/php/3/classes/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. +Identical to [zrangebylex](/sdk/php/3/core-classes/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebylex) diff --git a/src/sdk/php/3/classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.php b/src/sdk/php/3/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrevrangebylex/snippets/zrevrangebylex-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrevrangebyscore/index.md b/src/sdk/php/3/core-classes/memory-storage/zrevrangebyscore/index.md similarity index 92% rename from src/sdk/php/3/classes/memory-storage/zrevrangebyscore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrevrangebyscore/index.md index e5fdc85b2..f4f808d5e 100644 --- a/src/sdk/php/3/classes/memory-storage/zrevrangebyscore/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/zrevrangebyscore/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebyscore # zrevrangebyscore -Identical to [zrangebyscore](/sdk/php/3/classes/memory-storage/zrangebyscore/) except that the sorted set is traversed in descending order. +Identical to [zrangebyscore](/sdk/php/3/core-classes/memory-storage/zrangebyscore/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) diff --git a/src/sdk/php/3/classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.php b/src/sdk/php/3/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrevrangebyscore/snippets/zrevrangebyscore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zrevrank/index.md b/src/sdk/php/3/core-classes/memory-storage/zrevrank/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrevrank/index.md rename to src/sdk/php/3/core-classes/memory-storage/zrevrank/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zrevrank/snippets/zrevrank-1.php b/src/sdk/php/3/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zrevrank/snippets/zrevrank-1.php rename to src/sdk/php/3/core-classes/memory-storage/zrevrank/snippets/zrevrank-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zscan/index.md b/src/sdk/php/3/core-classes/memory-storage/zscan/index.md similarity index 93% rename from src/sdk/php/3/classes/memory-storage/zscan/index.md rename to src/sdk/php/3/core-classes/memory-storage/zscan/index.md index 81f523354..2269b7c0c 100644 --- a/src/sdk/php/3/classes/memory-storage/zscan/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/zscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zscan # zscan -Identical to [scan](/sdk/php/3/classes/memory-storage/scan/), except that `zscan` iterates the members held by a sorted set. +Identical to [scan](/sdk/php/3/core-classes/memory-storage/scan/), except that `zscan` iterates the members held by a sorted set. [[_Redis documentation_]](https://redis.io/commands/zscan) diff --git a/src/sdk/php/3/classes/memory-storage/zscan/snippets/zscan-1.php b/src/sdk/php/3/core-classes/memory-storage/zscan/snippets/zscan-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zscan/snippets/zscan-1.php rename to src/sdk/php/3/core-classes/memory-storage/zscan/snippets/zscan-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zscore/index.md b/src/sdk/php/3/core-classes/memory-storage/zscore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zscore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zscore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zscore/snippets/zscore-1.php b/src/sdk/php/3/core-classes/memory-storage/zscore/snippets/zscore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zscore/snippets/zscore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zscore/snippets/zscore-1.php diff --git a/src/sdk/php/3/classes/memory-storage/zunionstore/index.md b/src/sdk/php/3/core-classes/memory-storage/zunionstore/index.md similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zunionstore/index.md rename to src/sdk/php/3/core-classes/memory-storage/zunionstore/index.md diff --git a/src/sdk/php/3/classes/memory-storage/zunionstore/snippets/zunionstore-1.php b/src/sdk/php/3/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.php similarity index 100% rename from src/sdk/php/3/classes/memory-storage/zunionstore/snippets/zunionstore-1.php rename to src/sdk/php/3/core-classes/memory-storage/zunionstore/snippets/zunionstore-1.php diff --git a/src/sdk/php/3/classes/profile/add-policy/index.md b/src/sdk/php/3/core-classes/profile/add-policy/index.md similarity index 92% rename from src/sdk/php/3/classes/profile/add-policy/index.md rename to src/sdk/php/3/core-classes/profile/add-policy/index.md index 44bff2719..0962d4418 100644 --- a/src/sdk/php/3/classes/profile/add-policy/index.md +++ b/src/sdk/php/3/core-classes/profile/add-policy/index.md @@ -10,7 +10,7 @@ description: Profile:addPolicy Adds a role to the security profile.
-Updating a security profile will have no impact until the save method is called +Updating a security profile will have no impact until the save method is called
--- diff --git a/src/sdk/php/3/classes/profile/constructor/index.md b/src/sdk/php/3/core-classes/profile/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/constructor/index.md rename to src/sdk/php/3/core-classes/profile/constructor/index.md diff --git a/src/sdk/php/3/classes/profile/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/profile/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/profile/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/profile/delete/index.md b/src/sdk/php/3/core-classes/profile/delete/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/delete/index.md rename to src/sdk/php/3/core-classes/profile/delete/index.md diff --git a/src/sdk/php/3/classes/profile/delete/snippets/delete-1.php b/src/sdk/php/3/core-classes/profile/delete/snippets/delete-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/delete/snippets/delete-1.php rename to src/sdk/php/3/core-classes/profile/delete/snippets/delete-1.php diff --git a/src/sdk/php/3/classes/profile/get-policies/index.md b/src/sdk/php/3/core-classes/profile/get-policies/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/get-policies/index.md rename to src/sdk/php/3/core-classes/profile/get-policies/index.md diff --git a/src/sdk/php/3/classes/profile/get-policies/snippets/get-policies-1.php b/src/sdk/php/3/core-classes/profile/get-policies/snippets/get-policies-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/get-policies/snippets/get-policies-1.php rename to src/sdk/php/3/core-classes/profile/get-policies/snippets/get-policies-1.php diff --git a/src/sdk/php/3/classes/profile/index.md b/src/sdk/php/3/core-classes/profile/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/index.md rename to src/sdk/php/3/core-classes/profile/index.md diff --git a/src/sdk/php/3/classes/profile/save/index.md b/src/sdk/php/3/core-classes/profile/save/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/save/index.md rename to src/sdk/php/3/core-classes/profile/save/index.md diff --git a/src/sdk/php/3/classes/profile/save/snippets/save-1.php b/src/sdk/php/3/core-classes/profile/save/snippets/save-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/save/snippets/save-1.php rename to src/sdk/php/3/core-classes/profile/save/snippets/save-1.php diff --git a/src/sdk/php/3/classes/profile/set-content/index.md b/src/sdk/php/3/core-classes/profile/set-content/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/set-content/index.md rename to src/sdk/php/3/core-classes/profile/set-content/index.md diff --git a/src/sdk/php/3/classes/profile/set-content/snippets/set-content-1.php b/src/sdk/php/3/core-classes/profile/set-content/snippets/set-content-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/set-content/snippets/set-content-1.php rename to src/sdk/php/3/core-classes/profile/set-content/snippets/set-content-1.php diff --git a/src/sdk/php/3/classes/profile/set-policies/index.md b/src/sdk/php/3/core-classes/profile/set-policies/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/set-policies/index.md rename to src/sdk/php/3/core-classes/profile/set-policies/index.md diff --git a/src/sdk/php/3/classes/profile/update/index.md b/src/sdk/php/3/core-classes/profile/update/index.md similarity index 100% rename from src/sdk/php/3/classes/profile/update/index.md rename to src/sdk/php/3/core-classes/profile/update/index.md diff --git a/src/sdk/php/3/classes/profile/update/snippets/update-1.php b/src/sdk/php/3/core-classes/profile/update/snippets/update-1.php similarity index 100% rename from src/sdk/php/3/classes/profile/update/snippets/update-1.php rename to src/sdk/php/3/core-classes/profile/update/snippets/update-1.php diff --git a/src/sdk/php/3/classes/role/constructor/index.md b/src/sdk/php/3/core-classes/role/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/role/constructor/index.md rename to src/sdk/php/3/core-classes/role/constructor/index.md diff --git a/src/sdk/php/3/classes/role/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/role/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/role/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/role/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/role/delete/index.md b/src/sdk/php/3/core-classes/role/delete/index.md similarity index 100% rename from src/sdk/php/3/classes/role/delete/index.md rename to src/sdk/php/3/core-classes/role/delete/index.md diff --git a/src/sdk/php/3/classes/role/delete/snippets/delete-1.php b/src/sdk/php/3/core-classes/role/delete/snippets/delete-1.php similarity index 100% rename from src/sdk/php/3/classes/role/delete/snippets/delete-1.php rename to src/sdk/php/3/core-classes/role/delete/snippets/delete-1.php diff --git a/src/sdk/php/3/classes/role/index.md b/src/sdk/php/3/core-classes/role/index.md similarity index 100% rename from src/sdk/php/3/classes/role/index.md rename to src/sdk/php/3/core-classes/role/index.md diff --git a/src/sdk/php/3/classes/role/save/index.md b/src/sdk/php/3/core-classes/role/save/index.md similarity index 100% rename from src/sdk/php/3/classes/role/save/index.md rename to src/sdk/php/3/core-classes/role/save/index.md diff --git a/src/sdk/php/3/classes/role/save/snippets/save-1.php b/src/sdk/php/3/core-classes/role/save/snippets/save-1.php similarity index 100% rename from src/sdk/php/3/classes/role/save/snippets/save-1.php rename to src/sdk/php/3/core-classes/role/save/snippets/save-1.php diff --git a/src/sdk/php/3/classes/role/set-content/index.md b/src/sdk/php/3/core-classes/role/set-content/index.md similarity index 88% rename from src/sdk/php/3/classes/role/set-content/index.md rename to src/sdk/php/3/core-classes/role/set-content/index.md index 8abfdd726..3e3e5b302 100644 --- a/src/sdk/php/3/classes/role/set-content/index.md +++ b/src/sdk/php/3/core-classes/role/set-content/index.md @@ -10,7 +10,7 @@ description: Role:setContent Replaces the content of the `Role` object.
-Updating a role content will have no impact until the save method is called +Updating a role content will have no impact until the save method is called
--- diff --git a/src/sdk/php/3/classes/role/set-content/snippets/set-content-1.php b/src/sdk/php/3/core-classes/role/set-content/snippets/set-content-1.php similarity index 100% rename from src/sdk/php/3/classes/role/set-content/snippets/set-content-1.php rename to src/sdk/php/3/core-classes/role/set-content/snippets/set-content-1.php diff --git a/src/sdk/php/3/classes/role/update/index.md b/src/sdk/php/3/core-classes/role/update/index.md similarity index 90% rename from src/sdk/php/3/classes/role/update/index.md rename to src/sdk/php/3/core-classes/role/update/index.md index 098779b52..456f73110 100644 --- a/src/sdk/php/3/classes/role/update/index.md +++ b/src/sdk/php/3/core-classes/role/update/index.md @@ -15,7 +15,7 @@ Updates the role object in Kuzzle. In other words, you always need to provide the complete role definition in the updateContent object.

- This method has the same effect as calling setContent followed by the save method. + This method has the same effect as calling setContent followed by the save method.

diff --git a/src/sdk/php/3/classes/role/update/snippets/update-1.php b/src/sdk/php/3/core-classes/role/update/snippets/update-1.php similarity index 100% rename from src/sdk/php/3/classes/role/update/snippets/update-1.php rename to src/sdk/php/3/core-classes/role/update/snippets/update-1.php diff --git a/src/sdk/php/3/classes/search-result/constructor/index.md b/src/sdk/php/3/core-classes/search-result/constructor/index.md similarity index 90% rename from src/sdk/php/3/classes/search-result/constructor/index.md rename to src/sdk/php/3/core-classes/search-result/constructor/index.md index a690f80e2..d73231909 100644 --- a/src/sdk/php/3/classes/search-result/constructor/index.md +++ b/src/sdk/php/3/core-classes/search-result/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructor -This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/php/3/classes/collection/search) or a [scroll](/sdk/php/3/classes/collection/scroll) request. +This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/php/3/core-classes/collection/search) or a [scroll](/sdk/php/3/core-classes/collection/scroll) request. --- diff --git a/src/sdk/php/3/classes/search-result/fetch-next/index.md b/src/sdk/php/3/core-classes/search-result/fetch-next/index.md similarity index 100% rename from src/sdk/php/3/classes/search-result/fetch-next/index.md rename to src/sdk/php/3/core-classes/search-result/fetch-next/index.md diff --git a/src/sdk/php/3/classes/search-result/fetch-next/snippets/fetch-next-1.php b/src/sdk/php/3/core-classes/search-result/fetch-next/snippets/fetch-next-1.php similarity index 100% rename from src/sdk/php/3/classes/search-result/fetch-next/snippets/fetch-next-1.php rename to src/sdk/php/3/core-classes/search-result/fetch-next/snippets/fetch-next-1.php diff --git a/src/sdk/php/3/classes/search-result/fetch-next/snippets/fetch-next-2.php b/src/sdk/php/3/core-classes/search-result/fetch-next/snippets/fetch-next-2.php similarity index 100% rename from src/sdk/php/3/classes/search-result/fetch-next/snippets/fetch-next-2.php rename to src/sdk/php/3/core-classes/search-result/fetch-next/snippets/fetch-next-2.php diff --git a/src/sdk/php/3/classes/search-result/index.md b/src/sdk/php/3/core-classes/search-result/index.md similarity index 100% rename from src/sdk/php/3/classes/search-result/index.md rename to src/sdk/php/3/core-classes/search-result/index.md diff --git a/src/sdk/php/3/classes/security/constructor/index.md b/src/sdk/php/3/core-classes/security/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/security/constructor/index.md rename to src/sdk/php/3/core-classes/security/constructor/index.md diff --git a/src/sdk/php/3/classes/security/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/security/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/security/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/security/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/security/create-credentials/index.md b/src/sdk/php/3/core-classes/security/create-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/create-credentials/index.md rename to src/sdk/php/3/core-classes/security/create-credentials/index.md diff --git a/src/sdk/php/3/classes/security/create-credentials/snippets/create-credentials-1.php b/src/sdk/php/3/core-classes/security/create-credentials/snippets/create-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/create-credentials/snippets/create-credentials-1.php rename to src/sdk/php/3/core-classes/security/create-credentials/snippets/create-credentials-1.php diff --git a/src/sdk/php/3/classes/security/create-profile/index.md b/src/sdk/php/3/core-classes/security/create-profile/index.md similarity index 100% rename from src/sdk/php/3/classes/security/create-profile/index.md rename to src/sdk/php/3/core-classes/security/create-profile/index.md diff --git a/src/sdk/php/3/classes/security/create-profile/snippets/create-profile-1.php b/src/sdk/php/3/core-classes/security/create-profile/snippets/create-profile-1.php similarity index 100% rename from src/sdk/php/3/classes/security/create-profile/snippets/create-profile-1.php rename to src/sdk/php/3/core-classes/security/create-profile/snippets/create-profile-1.php diff --git a/src/sdk/php/3/classes/security/create-restricted-user/index.md b/src/sdk/php/3/core-classes/security/create-restricted-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/create-restricted-user/index.md rename to src/sdk/php/3/core-classes/security/create-restricted-user/index.md diff --git a/src/sdk/php/3/classes/security/create-restricted-user/snippets/create-restricted-user-1.php b/src/sdk/php/3/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/create-restricted-user/snippets/create-restricted-user-1.php rename to src/sdk/php/3/core-classes/security/create-restricted-user/snippets/create-restricted-user-1.php diff --git a/src/sdk/php/3/classes/security/create-role/index.md b/src/sdk/php/3/core-classes/security/create-role/index.md similarity index 100% rename from src/sdk/php/3/classes/security/create-role/index.md rename to src/sdk/php/3/core-classes/security/create-role/index.md diff --git a/src/sdk/php/3/classes/security/create-role/snippets/create-role-1.php b/src/sdk/php/3/core-classes/security/create-role/snippets/create-role-1.php similarity index 100% rename from src/sdk/php/3/classes/security/create-role/snippets/create-role-1.php rename to src/sdk/php/3/core-classes/security/create-role/snippets/create-role-1.php diff --git a/src/sdk/php/3/classes/security/create-user/index.md b/src/sdk/php/3/core-classes/security/create-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/create-user/index.md rename to src/sdk/php/3/core-classes/security/create-user/index.md diff --git a/src/sdk/php/3/classes/security/create-user/snippets/create-user-1.php b/src/sdk/php/3/core-classes/security/create-user/snippets/create-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/create-user/snippets/create-user-1.php rename to src/sdk/php/3/core-classes/security/create-user/snippets/create-user-1.php diff --git a/src/sdk/php/3/classes/security/delete-credentials/index.md b/src/sdk/php/3/core-classes/security/delete-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/delete-credentials/index.md rename to src/sdk/php/3/core-classes/security/delete-credentials/index.md diff --git a/src/sdk/php/3/classes/security/delete-credentials/snippets/delete-credentials-1.php b/src/sdk/php/3/core-classes/security/delete-credentials/snippets/delete-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/delete-credentials/snippets/delete-credentials-1.php rename to src/sdk/php/3/core-classes/security/delete-credentials/snippets/delete-credentials-1.php diff --git a/src/sdk/php/3/classes/security/delete-profile/index.md b/src/sdk/php/3/core-classes/security/delete-profile/index.md similarity index 100% rename from src/sdk/php/3/classes/security/delete-profile/index.md rename to src/sdk/php/3/core-classes/security/delete-profile/index.md diff --git a/src/sdk/php/3/classes/security/delete-profile/snippets/delete-profile-1.php b/src/sdk/php/3/core-classes/security/delete-profile/snippets/delete-profile-1.php similarity index 100% rename from src/sdk/php/3/classes/security/delete-profile/snippets/delete-profile-1.php rename to src/sdk/php/3/core-classes/security/delete-profile/snippets/delete-profile-1.php diff --git a/src/sdk/php/3/classes/security/delete-role/index.md b/src/sdk/php/3/core-classes/security/delete-role/index.md similarity index 100% rename from src/sdk/php/3/classes/security/delete-role/index.md rename to src/sdk/php/3/core-classes/security/delete-role/index.md diff --git a/src/sdk/php/3/classes/security/delete-role/snippets/delete-role-1.php b/src/sdk/php/3/core-classes/security/delete-role/snippets/delete-role-1.php similarity index 100% rename from src/sdk/php/3/classes/security/delete-role/snippets/delete-role-1.php rename to src/sdk/php/3/core-classes/security/delete-role/snippets/delete-role-1.php diff --git a/src/sdk/php/3/classes/security/delete-user/index.md b/src/sdk/php/3/core-classes/security/delete-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/delete-user/index.md rename to src/sdk/php/3/core-classes/security/delete-user/index.md diff --git a/src/sdk/php/3/classes/security/delete-user/snippets/delete-user-1.php b/src/sdk/php/3/core-classes/security/delete-user/snippets/delete-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/delete-user/snippets/delete-user-1.php rename to src/sdk/php/3/core-classes/security/delete-user/snippets/delete-user-1.php diff --git a/src/sdk/php/3/classes/security/fetch-profile/index.md b/src/sdk/php/3/core-classes/security/fetch-profile/index.md similarity index 100% rename from src/sdk/php/3/classes/security/fetch-profile/index.md rename to src/sdk/php/3/core-classes/security/fetch-profile/index.md diff --git a/src/sdk/php/3/classes/security/fetch-profile/snippets/fetch-profile-1.php b/src/sdk/php/3/core-classes/security/fetch-profile/snippets/fetch-profile-1.php similarity index 100% rename from src/sdk/php/3/classes/security/fetch-profile/snippets/fetch-profile-1.php rename to src/sdk/php/3/core-classes/security/fetch-profile/snippets/fetch-profile-1.php diff --git a/src/sdk/php/3/classes/security/fetch-role/index.md b/src/sdk/php/3/core-classes/security/fetch-role/index.md similarity index 100% rename from src/sdk/php/3/classes/security/fetch-role/index.md rename to src/sdk/php/3/core-classes/security/fetch-role/index.md diff --git a/src/sdk/php/3/classes/security/fetch-role/snippets/fetch-role-1.php b/src/sdk/php/3/core-classes/security/fetch-role/snippets/fetch-role-1.php similarity index 100% rename from src/sdk/php/3/classes/security/fetch-role/snippets/fetch-role-1.php rename to src/sdk/php/3/core-classes/security/fetch-role/snippets/fetch-role-1.php diff --git a/src/sdk/php/3/classes/security/fetch-user/index.md b/src/sdk/php/3/core-classes/security/fetch-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/fetch-user/index.md rename to src/sdk/php/3/core-classes/security/fetch-user/index.md diff --git a/src/sdk/php/3/classes/security/fetch-user/snippets/fetch-user-1.php b/src/sdk/php/3/core-classes/security/fetch-user/snippets/fetch-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/fetch-user/snippets/fetch-user-1.php rename to src/sdk/php/3/core-classes/security/fetch-user/snippets/fetch-user-1.php diff --git a/src/sdk/php/3/classes/security/get-all-credential-fields/index.md b/src/sdk/php/3/core-classes/security/get-all-credential-fields/index.md similarity index 100% rename from src/sdk/php/3/classes/security/get-all-credential-fields/index.md rename to src/sdk/php/3/core-classes/security/get-all-credential-fields/index.md diff --git a/src/sdk/php/3/classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.php b/src/sdk/php/3/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.php similarity index 100% rename from src/sdk/php/3/classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.php rename to src/sdk/php/3/core-classes/security/get-all-credential-fields/snippets/get-all-credential-fields-1.php diff --git a/src/sdk/php/3/classes/security/get-credentials-fields/index.md b/src/sdk/php/3/core-classes/security/get-credentials-fields/index.md similarity index 100% rename from src/sdk/php/3/classes/security/get-credentials-fields/index.md rename to src/sdk/php/3/core-classes/security/get-credentials-fields/index.md diff --git a/src/sdk/php/3/classes/security/get-credentials-fields/snippets/get-credentials-fields-1.php b/src/sdk/php/3/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.php similarity index 100% rename from src/sdk/php/3/classes/security/get-credentials-fields/snippets/get-credentials-fields-1.php rename to src/sdk/php/3/core-classes/security/get-credentials-fields/snippets/get-credentials-fields-1.php diff --git a/src/sdk/php/3/classes/security/get-credentials/index.md b/src/sdk/php/3/core-classes/security/get-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/get-credentials/index.md rename to src/sdk/php/3/core-classes/security/get-credentials/index.md diff --git a/src/sdk/php/3/classes/security/get-credentials/snippets/get-credentials-1.php b/src/sdk/php/3/core-classes/security/get-credentials/snippets/get-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/get-credentials/snippets/get-credentials-1.php rename to src/sdk/php/3/core-classes/security/get-credentials/snippets/get-credentials-1.php diff --git a/src/sdk/php/3/classes/security/get-user-rights/index.md b/src/sdk/php/3/core-classes/security/get-user-rights/index.md similarity index 100% rename from src/sdk/php/3/classes/security/get-user-rights/index.md rename to src/sdk/php/3/core-classes/security/get-user-rights/index.md diff --git a/src/sdk/php/3/classes/security/get-user-rights/snippets/get-user-rights-1.php b/src/sdk/php/3/core-classes/security/get-user-rights/snippets/get-user-rights-1.php similarity index 100% rename from src/sdk/php/3/classes/security/get-user-rights/snippets/get-user-rights-1.php rename to src/sdk/php/3/core-classes/security/get-user-rights/snippets/get-user-rights-1.php diff --git a/src/sdk/php/3/classes/security/has-credentials/index.md b/src/sdk/php/3/core-classes/security/has-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/has-credentials/index.md rename to src/sdk/php/3/core-classes/security/has-credentials/index.md diff --git a/src/sdk/php/3/classes/security/has-credentials/snippets/has-credentials-1.php b/src/sdk/php/3/core-classes/security/has-credentials/snippets/has-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/has-credentials/snippets/has-credentials-1.php rename to src/sdk/php/3/core-classes/security/has-credentials/snippets/has-credentials-1.php diff --git a/src/sdk/php/3/classes/security/index.md b/src/sdk/php/3/core-classes/security/index.md similarity index 100% rename from src/sdk/php/3/classes/security/index.md rename to src/sdk/php/3/core-classes/security/index.md diff --git a/src/sdk/php/3/classes/security/is-action-allowed/index.md b/src/sdk/php/3/core-classes/security/is-action-allowed/index.md similarity index 88% rename from src/sdk/php/3/classes/security/is-action-allowed/index.md rename to src/sdk/php/3/core-classes/security/is-action-allowed/index.md index 51909bd29..0adb707cf 100644 --- a/src/sdk/php/3/classes/security/is-action-allowed/index.md +++ b/src/sdk/php/3/core-classes/security/is-action-allowed/index.md @@ -16,7 +16,7 @@ Specifies if an action is allowed, denied or conditional based on the rights pro An action is defined as a pair of action and controller (mandatory), plus an index and a collection(optional).
-You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`. +You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`.
--- diff --git a/src/sdk/php/3/classes/security/is-action-allowed/snippets/is-action-allowed-1.php b/src/sdk/php/3/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.php similarity index 100% rename from src/sdk/php/3/classes/security/is-action-allowed/snippets/is-action-allowed-1.php rename to src/sdk/php/3/core-classes/security/is-action-allowed/snippets/is-action-allowed-1.php diff --git a/src/sdk/php/3/classes/security/profile/index.md b/src/sdk/php/3/core-classes/security/profile/index.md similarity index 100% rename from src/sdk/php/3/classes/security/profile/index.md rename to src/sdk/php/3/core-classes/security/profile/index.md diff --git a/src/sdk/php/3/classes/security/profile/snippets/profile-1.php b/src/sdk/php/3/core-classes/security/profile/snippets/profile-1.php similarity index 100% rename from src/sdk/php/3/classes/security/profile/snippets/profile-1.php rename to src/sdk/php/3/core-classes/security/profile/snippets/profile-1.php diff --git a/src/sdk/php/3/classes/security/replace-user/index.md b/src/sdk/php/3/core-classes/security/replace-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/replace-user/index.md rename to src/sdk/php/3/core-classes/security/replace-user/index.md diff --git a/src/sdk/php/3/classes/security/replace-user/snippets/replace-user-1.php b/src/sdk/php/3/core-classes/security/replace-user/snippets/replace-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/replace-user/snippets/replace-user-1.php rename to src/sdk/php/3/core-classes/security/replace-user/snippets/replace-user-1.php diff --git a/src/sdk/php/3/classes/security/role/index.md b/src/sdk/php/3/core-classes/security/role/index.md similarity index 100% rename from src/sdk/php/3/classes/security/role/index.md rename to src/sdk/php/3/core-classes/security/role/index.md diff --git a/src/sdk/php/3/classes/security/role/snippets/role-1.php b/src/sdk/php/3/core-classes/security/role/snippets/role-1.php similarity index 100% rename from src/sdk/php/3/classes/security/role/snippets/role-1.php rename to src/sdk/php/3/core-classes/security/role/snippets/role-1.php diff --git a/src/sdk/php/3/classes/security/scroll-profiles/index.md b/src/sdk/php/3/core-classes/security/scroll-profiles/index.md similarity index 100% rename from src/sdk/php/3/classes/security/scroll-profiles/index.md rename to src/sdk/php/3/core-classes/security/scroll-profiles/index.md diff --git a/src/sdk/php/3/classes/security/scroll-profiles/snippets/scroll-profiles-1.php b/src/sdk/php/3/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.php similarity index 100% rename from src/sdk/php/3/classes/security/scroll-profiles/snippets/scroll-profiles-1.php rename to src/sdk/php/3/core-classes/security/scroll-profiles/snippets/scroll-profiles-1.php diff --git a/src/sdk/php/3/classes/security/scroll-users/index.md b/src/sdk/php/3/core-classes/security/scroll-users/index.md similarity index 100% rename from src/sdk/php/3/classes/security/scroll-users/index.md rename to src/sdk/php/3/core-classes/security/scroll-users/index.md diff --git a/src/sdk/php/3/classes/security/scroll-users/snippets/scroll-users-1.php b/src/sdk/php/3/core-classes/security/scroll-users/snippets/scroll-users-1.php similarity index 100% rename from src/sdk/php/3/classes/security/scroll-users/snippets/scroll-users-1.php rename to src/sdk/php/3/core-classes/security/scroll-users/snippets/scroll-users-1.php diff --git a/src/sdk/php/3/classes/security/search-profiles/index.md b/src/sdk/php/3/core-classes/security/search-profiles/index.md similarity index 100% rename from src/sdk/php/3/classes/security/search-profiles/index.md rename to src/sdk/php/3/core-classes/security/search-profiles/index.md diff --git a/src/sdk/php/3/classes/security/search-profiles/snippets/search-profiles-1.php b/src/sdk/php/3/core-classes/security/search-profiles/snippets/search-profiles-1.php similarity index 100% rename from src/sdk/php/3/classes/security/search-profiles/snippets/search-profiles-1.php rename to src/sdk/php/3/core-classes/security/search-profiles/snippets/search-profiles-1.php diff --git a/src/sdk/php/3/classes/security/search-roles/index.md b/src/sdk/php/3/core-classes/security/search-roles/index.md similarity index 100% rename from src/sdk/php/3/classes/security/search-roles/index.md rename to src/sdk/php/3/core-classes/security/search-roles/index.md diff --git a/src/sdk/php/3/classes/security/search-roles/snippets/search-roles-1.php b/src/sdk/php/3/core-classes/security/search-roles/snippets/search-roles-1.php similarity index 100% rename from src/sdk/php/3/classes/security/search-roles/snippets/search-roles-1.php rename to src/sdk/php/3/core-classes/security/search-roles/snippets/search-roles-1.php diff --git a/src/sdk/php/3/classes/security/search-users/index.md b/src/sdk/php/3/core-classes/security/search-users/index.md similarity index 100% rename from src/sdk/php/3/classes/security/search-users/index.md rename to src/sdk/php/3/core-classes/security/search-users/index.md diff --git a/src/sdk/php/3/classes/security/search-users/snippets/search-users-1.php b/src/sdk/php/3/core-classes/security/search-users/snippets/search-users-1.php similarity index 100% rename from src/sdk/php/3/classes/security/search-users/snippets/search-users-1.php rename to src/sdk/php/3/core-classes/security/search-users/snippets/search-users-1.php diff --git a/src/sdk/php/3/classes/security/update-credentials/index.md b/src/sdk/php/3/core-classes/security/update-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/update-credentials/index.md rename to src/sdk/php/3/core-classes/security/update-credentials/index.md diff --git a/src/sdk/php/3/classes/security/update-credentials/snippets/update-credentials-1.php b/src/sdk/php/3/core-classes/security/update-credentials/snippets/update-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/update-credentials/snippets/update-credentials-1.php rename to src/sdk/php/3/core-classes/security/update-credentials/snippets/update-credentials-1.php diff --git a/src/sdk/php/3/classes/security/update-profile/index.md b/src/sdk/php/3/core-classes/security/update-profile/index.md similarity index 100% rename from src/sdk/php/3/classes/security/update-profile/index.md rename to src/sdk/php/3/core-classes/security/update-profile/index.md diff --git a/src/sdk/php/3/classes/security/update-profile/snippets/update-profile-1.php b/src/sdk/php/3/core-classes/security/update-profile/snippets/update-profile-1.php similarity index 100% rename from src/sdk/php/3/classes/security/update-profile/snippets/update-profile-1.php rename to src/sdk/php/3/core-classes/security/update-profile/snippets/update-profile-1.php diff --git a/src/sdk/php/3/classes/security/update-role/index.md b/src/sdk/php/3/core-classes/security/update-role/index.md similarity index 100% rename from src/sdk/php/3/classes/security/update-role/index.md rename to src/sdk/php/3/core-classes/security/update-role/index.md diff --git a/src/sdk/php/3/classes/security/update-role/snippets/update-role-1.php b/src/sdk/php/3/core-classes/security/update-role/snippets/update-role-1.php similarity index 100% rename from src/sdk/php/3/classes/security/update-role/snippets/update-role-1.php rename to src/sdk/php/3/core-classes/security/update-role/snippets/update-role-1.php diff --git a/src/sdk/php/3/classes/security/update-user/index.md b/src/sdk/php/3/core-classes/security/update-user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/update-user/index.md rename to src/sdk/php/3/core-classes/security/update-user/index.md diff --git a/src/sdk/php/3/classes/security/update-user/snippets/update-user-1.php b/src/sdk/php/3/core-classes/security/update-user/snippets/update-user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/update-user/snippets/update-user-1.php rename to src/sdk/php/3/core-classes/security/update-user/snippets/update-user-1.php diff --git a/src/sdk/php/3/classes/security/user/index.md b/src/sdk/php/3/core-classes/security/user/index.md similarity index 100% rename from src/sdk/php/3/classes/security/user/index.md rename to src/sdk/php/3/core-classes/security/user/index.md diff --git a/src/sdk/php/3/classes/security/user/snippets/user-1.php b/src/sdk/php/3/core-classes/security/user/snippets/user-1.php similarity index 100% rename from src/sdk/php/3/classes/security/user/snippets/user-1.php rename to src/sdk/php/3/core-classes/security/user/snippets/user-1.php diff --git a/src/sdk/php/3/classes/security/validate-credentials/index.md b/src/sdk/php/3/core-classes/security/validate-credentials/index.md similarity index 100% rename from src/sdk/php/3/classes/security/validate-credentials/index.md rename to src/sdk/php/3/core-classes/security/validate-credentials/index.md diff --git a/src/sdk/php/3/classes/security/validate-credentials/snippets/validate-credentials-1.php b/src/sdk/php/3/core-classes/security/validate-credentials/snippets/validate-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/security/validate-credentials/snippets/validate-credentials-1.php rename to src/sdk/php/3/core-classes/security/validate-credentials/snippets/validate-credentials-1.php diff --git a/src/sdk/php/3/classes/user/add-profile/index.md b/src/sdk/php/3/core-classes/user/add-profile/index.md similarity index 83% rename from src/sdk/php/3/classes/user/add-profile/index.md rename to src/sdk/php/3/core-classes/user/add-profile/index.md index 60dc8841f..511a55a26 100644 --- a/src/sdk/php/3/classes/user/add-profile/index.md +++ b/src/sdk/php/3/core-classes/user/add-profile/index.md @@ -10,7 +10,7 @@ description: User:addProfile Replaces the security profile associated with the user.
-Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called
--- diff --git a/src/sdk/php/3/classes/user/add-profile/snippets/add-profile-1.php b/src/sdk/php/3/core-classes/user/add-profile/snippets/add-profile-1.php similarity index 100% rename from src/sdk/php/3/classes/user/add-profile/snippets/add-profile-1.php rename to src/sdk/php/3/core-classes/user/add-profile/snippets/add-profile-1.php diff --git a/src/sdk/php/3/classes/user/constructor/index.md b/src/sdk/php/3/core-classes/user/constructor/index.md similarity index 100% rename from src/sdk/php/3/classes/user/constructor/index.md rename to src/sdk/php/3/core-classes/user/constructor/index.md diff --git a/src/sdk/php/3/classes/user/constructor/snippets/constructor-1.php b/src/sdk/php/3/core-classes/user/constructor/snippets/constructor-1.php similarity index 100% rename from src/sdk/php/3/classes/user/constructor/snippets/constructor-1.php rename to src/sdk/php/3/core-classes/user/constructor/snippets/constructor-1.php diff --git a/src/sdk/php/3/classes/user/create/index.md b/src/sdk/php/3/core-classes/user/create/index.md similarity index 90% rename from src/sdk/php/3/classes/user/create/index.md rename to src/sdk/php/3/core-classes/user/create/index.md index ceffb2237..5524cab12 100644 --- a/src/sdk/php/3/classes/user/create/index.md +++ b/src/sdk/php/3/core-classes/user/create/index.md @@ -7,7 +7,7 @@ description: User:create # create -Create the user in Kuzzle. Credentials can be created during the process by using [setCredentials](/sdk/php/3/classes/user/set-credentials/) beforehand. +Create the user in Kuzzle. Credentials can be created during the process by using [setCredentials](/sdk/php/3/core-classes/user/set-credentials/) beforehand. --- diff --git a/src/sdk/php/3/classes/user/create/snippets/create-1.php b/src/sdk/php/3/core-classes/user/create/snippets/create-1.php similarity index 100% rename from src/sdk/php/3/classes/user/create/snippets/create-1.php rename to src/sdk/php/3/core-classes/user/create/snippets/create-1.php diff --git a/src/sdk/php/3/classes/user/delete/index.md b/src/sdk/php/3/core-classes/user/delete/index.md similarity index 100% rename from src/sdk/php/3/classes/user/delete/index.md rename to src/sdk/php/3/core-classes/user/delete/index.md diff --git a/src/sdk/php/3/classes/user/delete/snippets/delete-1.php b/src/sdk/php/3/core-classes/user/delete/snippets/delete-1.php similarity index 100% rename from src/sdk/php/3/classes/user/delete/snippets/delete-1.php rename to src/sdk/php/3/core-classes/user/delete/snippets/delete-1.php diff --git a/src/sdk/php/3/classes/user/get-profileids/index.md b/src/sdk/php/3/core-classes/user/get-profileids/index.md similarity index 100% rename from src/sdk/php/3/classes/user/get-profileids/index.md rename to src/sdk/php/3/core-classes/user/get-profileids/index.md diff --git a/src/sdk/php/3/classes/user/get-profileids/snippets/get-profileids-1.php b/src/sdk/php/3/core-classes/user/get-profileids/snippets/get-profileids-1.php similarity index 100% rename from src/sdk/php/3/classes/user/get-profileids/snippets/get-profileids-1.php rename to src/sdk/php/3/core-classes/user/get-profileids/snippets/get-profileids-1.php diff --git a/src/sdk/php/3/classes/user/get-profiles/index.md b/src/sdk/php/3/core-classes/user/get-profiles/index.md similarity index 100% rename from src/sdk/php/3/classes/user/get-profiles/index.md rename to src/sdk/php/3/core-classes/user/get-profiles/index.md diff --git a/src/sdk/php/3/classes/user/get-profiles/snippets/get-profiles-1.php b/src/sdk/php/3/core-classes/user/get-profiles/snippets/get-profiles-1.php similarity index 100% rename from src/sdk/php/3/classes/user/get-profiles/snippets/get-profiles-1.php rename to src/sdk/php/3/core-classes/user/get-profiles/snippets/get-profiles-1.php diff --git a/src/sdk/php/3/classes/user/index.md b/src/sdk/php/3/core-classes/user/index.md similarity index 100% rename from src/sdk/php/3/classes/user/index.md rename to src/sdk/php/3/core-classes/user/index.md diff --git a/src/sdk/php/3/classes/user/replace/index.md b/src/sdk/php/3/core-classes/user/replace/index.md similarity index 100% rename from src/sdk/php/3/classes/user/replace/index.md rename to src/sdk/php/3/core-classes/user/replace/index.md diff --git a/src/sdk/php/3/classes/user/replace/snippets/replace-1.php b/src/sdk/php/3/core-classes/user/replace/snippets/replace-1.php similarity index 100% rename from src/sdk/php/3/classes/user/replace/snippets/replace-1.php rename to src/sdk/php/3/core-classes/user/replace/snippets/replace-1.php diff --git a/src/sdk/php/3/classes/user/save-restricted/index.md b/src/sdk/php/3/core-classes/user/save-restricted/index.md similarity index 100% rename from src/sdk/php/3/classes/user/save-restricted/index.md rename to src/sdk/php/3/core-classes/user/save-restricted/index.md diff --git a/src/sdk/php/3/classes/user/save-restricted/snippets/save-restricted-1.php b/src/sdk/php/3/core-classes/user/save-restricted/snippets/save-restricted-1.php similarity index 100% rename from src/sdk/php/3/classes/user/save-restricted/snippets/save-restricted-1.php rename to src/sdk/php/3/core-classes/user/save-restricted/snippets/save-restricted-1.php diff --git a/src/sdk/php/3/classes/user/save/index.md b/src/sdk/php/3/core-classes/user/save/index.md similarity index 100% rename from src/sdk/php/3/classes/user/save/index.md rename to src/sdk/php/3/core-classes/user/save/index.md diff --git a/src/sdk/php/3/classes/user/save/snippets/save-1.php b/src/sdk/php/3/core-classes/user/save/snippets/save-1.php similarity index 100% rename from src/sdk/php/3/classes/user/save/snippets/save-1.php rename to src/sdk/php/3/core-classes/user/save/snippets/save-1.php diff --git a/src/sdk/php/3/classes/user/set-content/index.md b/src/sdk/php/3/core-classes/user/set-content/index.md similarity index 76% rename from src/sdk/php/3/classes/user/set-content/index.md rename to src/sdk/php/3/core-classes/user/set-content/index.md index 6c720edd2..d9e2fe707 100644 --- a/src/sdk/php/3/classes/user/set-content/index.md +++ b/src/sdk/php/3/core-classes/user/set-content/index.md @@ -10,7 +10,7 @@ description: User:setContent Replaces the content of User.
-Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called
--- diff --git a/src/sdk/php/3/classes/user/set-content/snippets/set-content-1.php b/src/sdk/php/3/core-classes/user/set-content/snippets/set-content-1.php similarity index 100% rename from src/sdk/php/3/classes/user/set-content/snippets/set-content-1.php rename to src/sdk/php/3/core-classes/user/set-content/snippets/set-content-1.php diff --git a/src/sdk/php/3/classes/user/set-credentials/index.md b/src/sdk/php/3/core-classes/user/set-credentials/index.md similarity index 90% rename from src/sdk/php/3/classes/user/set-credentials/index.md rename to src/sdk/php/3/core-classes/user/set-credentials/index.md index a8be330f3..a594ae9c2 100644 --- a/src/sdk/php/3/classes/user/set-credentials/index.md +++ b/src/sdk/php/3/core-classes/user/set-credentials/index.md @@ -10,7 +10,7 @@ description: User:setCredentials Sets the user's credentials.
- Updating user credentials will have no impact until the create method is called.
+ Updating user credentials will have no impact until the create method is called.
The credentials to send depend on the authentication plugin and the strategy you want to create credentials for.
--- diff --git a/src/sdk/php/3/classes/user/set-credentials/snippets/set-credentials-1.php b/src/sdk/php/3/core-classes/user/set-credentials/snippets/set-credentials-1.php similarity index 100% rename from src/sdk/php/3/classes/user/set-credentials/snippets/set-credentials-1.php rename to src/sdk/php/3/core-classes/user/set-credentials/snippets/set-credentials-1.php diff --git a/src/sdk/php/3/classes/user/set-profiles/index.md b/src/sdk/php/3/core-classes/user/set-profiles/index.md similarity index 100% rename from src/sdk/php/3/classes/user/set-profiles/index.md rename to src/sdk/php/3/core-classes/user/set-profiles/index.md diff --git a/src/sdk/php/3/classes/user/set-profiles/snippets/set-profiles-1.php b/src/sdk/php/3/core-classes/user/set-profiles/snippets/set-profiles-1.php similarity index 100% rename from src/sdk/php/3/classes/user/set-profiles/snippets/set-profiles-1.php rename to src/sdk/php/3/core-classes/user/set-profiles/snippets/set-profiles-1.php diff --git a/src/sdk/php/3/classes/user/update/index.md b/src/sdk/php/3/core-classes/user/update/index.md similarity index 100% rename from src/sdk/php/3/classes/user/update/index.md rename to src/sdk/php/3/core-classes/user/update/index.md diff --git a/src/sdk/php/3/classes/user/update/snippets/update-1.php b/src/sdk/php/3/core-classes/user/update/snippets/update-1.php similarity index 100% rename from src/sdk/php/3/classes/user/update/snippets/update-1.php rename to src/sdk/php/3/core-classes/user/update/snippets/update-1.php diff --git a/src/sdk/php/3/essentials/handling-errors/index.md b/src/sdk/php/3/essentials/error-handling/index.md similarity index 100% rename from src/sdk/php/3/essentials/handling-errors/index.md rename to src/sdk/php/3/essentials/error-handling/index.md diff --git a/src/sdk/php/3/essentials/handling-errors/snippets/handling-errors-1.php b/src/sdk/php/3/essentials/error-handling/snippets/handling-errors-1.php similarity index 100% rename from src/sdk/php/3/essentials/handling-errors/snippets/handling-errors-1.php rename to src/sdk/php/3/essentials/error-handling/snippets/handling-errors-1.php diff --git a/src/sdk/php/3/essentials/events/index.md b/src/sdk/php/3/essentials/events/index.md index d7cb3fbac..06e92a528 100644 --- a/src/sdk/php/3/essentials/events/index.md +++ b/src/sdk/php/3/essentials/events/index.md @@ -7,7 +7,7 @@ order: 200 # Events -The [Kuzzle instance](/sdk/php/3/kuzzle/) periodically emits named events that provide useful updates about the state of the Kuzzle client. To subscribe to these events, use the [addListener](/sdk/php/3/classes/kuzzle/add-listener/) function and specify the event name and the callback function that will be executed when the event is emitted. To unsubscribe to an event, use the [removeListener](/sdk/php/3/classes/kuzzle/remove-listener/) function, specifying the name of the event to remove. +The [Kuzzle instance](/sdk/php/3/kuzzle/) periodically emits named events that provide useful updates about the state of the Kuzzle client. To subscribe to these events, use the [addListener](/sdk/php/3/core-classes/kuzzle/add-listener/) function and specify the event name and the callback function that will be executed when the event is emitted. To unsubscribe to an event, use the [removeListener](/sdk/php/3/core-classes/kuzzle/remove-listener/) function, specifying the name of the event to remove. --- From fffa6738bfb8792b7b02f16816554ebbcb73f1cf Mon Sep 17 00:00:00 2001 From: Aschen Date: Mon, 3 Jun 2019 11:41:01 +0200 Subject: [PATCH 03/10] Fix dead links --- README.md | 16 +++--- check_link.rb | 43 ++++++++-------- .../public/logos/extend-sdk/index.md | 26 +++++----- .../1/api/controllers/admin/dump/index.md | 6 +-- .../controllers/admin/reset-cache/index.md | 2 +- .../auth/get-current-user/index.md | 4 +- .../1/api/controllers/auth/login/index.md | 10 ++-- .../api/controllers/auth/update-self/index.md | 4 +- .../1/api/controllers/bulk/import/index.md | 2 +- .../controllers/collection/create/index.md | 14 +++--- .../collection/get-mapping/index.md | 4 +- .../collection/scroll-specifications/index.md | 4 +- .../collection/search-specifications/index.md | 2 +- .../collection/update-mapping/index.md | 10 ++-- .../1/api/controllers/document/count/index.md | 2 +- .../1/api/controllers/document/get/index.md | 2 +- .../1/api/controllers/document/m-get/index.md | 2 +- .../api/controllers/document/scroll/index.md | 2 +- .../api/controllers/document/search/index.md | 4 +- .../1/api/controllers/index/create/index.md | 2 +- .../1/api/controllers/index/delete/index.md | 2 +- .../memory-storage/geodist/index.md | 2 +- .../memory-storage/geohash/index.md | 2 +- .../memory-storage/geopos/index.md | 2 +- .../memory-storage/georadius/index.md | 2 +- .../memory-storage/georadiusbymember/index.md | 2 +- .../memory-storage/pfcount/index.md | 2 +- .../memory-storage/zrevrange/index.md | 2 +- .../memory-storage/zrevrangebylex/index.md | 2 +- .../memory-storage/zrevrangebyscore/index.md | 2 +- .../controllers/realtime/validate/index.md | 2 +- .../security/create-credentials/index.md | 2 +- .../security/create-first-admin/index.md | 2 +- .../create-or-replace-profile/index.md | 2 +- .../security/create-or-replace-role/index.md | 2 +- .../security/create-profile/index.md | 2 +- .../security/create-restricted-user/index.md | 4 +- .../controllers/security/create-role/index.md | 2 +- .../controllers/security/create-user/index.md | 2 +- .../security/delete-credentials/index.md | 2 +- .../controllers/security/delete-user/index.md | 2 +- .../security/get-credentials-by-id/index.md | 4 +- .../security/get-credentials/index.md | 2 +- .../security/get-user-rights/index.md | 2 +- .../controllers/security/get-user/index.md | 2 +- .../security/has-credentials/index.md | 2 +- .../security/m-delete-users/index.md | 2 +- .../security/replace-user/index.md | 2 +- .../security/scroll-profiles/index.md | 2 +- .../security/scroll-users/index.md | 4 +- .../security/search-profiles/index.md | 2 +- .../security/search-users/index.md | 4 +- .../security/update-credentials/index.md | 2 +- .../security/update-profile/index.md | 2 +- .../controllers/security/update-role/index.md | 2 +- .../controllers/security/update-user/index.md | 2 +- .../security/validate-credentials/index.md | 2 +- .../essentials/connecting-to-kuzzle/index.md | 2 +- src/core/1/api/essentials/errors/index.md | 4 +- .../1/api/essentials/notifications/index.md | 6 +-- .../1/api/essentials/query-syntax/index.md | 4 +- .../1/api/essentials/volatile-data/index.md | 4 +- .../code-examples/dbsearch/android/index.md | 2 +- .../guides/code-examples/dbsearch/go/index.md | 2 +- .../dbsearch/introduction/index.md | 2 +- .../code-examples/geofencing/android/index.md | 2 +- .../code-examples/geofencing/go/index.md | 2 +- .../geofencing/introduction/index.md | 2 +- .../geofencing/javascript/index.md | 2 +- .../code-examples/iot/introduction/index.md | 2 +- .../pubsub/introduction/index.md | 4 +- .../datavalidation/introduction/index.md | 2 +- .../cookbooks/datavalidation/schema/index.md | 2 +- src/core/1/guides/essentials/cli/index.md | 26 +++++----- .../essentials/data-validation/index.md | 10 ++-- .../essentials/database-mappings/index.md | 22 ++++---- .../essentials/document-metadata/index.md | 6 +-- .../essentials/installing-console/index.md | 2 +- .../essentials/installing-kuzzle/index.md | 22 ++++---- .../1/guides/essentials/introduction/index.md | 8 +-- .../1/guides/essentials/persisted/index.md | 30 +++++------ src/core/1/guides/essentials/plugins/index.md | 12 ++--- .../1/guides/essentials/real-time/index.md | 4 +- .../request-and-response-format/index.md | 2 +- .../1/guides/essentials/security/index.md | 12 ++--- .../essentials/signal-handling/index.md | 2 +- .../essentials/user-authentication/index.md | 14 +++--- .../getting-started/first-steps/index.md | 8 +-- .../getting-started/running-kuzzle/index.md | 8 +-- .../guides/kuzzle-depth/architecture/index.md | 2 +- .../kuzzle-depth/authentication/index.md | 6 +-- .../kuzzle-depth/request-life-cycle/index.md | 12 ++--- .../kuzzle-depth/roles-definitions/index.md | 18 +++---- .../koncorde/essentials/introduction/index.md | 8 +-- .../essentials/getting-started/index.md | 2 +- .../1/plugins/guides/controllers/index.md | 2 +- .../plugins/guides/events/api-events/index.md | 18 +++---- .../auth-strategy-authenticated/index.md | 4 +- .../events/core-auth-strategy-added/index.md | 2 +- .../guides/events/core-overload/index.md | 2 +- .../guides/events/http-delete/index.md | 2 +- .../1/plugins/guides/events/http-get/index.md | 2 +- .../plugins/guides/events/http-head/index.md | 2 +- .../guides/events/http-options/index.md | 2 +- .../plugins/guides/events/http-patch/index.md | 2 +- .../plugins/guides/events/http-post/index.md | 2 +- .../1/plugins/guides/events/http-put/index.md | 2 +- .../guides/events/notify-dispatch/index.md | 2 +- .../guides/events/notify-document/index.md | 2 +- .../guides/events/notify-server/index.md | 2 +- .../guides/events/notify-user/index.md | 2 +- .../guides/events/plugin-events/index.md | 8 +-- .../events/request-on-authorized/index.md | 2 +- .../guides/events/request-on-error/index.md | 2 +- .../guides/events/request-on-success/index.md | 2 +- .../events/request-on-unauthorized/index.md | 2 +- .../1/plugins/guides/events/room-new/index.md | 2 +- .../guides/manual-setup/config/index.md | 2 +- .../manual-setup/init-function/index.md | 2 +- src/core/1/plugins/guides/pipes/index.md | 6 +-- .../guides/strategies/auth-functions/index.md | 50 +++++++++---------- .../guides/strategies/overview/index.md | 6 +-- .../plugin-context/accessors/execute/index.md | 2 +- .../plugin-context/accessors/sdk/index.md | 16 +++--- .../plugin-context/accessors/storage/index.md | 6 +-- .../accessors/strategies/index.md | 4 +- .../accessors/validation/index.md | 4 +- .../constructors/request/index.md | 6 +-- .../errors/partialerror/index.md | 2 +- .../plugins/plugin-context/log/intro/index.md | 4 +- .../api/context/clientconnection/index.md | 2 +- .../1/protocols/api/context/errors/index.md | 4 +- .../1/protocols/api/context/intro/index.md | 2 +- src/core/1/protocols/api/context/log/index.md | 4 +- .../1/protocols/api/context/request/index.md | 10 ++-- .../api/context/requestcontext/index.md | 6 +-- .../api/context/requestinput/index.md | 2 +- .../protocols/api/entrypoint/execute/index.md | 4 +- .../1/protocols/api/entrypoint/intro/index.md | 4 +- .../api/entrypoint/newconnection/index.md | 2 +- .../api/entrypoint/removeconnection/index.md | 2 +- .../protocols/api/methods/disconnect/index.md | 2 +- .../1/protocols/api/methods/init/index.md | 6 +-- .../api/methods/joinchannel/index.md | 2 +- .../api/methods/leavechannel/index.md | 2 +- .../1/protocols/api/methods/notify/index.md | 2 +- .../essentials/getting-started/index.md | 24 ++++----- .../protocols/native-protocols/http/index.md | 4 +- .../protocols/native-protocols/mqtt/index.md | 6 +-- .../native-protocols/socketio/index.md | 4 +- .../native-protocols/websocket/index.md | 4 +- .../collection-mapping/constructor/index.md | 4 +- .../collection/collection-mapping/index.md | 4 +- .../collection/create-document/index.md | 6 +-- .../3/core-classes/collection/create/index.md | 2 +- .../core-classes/collection/document/index.md | 4 +- .../collection/fetch-document/index.md | 4 +- .../collection/get-mapping/index.md | 4 +- .../collection/mcreate-document/index.md | 4 +- .../mcreate-or-replace-document/index.md | 4 +- .../collection/mdelete-document/index.md | 2 +- .../collection/mget-document/index.md | 2 +- .../collection/mreplace-document/index.md | 4 +- .../collection/mupdate-document/index.md | 4 +- .../collection/publish-message/index.md | 2 +- .../collection/replace-document/index.md | 4 +- .../3/core-classes/collection/room/index.md | 6 +-- .../3/core-classes/collection/scroll/index.md | 6 +-- .../3/core-classes/collection/search/index.md | 8 +-- .../collection/subscribe/index.md | 2 +- .../collection/update-document/index.md | 4 +- .../core-classes/document/subscribe/index.md | 2 +- .../3/core-classes/kuzzle/collection/index.md | 4 +- .../kuzzle/get-my-credentials/index.md | 2 +- .../3/core-classes/kuzzle/login/index.md | 4 +- .../kuzzle/memory-storage/index.md | 2 +- .../3/core-classes/kuzzle/query/index.md | 2 +- .../3/core-classes/kuzzle/security/index.md | 2 +- .../3/core-classes/kuzzle/who-am-i/index.md | 2 +- .../memory-storage/geodist/index.md | 2 +- .../memory-storage/geohash/index.md | 2 +- .../memory-storage/geopos/index.md | 2 +- .../memory-storage/georadius/index.md | 2 +- .../memory-storage/georadiusbymember/index.md | 2 +- .../memory-storage/hscan/index.md | 2 +- .../memory-storage/pfcount/index.md | 2 +- .../memory-storage/sscan/index.md | 2 +- .../memory-storage/zrevrange/index.md | 2 +- .../memory-storage/zrevrangebylex/index.md | 2 +- .../memory-storage/zrevrangebyscore/index.md | 2 +- .../memory-storage/zscan/index.md | 2 +- .../core-classes/profile/add-policy/index.md | 2 +- .../core-classes/profile/constructor/index.md | 4 +- .../3/core-classes/role/constructor/index.md | 2 +- .../3/core-classes/role/set-content/index.md | 2 +- .../3/core-classes/role/update/index.md | 4 +- .../search-result/constructor/index.md | 2 +- .../security/constructor/index.md | 2 +- .../security/create-profile/index.md | 2 +- .../security/create-restricted-user/index.md | 4 +- .../security/create-role/index.md | 2 +- .../security/create-user/index.md | 8 +-- .../security/fetch-profile/index.md | 2 +- .../core-classes/security/fetch-role/index.md | 2 +- .../core-classes/security/fetch-user/index.md | 2 +- .../security/get-user-rights/index.md | 2 +- .../security/is-action-allowed/index.md | 2 +- .../3/core-classes/security/profile/index.md | 4 +- .../security/replace-user/index.md | 2 +- .../3/core-classes/security/role/index.md | 4 +- .../security/search-users/index.md | 2 +- .../security/update-profile/index.md | 2 +- .../security/update-role/index.md | 2 +- .../security/update-user/index.md | 2 +- .../3/core-classes/security/user/index.md | 4 +- .../3/core-classes/user/add-profile/index.md | 4 +- .../3/core-classes/user/constructor/index.md | 2 +- .../3/core-classes/user/create/index.md | 2 +- .../3/core-classes/user/get-profiles/index.md | 4 +- .../3/core-classes/user/set-content/index.md | 2 +- .../user/set-credentials/index.md | 2 +- .../3/core-classes/user/set-profiles/index.md | 2 +- .../3/essentials/offline-tools/index.md | 2 +- .../realtime-notifications/index.md | 4 +- src/sdk/cpp/1/controllers/auth/login/index.md | 4 +- .../1/controllers/collection/create/index.md | 4 +- .../collection/update-mapping/index.md | 2 +- .../validate-specifications/index.md | 2 +- .../core-classes/kuzzle/add-listener/index.md | 2 +- .../core-classes/kuzzle/constructor/index.md | 6 +-- .../core-classes/kuzzle/introduction/index.md | 10 ++-- .../user-right/introduction/index.md | 2 +- .../cpp/1/core-classes/user/getters/index.md | 2 +- .../1/core-classes/user/introduction/index.md | 2 +- .../cpp/1/essentials/getting-started/index.md | 8 +-- .../protocols/websocket/add-listener/index.md | 2 +- .../protocols/websocket/constructor/index.md | 2 +- .../1/protocols/websocket/emit-event/index.md | 2 +- .../websocket/listener-count/index.md | 2 +- .../websocket/remove-listener/index.md | 2 +- .../protocol/add-listener/index.md | 2 +- .../protocol/emit-event/index.md | 2 +- .../protocol/listener-count/index.md | 2 +- .../1/virtual-classes/protocol/once/index.md | 2 +- .../protocol/remove-all-listeners/index.md | 2 +- .../protocol/remove-listener/index.md | 2 +- src/sdk/go/1/controllers/auth/login/index.md | 8 +-- .../1/controllers/collection/create/index.md | 4 +- .../collection/update-mapping/index.md | 2 +- .../collection/update-specifications/index.md | 4 +- .../validate-specifications/index.md | 2 +- .../introduction/index.md | 2 +- .../kuzzle-event-emitter/on/index.md | 2 +- .../core-structs/kuzzle/constructor/index.md | 14 +++--- src/sdk/go/1/essentials/events/index.md | 8 +-- .../go/1/essentials/getting-started/index.md | 8 +-- .../java/1/controllers/auth/login/index.md | 6 +-- .../1/controllers/collection/create/index.md | 4 +- .../collection/update-mapping/index.md | 2 +- .../collection/update-specifications/index.md | 2 +- .../validate-specifications/index.md | 2 +- .../1/essentials/getting-started/index.md | 8 +-- .../collection-mapping/constructor/index.md | 4 +- .../collection/collection-mapping/index.md | 4 +- .../collection/constructor/index.md | 2 +- .../collection/create-document/index.md | 6 +-- .../5/core-classes/collection/create/index.md | 2 +- .../core-classes/collection/document/index.md | 4 +- .../collection/fetch-document/index.md | 4 +- .../collection/get-mapping/index.md | 4 +- .../collection/mcreate-document/index.md | 4 +- .../mcreate-or-replace-document/index.md | 4 +- .../collection/mdelete-document/index.md | 2 +- .../collection/mget-document/index.md | 2 +- .../collection/mreplace-document/index.md | 4 +- .../collection/mupdate-document/index.md | 4 +- .../collection/publish-message/index.md | 2 +- .../collection/replace-document/index.md | 4 +- .../5/core-classes/collection/room/index.md | 6 +-- .../5/core-classes/collection/scroll/index.md | 6 +-- .../5/core-classes/collection/search/index.md | 8 +-- .../collection/subscribe/index.md | 2 +- .../collection/update-document/index.md | 4 +- .../core-classes/document/subscribe/index.md | 2 +- .../5/core-classes/kuzzle/collection/index.md | 4 +- .../core-classes/kuzzle/create-index/index.md | 2 +- .../5/core-classes/kuzzle/disconnect/index.md | 4 +- .../kuzzle/get-auto-refresh/index.md | 2 +- .../kuzzle/get-my-credentials/index.md | 2 +- .../js/5/core-classes/kuzzle/login/index.md | 4 +- .../kuzzle/memory-storage/index.md | 2 +- .../js/5/core-classes/kuzzle/query/index.md | 2 +- .../kuzzle/refresh-index/index.md | 4 +- .../5/core-classes/kuzzle/security/index.md | 2 +- .../kuzzle/set-auto-refresh/index.md | 2 +- .../kuzzle/start-queuing/index.md | 2 +- .../core-classes/kuzzle/stop-queuing/index.md | 2 +- .../5/core-classes/kuzzle/who-am-i/index.md | 2 +- .../memory-storage/constructor/index.md | 2 +- .../memory-storage/geodist/index.md | 2 +- .../memory-storage/geohash/index.md | 2 +- .../memory-storage/geopos/index.md | 2 +- .../memory-storage/georadius/index.md | 2 +- .../memory-storage/georadiusbymember/index.md | 2 +- .../memory-storage/hscan/index.md | 2 +- .../memory-storage/pfcount/index.md | 2 +- .../core-classes/memory-storage/sort/index.md | 2 +- .../memory-storage/sscan/index.md | 2 +- .../memory-storage/zrevrange/index.md | 2 +- .../memory-storage/zrevrangebylex/index.md | 2 +- .../memory-storage/zrevrangebyscore/index.md | 2 +- .../memory-storage/zscan/index.md | 2 +- .../core-classes/profile/add-policy/index.md | 2 +- .../core-classes/profile/constructor/index.md | 4 +- .../5/core-classes/role/constructor/index.md | 2 +- .../5/core-classes/role/set-content/index.md | 2 +- .../js/5/core-classes/role/update/index.md | 4 +- .../search-result/constructor/index.md | 2 +- .../security/constructor/index.md | 4 +- .../security/create-profile/index.md | 2 +- .../security/create-restricted-user/index.md | 4 +- .../security/create-role/index.md | 2 +- .../security/create-user/index.md | 8 +-- .../security/fetch-profile/index.md | 2 +- .../core-classes/security/fetch-role/index.md | 2 +- .../core-classes/security/fetch-user/index.md | 2 +- .../security/get-user-rights/index.md | 2 +- .../security/is-action-allowed/index.md | 2 +- .../5/core-classes/security/profile/index.md | 4 +- .../security/replace-user/index.md | 2 +- .../js/5/core-classes/security/role/index.md | 4 +- .../security/search-users/index.md | 2 +- .../security/update-profile/index.md | 2 +- .../security/update-role/index.md | 2 +- .../security/update-user/index.md | 2 +- .../js/5/core-classes/security/user/index.md | 4 +- .../5/core-classes/user/add-profile/index.md | 4 +- .../5/core-classes/user/constructor/index.md | 2 +- .../js/5/core-classes/user/create/index.md | 2 +- .../5/core-classes/user/get-profiles/index.md | 4 +- .../5/core-classes/user/set-content/index.md | 2 +- .../user/set-credentials/index.md | 2 +- .../5/core-classes/user/set-profiles/index.md | 2 +- src/sdk/js/5/essentials/events/index.md | 2 +- .../js/5/essentials/offline-tools/index.md | 14 +++--- .../realtime-notifications/index.md | 4 +- .../auth/get-current-user/index.md | 2 +- src/sdk/js/6/controllers/auth/login/index.md | 4 +- .../6/controllers/auth/refresh-token/index.md | 6 +-- .../6/controllers/auth/update-self/index.md | 4 +- .../6/controllers/collection/create/index.md | 4 +- .../collection/search-specifications/index.md | 2 +- .../collection/update-mapping/index.md | 6 +-- .../collection/update-specifications/index.md | 2 +- .../validate-specifications/index.md | 2 +- .../js/6/controllers/document/search/index.md | 2 +- .../6/controllers/ms/zrevrangebylex/index.md | 2 +- .../controllers/ms/zrevrangebyscore/index.md | 2 +- .../introduction/index.md | 8 +-- .../kuzzle-event-emitter/on/index.md | 2 +- .../kuzzle-event-emitter/once/index.md | 2 +- .../core-classes/kuzzle/add-listener/index.md | 2 +- .../core-classes/kuzzle/constructor/index.md | 6 +-- .../core-classes/kuzzle/introduction/index.md | 10 ++-- .../6/core-classes/profile/getRoles/index.md | 2 +- .../profile/introduction/index.md | 2 +- .../6/core-classes/role/introduction/index.md | 2 +- .../search-result/introduction/index.md | 2 +- .../6/core-classes/user/getProfiles/index.md | 2 +- .../6/core-classes/user/introduction/index.md | 2 +- .../6/core-classes/user/properties/index.md | 2 +- .../js/6/essentials/error-handling/index.md | 2 +- src/sdk/js/6/essentials/events/index.md | 4 +- src/sdk/js/6/essentials/extend-sdk/index.md | 26 +++++----- .../getting-started/node-js/index.md | 12 ++--- .../getting-started/raw-web/index.md | 6 +-- .../getting-started/webpack/index.md | 10 ++-- .../js/6/protocols/http/introduction/index.md | 2 +- .../protocols/socketio/introduction/index.md | 2 +- .../protocols/websocket/introduction/index.md | 2 +- .../3/core-classes/collection/create/index.md | 2 +- .../core-classes/collection/document/index.md | 2 +- .../3/core-classes/collection/scroll/index.md | 4 +- .../3/core-classes/collection/search/index.md | 4 +- .../3/core-classes/kuzzle/collection/index.md | 4 +- .../core-classes/kuzzle/create-index/index.md | 2 +- .../kuzzle/get-auto-refresh/index.md | 2 +- .../kuzzle/get-my-credentials/index.md | 2 +- .../php/3/core-classes/kuzzle/login/index.md | 4 +- .../kuzzle/memory-storage/index.md | 2 +- .../php/3/core-classes/kuzzle/query/index.md | 2 +- .../kuzzle/refresh-index/index.md | 4 +- .../3/core-classes/kuzzle/security/index.md | 2 +- .../kuzzle/set-auto-refresh/index.md | 2 +- .../kuzzle/start-queuing/index.md | 2 +- .../core-classes/kuzzle/stop-queuing/index.md | 2 +- .../3/core-classes/kuzzle/who-am-i/index.md | 2 +- .../memory-storage/constructor/index.md | 2 +- .../core-classes/profile/constructor/index.md | 4 +- .../3/core-classes/role/constructor/index.md | 2 +- .../php/3/core-classes/role/update/index.md | 2 +- .../security/constructor/index.md | 4 +- .../security/create-profile/index.md | 2 +- .../security/create-restricted-user/index.md | 4 +- .../security/create-role/index.md | 2 +- .../security/create-user/index.md | 8 +-- .../security/fetch-profile/index.md | 2 +- .../core-classes/security/fetch-role/index.md | 2 +- .../core-classes/security/fetch-user/index.md | 2 +- .../security/get-user-rights/index.md | 2 +- .../3/core-classes/security/profile/index.md | 4 +- .../security/replace-user/index.md | 2 +- .../php/3/core-classes/security/role/index.md | 4 +- .../security/search-users/index.md | 2 +- .../security/update-profile/index.md | 2 +- .../security/update-role/index.md | 2 +- .../security/update-user/index.md | 2 +- .../php/3/core-classes/security/user/index.md | 4 +- .../3/core-classes/user/add-profile/index.md | 2 +- .../3/core-classes/user/constructor/index.md | 2 +- .../3/core-classes/user/get-profiles/index.md | 4 +- .../3/core-classes/user/set-profiles/index.md | 2 +- src/sdk/php/3/essentials/events/index.md | 2 +- 423 files changed, 839 insertions(+), 836 deletions(-) diff --git a/README.md b/README.md index 44c45165e..13983b612 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Algolia can be configured via the following environment variables VuePress generates the documentation based on how the files are organized in the filesystem. For example, the URL of each page is direclty infered by its filesystem path relative to `src/`. Also, the left sidebar generation is based on the filesystem location of the files and their [frontmatter](https://v1.vuepress.vuejs.org/guide/frontmatter.html#front-matter) contents. -A page is defined by a directory (e.g. `src/core/1/api/api-reference/controller-admin/dump/`) containing an `index.md` file. This file must have a frontmatter with the following form: +A page is defined by a directory (e.g. `src/core/1/api/controllers/admin/dump/`) containing an `index.md` file. This file must have a frontmatter with the following form: ``` --- @@ -53,12 +53,12 @@ nosidebar: (optional) Defines how this page behaves in the generation of the sidebar. It is also used by other components (like Algolia indexation). Can be the following values: * `root` - The page is the root of the generation of an entire sidebar (e.g. `src/code/1/api/`); -* `branch` - The page is a branch of the sidebar and generally has no content but has children (e.g. `src/code/1/api/api-reference`, `src/code/1/api/api-reference/controller-admin/`); +* `branch` - The page is a branch of the sidebar and generally has no content but has children (e.g. `src/code/1/api/api-reference`, `src/code/1/api/controllers/admin/`); * `page` - The page is a "leaf" in the sidebar tree: it has no children and has content. It is indexed to Algolia. #### `code` (required) -A Boolean field defining whether the name of the page must be displayed in monospace typeface in the menu because it indicates the name of a function, a controller or a piece of code in general (e.g. `src/code/1/api/api-reference/controller-admin/`). +A Boolean field defining whether the name of the page must be displayed in monospace typeface in the menu because it indicates the name of a function, a controller or a piece of code in general (e.g. `src/code/1/api/controllers/admin/`). #### `title` (required) @@ -109,7 +109,7 @@ You can [import code snippets from file](https://v1.vuepress.vuejs.org/guide/mar We extended this feature by making it support relative paths. For example, if you have the following files: ``` -- /core/1/guide/guides/getting-started/first/steps/ +- /core/1/guides/getting-started/first/steps/ | +- snippets/ | | @@ -155,7 +155,7 @@ bash run-snippet-tests.sh -n -p src/sdk-reference/cpp/1/index To make a snippet testable, simply create a YML file called `.test.yml` along with the snippet file, like the following: ``` -- /core/1/guide/guides/getting-started/first/steps/ +- /core/1/guides/getting-started/first/steps/ | +- snippets/ | | @@ -179,7 +179,7 @@ expect: document created successfully ### Snippet templates -Since code snippets often lack of support and cannot be executed as-is, we use templates to recreate the context of a snippet. +Since code snippets often lack of support and cannot be executed as-is, we use templates to recreate the context of a snippet. Templates are located in `test/templates`. @@ -226,7 +226,7 @@ Example: ```bash # Create the files documenting the action 'list' of the controller 'document' for the SDK JS 6 -./scaffolding/scaffold generate src/sdk-reference/js/6/collection/list +./scaffolding/scaffold generate src/sdk-reference/js/6/controllers/collection/list ``` ### Copy an existing action from another SDK @@ -237,5 +237,5 @@ This command extracts information from an existing action in another SDK and gen Example: ```bash # Copy information from SDK JS 6 to SDK CPP 1 -./scaffolding/scaffold copy src/sdk-reference/js/6/collection/list src/sdk-reference/cpp/1/collection/list +./scaffolding/scaffold copy src/sdk-reference/js/6/controllers/collection/list src/sdk-reference/cpp/1/collection/list ``` diff --git a/check_link.rb b/check_link.rb index 5fc2a8ff3..0e17bf978 100644 --- a/check_link.rb +++ b/check_link.rb @@ -1,10 +1,12 @@ +require 'byebug' require 'json' require 'uri' require 'typhoeus' require 'optparse' class LinkChecker - INTERNAL_LINK_REGEXP = /\(\{\{\s*site_base_path\s*\}\}([^)>]+)/ + INTERNAL_LINK_REGEXP = /\[[\w\-]+\]\(([\w\/\-\#]*)\)/ + # INTERNAL_LINK_REGEXP = /\(\{\{\s*site_base_path\s*\}\}([^)>]+)/ attr_reader :internal, :external @@ -15,7 +17,7 @@ def initialize(options) @hydra = Typhoeus::Hydra.new(max_concurrency: 200) - @internal = {} + @internal = [] @external = {} end @@ -27,7 +29,7 @@ def run scan_internal_links(file_path, content) unless @only == 'external' - scan_external_links(file_path, content) unless @only == 'internal' + # scan_external_links(file_path, content) unless @only == 'internal' end puts "Checking #{@hydra.queued_requests.count} external links.." @@ -36,21 +38,21 @@ def run def report_stdout puts "Found #{@internal.count} uniq internal dead links:\n" - @internal.each do |link, pages| - puts " - #{link} found on #{pages.count} pages:" - pages.each do |page| - puts " -> #{page}" - end - puts "" - end - - puts "Found #{@external.count} uniq external dead links:\n" - @external.each do |link, pages| - puts " - #{link} found on #{pages.count} pages:" - pages.each do |page| - puts " -> #{page}" - end - end + # @internal.each do |link, pages| + # puts " - #{link} found on #{pages.count} pages:" + # pages.each do |page| + # puts " -> #{page}" + # end + # puts "" + # end + + # puts "Found #{@external.count} uniq external dead links:\n" + # @external.each do |link, pages| + # puts " - #{link} found on #{pages.count} pages:" + # pages.each do |page| + # puts " -> #{page}" + # end + # end end def report_json @@ -76,9 +78,10 @@ def scan_internal_links(file_path, content) next if File.exists?(full_path) - @internal[full_path] ||= [] - @internal[full_path] << file_path.gsub(/\/\//, '/') + @internal ||= [] + @internal << full_path# << file_path.gsub(/\/\//, '/') end + @internal.uniq! end def scan_external_links(file_path, content) diff --git a/src/.vuepress/public/logos/extend-sdk/index.md b/src/.vuepress/public/logos/extend-sdk/index.md index dccee4492..f01944793 100644 --- a/src/.vuepress/public/logos/extend-sdk/index.md +++ b/src/.vuepress/public/logos/extend-sdk/index.md @@ -8,21 +8,21 @@ order: 410 -It is possible to extend the SDK's API by adding new controllers. +It is possible to extend the SDK's API by adding new controllers. -These controllers correspond to [custom controllers created in a plugin](/plugins/1/essentials/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. +These controllers correspond to [custom controllers created in a plugin](/core/1/plugins/essentials/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. ## Define a custom SDK controller -A custom SDK controller is a class inheriting from the [BaseController](/sdk-reference/js/6/base-controller) class and defining methods matching Kuzzle API actions. +A custom SDK controller is a class inheriting from the [BaseController](/sdk/js/6/core-classes/base-controller) class and defining methods matching Kuzzle API actions. -This base class is exposed alongside the other classes of the SDK module. +This base class is exposed alongside the other classes of the SDK module. -After defining your new controller based on `BaseController`, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/kuzzle/use-controller) method. +After defining your new controller based on `BaseController`, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/core-classes/kuzzle/use-controller) method. ## Constructor -The constructor of a custom SDK controller will be called by passing the SDK instance to it. It must call the parent constructor with this instance of the SDK and its name as defined in the API. +The constructor of a custom SDK controller will be called by passing the SDK instance to it. It must call the parent constructor with this instance of the SDK and its name as defined in the API. For instance, if there is a plugin named `nyc-open-data-plugin`, extending Kuzzle's API with the following controller: @@ -34,7 +34,7 @@ this.controllers = { } ``` -Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/plugins/1/essentials/controllers/#querying-plugins-controllers) documentation): +Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/1/plugins/essentials/controllers/#querying-plugins-controllers) documentation): ```javascript const { BaseController } = require('kuzzle-sdk'); @@ -46,13 +46,13 @@ class TaxiController extends BaseController { } ``` -The controller name will then be injected into the requests sent with the [BaseController.query](/sdk-reference/js/6/base-controller/query) method. +The controller name will then be injected into the requests sent with the [BaseController.query](/sdk/js/6/core-classes/base-controller/query) method. ## Define custom SDK controller actions -Each action of your custom SDK controller is a method of the class. +Each action of your custom SDK controller is a method of the class. -These methods have to use the [BaseController.query](/sdk-reference/js/6/base-controller/query) method to invoke an API action. +These methods have to use the [BaseController.query](/sdk/js/6/core-classes/base-controller/query) method to invoke an API action. Extending the previous example, we now have: @@ -80,13 +80,13 @@ class TaxiController extends BaseController { ## Add a custom SDK controller to the SDK -Once you have defined your custom SDK controller, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/kuzzle/use-controller) method. +Once you have defined your custom SDK controller, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/core-classes/kuzzle/use-controller) method. -You can then use the actions of your plugins in the same way as the rest of the Kuzzle API by taking advantage of authentication, offline mode management, etc. +You can then use the actions of your plugins in the same way as the rest of the Kuzzle API by taking advantage of authentication, offline mode management, etc. ```javascript -const +const TaxiController = require('./taxiController'), { Kuzzle, WebSocket } = require('kuzzle-sdk'); diff --git a/src/core/1/api/controllers/admin/dump/index.md b/src/core/1/api/controllers/admin/dump/index.md index fdc8191d4..6c6745817 100644 --- a/src/core/1/api/controllers/admin/dump/index.md +++ b/src/core/1/api/controllers/admin/dump/index.md @@ -9,7 +9,7 @@ title: dump -Asynchronously create a snapshot of Kuzzle's state. +Asynchronously create a snapshot of Kuzzle's state. Depending on the configuration of Kuzzle, it may include the following: - a coredump of Kuzzle @@ -20,9 +20,9 @@ Depending on the configuration of Kuzzle, it may include the following: - plugins configuration - usage statistics of the dumped instance -(See [configuration](/core/1/guide/guides/essentials/configuration/)) +(See [configuration](/core/1/guides/essentials/configuration/)) -The generated directory can be used to feed a complete report to the support team. +The generated directory can be used to feed a complete report to the support team. This report is the same as the one generated during a crash. **Note:** in a Cluster environment, the dump action will be propagated across all nodes. diff --git a/src/core/1/api/controllers/admin/reset-cache/index.md b/src/core/1/api/controllers/admin/reset-cache/index.md index 7e369b47b..4b3f75c12 100644 --- a/src/core/1/api/controllers/admin/reset-cache/index.md +++ b/src/core/1/api/controllers/admin/reset-cache/index.md @@ -36,7 +36,7 @@ Method: POST - `database`: there are two Redis databases that you can clear - `internalCache` : used by Kuzzle to cache internal data, such as authentication tokens, documents followed by real-time subscriptions, active paginated search queries, API usage statistics or cluster state - - `memoryStorage` : memory cache managed by Kuzzle's [memoryStorage](/core/1/api/controller-memory-storage/) API + - `memoryStorage` : memory cache managed by Kuzzle's [memoryStorage](/core/1/api/controllers/memory-storage/) API --- diff --git a/src/core/1/api/controllers/auth/get-current-user/index.md b/src/core/1/api/controllers/auth/get-current-user/index.md index 5c45426dd..a24b58aa4 100644 --- a/src/core/1/api/controllers/auth/get-current-user/index.md +++ b/src/core/1/api/controllers/auth/get-current-user/index.md @@ -44,9 +44,9 @@ Headers: Authorization: "Bearer " The result contains the following properties: -- `_id`: current user's [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) +- `_id`: current user's [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) - `_source`: user information - - `profileIds`: list of [profile](/core/1/guide/guides/essentials/security/#users-profiles-and-roles) names associated to the user + - `profileIds`: list of [profile](/core/1/guides/essentials/security/#users-profiles-and-roles) names associated to the user - any other properties: additional (and optional) user information - `strategies`: available authentication strategies for that user diff --git a/src/core/1/api/controllers/auth/login/index.md b/src/core/1/api/controllers/auth/login/index.md index 251f45a90..ec79ee1d1 100644 --- a/src/core/1/api/controllers/auth/login/index.md +++ b/src/core/1/api/controllers/auth/login/index.md @@ -48,11 +48,11 @@ Body: ## Arguments -- `strategy`: the name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. +- `strategy`: the name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentication/#authentication) used to log the user in. ### Optional: -- `expiresIn`: set the expiration duration (default: depends on [Kuzzle configuration file](/core/1/guide/guides/essentials/configuration/)) +- `expiresIn`: set the expiration duration (default: depends on [Kuzzle configuration file](/core/1/guides/essentials/configuration/)) - if a raw number is provided (not enclosed between quotes), then the expiration delay is in milliseconds. Example: `86400000` - if this value is a string, then its content is parsed by the [ms](https://www.npmjs.com/package/ms) library. Examples: `"6d"`, `"10h"` @@ -60,11 +60,11 @@ Body: ## Body properties -Depending on the chosen authentication strategy, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication strategy, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/essentials/strategies/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/) documentation to get the list of additional arguments to provide. --- @@ -72,7 +72,7 @@ Check the appropriate [authentication plugin](/core/1/plugins/essentials/strateg The result contains the following properties: -- `_id`: user's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `jwt`: encrypted JSON Web Token, that must then be sent in the [requests headers](/core/1/api/essentials/query-syntax/#http-default) or in the [query](/core/1/api/essentials/query-syntax/#other-protocols-default) - `expiresAt`: token expiration date, in Epoch-millis (UTC) - `ttl`: token time to live, in milliseconds diff --git a/src/core/1/api/controllers/auth/update-self/index.md b/src/core/1/api/controllers/auth/update-self/index.md index 9c2336286..993fb2250 100644 --- a/src/core/1/api/controllers/auth/update-self/index.md +++ b/src/core/1/api/controllers/auth/update-self/index.md @@ -10,7 +10,7 @@ title: updateSelf Updates the currently logged in user information. -This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/1/api/api-reference/controller-security/update-user/) must be used instead. +This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/1/api/controllers/security/update-user/) must be used instead. --- @@ -64,7 +64,7 @@ User properties that can be set or updated depend on the application hosted by K Returns the following properties: -- `_id`: current user's [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) +- `_id`: current user's [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) - `_source`: additional (and optional) user properties ```js diff --git a/src/core/1/api/controllers/bulk/import/index.md b/src/core/1/api/controllers/bulk/import/index.md index 1a9c49edc..6d8cf0cea 100644 --- a/src/core/1/api/controllers/bulk/import/index.md +++ b/src/core/1/api/controllers/bulk/import/index.md @@ -10,7 +10,7 @@ title: import Creates, updates or deletes large amounts of documents as fast as possible. -This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/core/1/api/api-reference/controller-document/m-create/)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters. +This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/core/1/api/controllers/document/m-create/)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters. If some documents actions fail, the client will receive a [PartialError](/core/1/api/essentials/errors/#partialerror) error. diff --git a/src/core/1/api/controllers/collection/create/index.md b/src/core/1/api/controllers/collection/create/index.md index 1d38a0464..26e724ad4 100644 --- a/src/core/1/api/controllers/collection/create/index.md +++ b/src/core/1/api/controllers/collection/create/index.md @@ -6,19 +6,19 @@ title: create # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted), in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted), in the provided `index`. -You can also provide an optional body with a [collection mapping](/core/1/guide/guides/essentials/database-mappings) allowing you to exploit the full capabilities of our persistent data storage layer. +You can also provide an optional body with a [collection mapping](/core/1/guides/essentials/database-mappings) allowing you to exploit the full capabilities of our persistent data storage layer. This method will only update the mapping when the collection already exists. -You can define the collection [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. +You can define the collection [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. -You can define [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field. +You can define [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field. --- @@ -95,9 +95,9 @@ Body: ### Optional: -* `dynamic`: [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) for new fields. Allowed values: `true` (default), `false`, `strict` -* `_meta`: [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata) stored next to the collection -* `properties`: object describing the data mapping to associate to the new collection, using [Elasticsearch types definitions format](/core/1/guide/guides/essentials/database-mappings/#properties-types-definition) +* `dynamic`: [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) for new fields. Allowed values: `true` (default), `false`, `strict` +* `_meta`: [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata) stored next to the collection +* `properties`: object describing the data mapping to associate to the new collection, using [Elasticsearch types definitions format](/core/1/guides/essentials/database-mappings/#properties-types-definition) --- diff --git a/src/core/1/api/controllers/collection/get-mapping/index.md b/src/core/1/api/controllers/collection/get-mapping/index.md index ece0e4e39..5aff1a34c 100644 --- a/src/core/1/api/controllers/collection/get-mapping/index.md +++ b/src/core/1/api/controllers/collection/get-mapping/index.md @@ -8,9 +8,9 @@ title: getMapping Returns a collection mapping. -{{{/core/1/guide/guides/essentials/database-mappings "1.7.1"}}} +{{{/core/1/guides/essentials/database-mappings "1.7.1"}}} -Also returns the collection [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) and [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata). +Also returns the collection [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) and [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata). --- diff --git a/src/core/1/api/controllers/collection/scroll-specifications/index.md b/src/core/1/api/controllers/collection/scroll-specifications/index.md index 9596e1b09..808752e2b 100644 --- a/src/core/1/api/controllers/collection/scroll-specifications/index.md +++ b/src/core/1/api/controllers/collection/scroll-specifications/index.md @@ -8,7 +8,7 @@ title: scrollSpecifications -Moves a result set cursor forward, created by the [`searchSpecifications` request](/core/1/api/api-reference/controller-collection/search-specifications/) when the `scroll` argument is provided. +Moves a result set cursor forward, created by the [`searchSpecifications` request](/core/1/api/controllers/collection/search-specifications/) when the `scroll` argument is provided. Results returned by a `scroll` request reflect the state of the index at the time of the initial search request, like a fixed snapshot. Subsequent changes to documents do not affect the scroll results. @@ -40,7 +40,7 @@ Method: GET - `collection`: collection name - `index`: index name -- `scrollId`: cursor identifier, obtained with (/core/1/api/api-reference/controller-collection/search-specifications/) +- `scrollId`: cursor identifier, obtained with (/core/1/api/controllers/collection/search-specifications/) ### Optional: diff --git a/src/core/1/api/controllers/collection/search-specifications/index.md b/src/core/1/api/controllers/collection/search-specifications/index.md index a7cdda131..90a7d5693 100644 --- a/src/core/1/api/controllers/collection/search-specifications/index.md +++ b/src/core/1/api/controllers/collection/search-specifications/index.md @@ -59,7 +59,7 @@ Body: ### Optional: - `from` is usually used with the `size` argument, and defines the offset from the first result you want to fetch -- `scroll` is used to fetch large result sets, and it must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units). If set, a forward-only cursor will be created (and automatically destroyed at the end of the set duration), and its identifier will be returned in the `scrollId` property, along with the first page of the results. This cursor can then be moved forward using the [`scrollSpecifications` API action](/core/1/api/api-reference/controller-collection/scroll-specifications/) +- `scroll` is used to fetch large result sets, and it must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units). If set, a forward-only cursor will be created (and automatically destroyed at the end of the set duration), and its identifier will be returned in the `scrollId` property, along with the first page of the results. This cursor can then be moved forward using the [`scrollSpecifications` API action](/core/1/api/controllers/collection/scroll-specifications/) - `size` controls the maximum number of documents returned in the response --- diff --git a/src/core/1/api/controllers/collection/update-mapping/index.md b/src/core/1/api/controllers/collection/update-mapping/index.md index 9a541eb35..ef58285a9 100644 --- a/src/core/1/api/controllers/collection/update-mapping/index.md +++ b/src/core/1/api/controllers/collection/update-mapping/index.md @@ -10,9 +10,9 @@ Updates a collection mapping. -You can define the collection [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. +You can define the collection [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. -You can define [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field. +You can define [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field. --- @@ -87,9 +87,9 @@ Body: ## Body properties -* `dynamic`: [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) for new fields. Allowed values: `true` (default), `false`, `strict` -* `_meta`: [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata) stored next to the collection -* `properties`: object describing the data mapping to associate to the new collection, using [Elasticsearch types definitions format](/core/1/guide/guides/essentials/database-mappings/#properties-types-definition) +* `dynamic`: [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) for new fields. Allowed values: `true` (default), `false`, `strict` +* `_meta`: [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata) stored next to the collection +* `properties`: object describing the data mapping to associate to the new collection, using [Elasticsearch types definitions format](/core/1/guides/essentials/database-mappings/#properties-types-definition) --- diff --git a/src/core/1/api/controllers/document/count/index.md b/src/core/1/api/controllers/document/count/index.md index 86e6d32e2..e6acbd0b8 100644 --- a/src/core/1/api/controllers/document/count/index.md +++ b/src/core/1/api/controllers/document/count/index.md @@ -58,7 +58,7 @@ Body: ### Optional: -- `includeTrash`: include documents from the [trashcan](/core/1/guide/guides/essentials/document-metadata/) +- `includeTrash`: include documents from the [trashcan](/core/1/guides/essentials/document-metadata/) --- diff --git a/src/core/1/api/controllers/document/get/index.md b/src/core/1/api/controllers/document/get/index.md index dc912cf0f..a88e132e6 100644 --- a/src/core/1/api/controllers/document/get/index.md +++ b/src/core/1/api/controllers/document/get/index.md @@ -44,7 +44,7 @@ Method: GET ### Optional: -- `includeTrash`: if true, documents in the [trashcan](/core/1/guide/guides/essentials/document-metadata/) can be returned +- `includeTrash`: if true, documents in the [trashcan](/core/1/guides/essentials/document-metadata/) can be returned --- diff --git a/src/core/1/api/controllers/document/m-get/index.md b/src/core/1/api/controllers/document/m-get/index.md index c3f35557c..1e7b06820 100644 --- a/src/core/1/api/controllers/document/m-get/index.md +++ b/src/core/1/api/controllers/document/m-get/index.md @@ -52,7 +52,7 @@ Body: ### Optional: -- `includeTrash`: if set, documents in the [trashcan](/core/1/guide/guides/essentials/document-metadata/) can be returned. +- `includeTrash`: if set, documents in the [trashcan](/core/1/guides/essentials/document-metadata/) can be returned. --- diff --git a/src/core/1/api/controllers/document/scroll/index.md b/src/core/1/api/controllers/document/scroll/index.md index 82e767481..9bd500144 100644 --- a/src/core/1/api/controllers/document/scroll/index.md +++ b/src/core/1/api/controllers/document/scroll/index.md @@ -10,7 +10,7 @@ title: scroll Moves a search cursor forward. -A search cursor is created by a [search](/core/1/api/api-reference/controller-document/search/) API call, with a `scroll` value provided. +A search cursor is created by a [search](/core/1/api/controllers/document/search/) API call, with a `scroll` value provided. Results returned by a `scroll` request reflect the state of the index at the time of the initial search request, like a fixed snapshot. Subsequent changes to documents do not affect the scroll results. diff --git a/src/core/1/api/controllers/document/search/index.md b/src/core/1/api/controllers/document/search/index.md index 3620188a6..a0c62a1bf 100644 --- a/src/core/1/api/controllers/document/search/index.md +++ b/src/core/1/api/controllers/document/search/index.md @@ -79,8 +79,8 @@ Body: ### Optional: - `from`: paginates search results by defining the offset from the first result you want to fetch. Usually used with the `size` argument -- `includeTrash`: if true, include documents in the [trashcan](/core/1/guide/guides/essentials/document-metadata/) -- `scroll`: creates a forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` is returned in the results. This cursor can then be moved forward using the [scroll](/core/1/api/api-reference/controller-document/scroll/) API action +- `includeTrash`: if true, include documents in the [trashcan](/core/1/guides/essentials/document-metadata/) +- `scroll`: creates a forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` is returned in the results. This cursor can then be moved forward using the [scroll](/core/1/api/controllers/document/scroll/) API action - `size`: set the maximum number of documents returned per result page --- diff --git a/src/core/1/api/controllers/index/create/index.md b/src/core/1/api/controllers/index/create/index.md index c81b94ba8..7cebc0fcd 100644 --- a/src/core/1/api/controllers/index/create/index.md +++ b/src/core/1/api/controllers/index/create/index.md @@ -8,7 +8,7 @@ title: create -Creates a new [index](/core/1/guide/guides/essentials/persisted/) in Kuzzle. +Creates a new [index](/core/1/guides/essentials/persisted/) in Kuzzle. --- diff --git a/src/core/1/api/controllers/index/delete/index.md b/src/core/1/api/controllers/index/delete/index.md index c0da3d7c0..133e4bf93 100644 --- a/src/core/1/api/controllers/index/delete/index.md +++ b/src/core/1/api/controllers/index/delete/index.md @@ -8,7 +8,7 @@ title: delete -Deletes an [index](/core/1/guide/guides/essentials/persisted/). +Deletes an [index](/core/1/guides/essentials/persisted/). --- diff --git a/src/core/1/api/controllers/memory-storage/geodist/index.md b/src/core/1/api/controllers/memory-storage/geodist/index.md index 6aa8b03e3..fa7e39177 100644 --- a/src/core/1/api/controllers/memory-storage/geodist/index.md +++ b/src/core/1/api/controllers/memory-storage/geodist/index.md @@ -8,7 +8,7 @@ title: geodist -Returns the distance between two geospatial members of a key (see [geoadd](/core/1/api/api-reference/controller-memory-storage/geoadd/)). +Returns the distance between two geospatial members of a key (see [geoadd](/core/1/api/controllers/memory-storage/geoadd/)). The returned distance is expressed in meters by default. diff --git a/src/core/1/api/controllers/memory-storage/geohash/index.md b/src/core/1/api/controllers/memory-storage/geohash/index.md index bb22bbd29..8a34c473e 100644 --- a/src/core/1/api/controllers/memory-storage/geohash/index.md +++ b/src/core/1/api/controllers/memory-storage/geohash/index.md @@ -8,7 +8,7 @@ title: geohash -Converts a key's geopoints (see [geoadd](/core/1/api/api-reference/controller-memory-storage/geoadd/)) into [geohashes](https://en.wikipedia.org/wiki/Geohash). +Converts a key's geopoints (see [geoadd](/core/1/api/controllers/memory-storage/geoadd/)) into [geohashes](https://en.wikipedia.org/wiki/Geohash). [[_Redis documentation_]](https://redis.io/commands/geohash) diff --git a/src/core/1/api/controllers/memory-storage/geopos/index.md b/src/core/1/api/controllers/memory-storage/geopos/index.md index 691440367..ad74f0a7a 100644 --- a/src/core/1/api/controllers/memory-storage/geopos/index.md +++ b/src/core/1/api/controllers/memory-storage/geopos/index.md @@ -8,7 +8,7 @@ title: geopos -Returns the position (`[longitude, latitude]`) of the provided key's members (see [geoadd](/core/1/api/api-reference/controller-memory-storage/geoadd/)). +Returns the position (`[longitude, latitude]`) of the provided key's members (see [geoadd](/core/1/api/controllers/memory-storage/geoadd/)). [[_Redis documentation_]](https://redis.io/commands/geopos) diff --git a/src/core/1/api/controllers/memory-storage/georadius/index.md b/src/core/1/api/controllers/memory-storage/georadius/index.md index 7b2647bd2..699a74ae1 100644 --- a/src/core/1/api/controllers/memory-storage/georadius/index.md +++ b/src/core/1/api/controllers/memory-storage/georadius/index.md @@ -8,7 +8,7 @@ title: georadius -Returns the members (added with [geoadd](/core/1/api/api-reference/controller-memory-storage/geoadd/)) of a given key inside the provided geospatial radius. +Returns the members (added with [geoadd](/core/1/api/controllers/memory-storage/geoadd/)) of a given key inside the provided geospatial radius. [[_Redis documentation_]](https://redis.io/commands/georadius) diff --git a/src/core/1/api/controllers/memory-storage/georadiusbymember/index.md b/src/core/1/api/controllers/memory-storage/georadiusbymember/index.md index d5748a657..ee6ff75c3 100644 --- a/src/core/1/api/controllers/memory-storage/georadiusbymember/index.md +++ b/src/core/1/api/controllers/memory-storage/georadiusbymember/index.md @@ -8,7 +8,7 @@ title: georadiusbymember -Returns the members (added with [geoadd](/core/1/api/api-reference/controller-memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. +Returns the members (added with [geoadd](/core/1/api/controllers/memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. [[_Redis documentation_]](https://redis.io/commands/georadiusbymember) diff --git a/src/core/1/api/controllers/memory-storage/pfcount/index.md b/src/core/1/api/controllers/memory-storage/pfcount/index.md index 7e216ff12..b6880a154 100644 --- a/src/core/1/api/controllers/memory-storage/pfcount/index.md +++ b/src/core/1/api/controllers/memory-storage/pfcount/index.md @@ -8,7 +8,7 @@ title: pfcount -Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/core/1/api/api-reference/controller-memory-storage/pfadd/)). +Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/core/1/api/controllers/memory-storage/pfadd/)). [[_Redis documentation_]](https://redis.io/commands/pfcount) diff --git a/src/core/1/api/controllers/memory-storage/zrevrange/index.md b/src/core/1/api/controllers/memory-storage/zrevrange/index.md index 5a05ab576..021d41c9d 100644 --- a/src/core/1/api/controllers/memory-storage/zrevrange/index.md +++ b/src/core/1/api/controllers/memory-storage/zrevrange/index.md @@ -8,7 +8,7 @@ title: zrevrange -Identical to [zrange](/core/1/api/api-reference/controller-memory-storage/zrange/), except that the sorted set is traversed in descending order. +Identical to [zrange](/core/1/api/controllers/memory-storage/zrange/), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrange) diff --git a/src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md b/src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md index 5f0045e58..6d0f7fd3c 100644 --- a/src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md +++ b/src/core/1/api/controllers/memory-storage/zrevrangebylex/index.md @@ -8,7 +8,7 @@ title: zrevrangebylex -Identical to [zrangebylex](/core/1/api/api-reference/controller-memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. +Identical to [zrangebylex](/core/1/api/controllers/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebylex) diff --git a/src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md b/src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md index 6cb8823f6..bf76a6acd 100644 --- a/src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md +++ b/src/core/1/api/controllers/memory-storage/zrevrangebyscore/index.md @@ -8,7 +8,7 @@ title: zrevrangebyscore -Identical to [zrangebyscore](/core/1/api/api-reference/controller-memory-storage/zrangebyscore/), except that the sorted set is traversed in descending order. +Identical to [zrangebyscore](/core/1/api/controllers/memory-storage/zrangebyscore/), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) diff --git a/src/core/1/api/controllers/realtime/validate/index.md b/src/core/1/api/controllers/realtime/validate/index.md index 3a8cff725..a485206b4 100644 --- a/src/core/1/api/controllers/realtime/validate/index.md +++ b/src/core/1/api/controllers/realtime/validate/index.md @@ -8,7 +8,7 @@ title: validate -This API route is deprecated and should not be used. Instead, use [document:validate](/core/1/api/api-reference/controller-document/validate/). +This API route is deprecated and should not be used. Instead, use [document:validate](/core/1/api/controllers/document/validate/). Validates data against existing validation rules. diff --git a/src/core/1/api/controllers/security/create-credentials/index.md b/src/core/1/api/controllers/security/create-credentials/index.md index ac4ae72bc..e4c0b41fd 100644 --- a/src/core/1/api/controllers/security/create-credentials/index.md +++ b/src/core/1/api/controllers/security/create-credentials/index.md @@ -50,7 +50,7 @@ Body: ## Arguments -- `_id`: user unique [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) +- `_id`: user unique [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) - `strategy`: name of the target authentication strategy for the credentials --- diff --git a/src/core/1/api/controllers/security/create-first-admin/index.md b/src/core/1/api/controllers/security/create-first-admin/index.md index 08d9289df..cb19d0fb2 100644 --- a/src/core/1/api/controllers/security/create-first-admin/index.md +++ b/src/core/1/api/controllers/security/create-first-admin/index.md @@ -68,7 +68,7 @@ Body: ### Optional: -- `_id`: specify the administror [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid), instead of letting Kuzzle generate a random identifier. +- `_id`: specify the administror [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid), instead of letting Kuzzle generate a random identifier. - `reset` (boolean): if true, restricted rights are applied to the `anonymous` and `default` roles (by default, these roles don't have any restriction). --- diff --git a/src/core/1/api/controllers/security/create-or-replace-profile/index.md b/src/core/1/api/controllers/security/create-or-replace-profile/index.md index a1cf9ec98..3ee848b80 100644 --- a/src/core/1/api/controllers/security/create-or-replace-profile/index.md +++ b/src/core/1/api/controllers/security/create-or-replace-profile/index.md @@ -93,7 +93,7 @@ Body: ## Body properties -- `policies`: [profile definition](/core/1/guide/guides/essentials/security/#defining-profiles) +- `policies`: [profile definition](/core/1/guides/essentials/security/#defining-profiles) --- diff --git a/src/core/1/api/controllers/security/create-or-replace-role/index.md b/src/core/1/api/controllers/security/create-or-replace-role/index.md index 11c101d05..0ebc46815 100644 --- a/src/core/1/api/controllers/security/create-or-replace-role/index.md +++ b/src/core/1/api/controllers/security/create-or-replace-role/index.md @@ -67,7 +67,7 @@ Body: ## Body properties -- `controllers`: [role definition](/core/1/guide/guides/essentials/security/#defining-roles) +- `controllers`: [role definition](/core/1/guides/essentials/security/#defining-roles) --- diff --git a/src/core/1/api/controllers/security/create-profile/index.md b/src/core/1/api/controllers/security/create-profile/index.md index 4db5e3f4a..7c4378ad1 100644 --- a/src/core/1/api/controllers/security/create-profile/index.md +++ b/src/core/1/api/controllers/security/create-profile/index.md @@ -93,7 +93,7 @@ Body: ## Body properties -- `policies`: [profile definition](/core/1/guide/guides/essentials/security/#defining-profiles) +- `policies`: [profile definition](/core/1/guides/essentials/security/#defining-profiles) --- diff --git a/src/core/1/api/controllers/security/create-restricted-user/index.md b/src/core/1/api/controllers/security/create-restricted-user/index.md index 4e74c4c1b..cd77f48db 100644 --- a/src/core/1/api/controllers/security/create-restricted-user/index.md +++ b/src/core/1/api/controllers/security/create-restricted-user/index.md @@ -10,7 +10,7 @@ title: createRestrictedUser Creates a new user in Kuzzle, with a preset list of security profiles. -The list of security profiles attributed to restricted users is fixed, and must be configured in the [Kuzzle configuration file](/core/1/guide/guides/essentials/configuration/). +The list of security profiles attributed to restricted users is fixed, and must be configured in the [Kuzzle configuration file](/core/1/guides/essentials/configuration/). This method allows users with limited rights to create other accounts, but blocks them from creating accounts with unwanted privileges (e.g. an anonymous user creating his own account). @@ -71,7 +71,7 @@ Body: ### Optional: -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier). An error is returned if the provided identifier already exists. If not provided, a random kuid is automatically generated. +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier). An error is returned if the provided identifier already exists. If not provided, a random kuid is automatically generated. --- diff --git a/src/core/1/api/controllers/security/create-role/index.md b/src/core/1/api/controllers/security/create-role/index.md index fb8ba73d9..251ba8ac9 100644 --- a/src/core/1/api/controllers/security/create-role/index.md +++ b/src/core/1/api/controllers/security/create-role/index.md @@ -67,7 +67,7 @@ Body: ## Body properties -- `controllers`: [role definition](/core/1/guide/guides/essentials/security/#defining-roles) +- `controllers`: [role definition](/core/1/guides/essentials/security/#defining-roles) --- diff --git a/src/core/1/api/controllers/security/create-user/index.md b/src/core/1/api/controllers/security/create-user/index.md index c58a05bc9..cd982d77d 100644 --- a/src/core/1/api/controllers/security/create-user/index.md +++ b/src/core/1/api/controllers/security/create-user/index.md @@ -72,7 +72,7 @@ Body: ### Optional: -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier). An error is returned if the provided identifier already exists. If not provided, a random kuid is automatically generated. +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier). An error is returned if the provided identifier already exists. If not provided, a random kuid is automatically generated. --- diff --git a/src/core/1/api/controllers/security/delete-credentials/index.md b/src/core/1/api/controllers/security/delete-credentials/index.md index 4df84c8d3..b057bcc12 100644 --- a/src/core/1/api/controllers/security/delete-credentials/index.md +++ b/src/core/1/api/controllers/security/delete-credentials/index.md @@ -36,7 +36,7 @@ Method: DELETE ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) +- `_id`: user [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) - `strategy`: authentication strategy name to remove --- diff --git a/src/core/1/api/controllers/security/delete-user/index.md b/src/core/1/api/controllers/security/delete-user/index.md index 7fc7a0ef9..a854ce3cb 100644 --- a/src/core/1/api/controllers/security/delete-user/index.md +++ b/src/core/1/api/controllers/security/delete-user/index.md @@ -35,7 +35,7 @@ Method: DELETE ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) to delete +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) to delete ### Optional: diff --git a/src/core/1/api/controllers/security/get-credentials-by-id/index.md b/src/core/1/api/controllers/security/get-credentials-by-id/index.md index 8a7c362d4..a0802cf88 100644 --- a/src/core/1/api/controllers/security/get-credentials-by-id/index.md +++ b/src/core/1/api/controllers/security/get-credentials-by-id/index.md @@ -10,9 +10,9 @@ title: getCredentialsById Gets credential information for the user identified by the strategy's unique user identifier `userId`. -The returned `result` object will vary depending on the strategy (see the [getById plugin function](/core/1/plugins/essentials/strategies/#optional-getbyid-default)), and it can be empty. +The returned `result` object will vary depending on the strategy (see the [getById plugin function](/core/1/plugins/guides/strategies/#optional-getbyid-default)), and it can be empty. -**Note:** the user identifier to use depends on the specified strategy. If you wish to get credential information using a [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) identifier, use the [getCredentials](/core/1/api/api-reference/controller-security/get-credentials/) API route instead. +**Note:** the user identifier to use depends on the specified strategy. If you wish to get credential information using a [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) identifier, use the [getCredentials](/core/1/api/controllers/security/get-credentials/) API route instead. --- diff --git a/src/core/1/api/controllers/security/get-credentials/index.md b/src/core/1/api/controllers/security/get-credentials/index.md index f2d50740b..b4f4c1602 100644 --- a/src/core/1/api/controllers/security/get-credentials/index.md +++ b/src/core/1/api/controllers/security/get-credentials/index.md @@ -38,7 +38,7 @@ Method: GET ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `strategy`: authentication strategy name --- diff --git a/src/core/1/api/controllers/security/get-user-rights/index.md b/src/core/1/api/controllers/security/get-user-rights/index.md index dbdb6a339..5dc427f29 100644 --- a/src/core/1/api/controllers/security/get-user-rights/index.md +++ b/src/core/1/api/controllers/security/get-user-rights/index.md @@ -35,7 +35,7 @@ Method: GET ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) --- diff --git a/src/core/1/api/controllers/security/get-user/index.md b/src/core/1/api/controllers/security/get-user/index.md index f18a96ec1..5fffa7d4b 100644 --- a/src/core/1/api/controllers/security/get-user/index.md +++ b/src/core/1/api/controllers/security/get-user/index.md @@ -35,7 +35,7 @@ Method: GET ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) --- diff --git a/src/core/1/api/controllers/security/has-credentials/index.md b/src/core/1/api/controllers/security/has-credentials/index.md index 79a26b475..b497898ca 100644 --- a/src/core/1/api/controllers/security/has-credentials/index.md +++ b/src/core/1/api/controllers/security/has-credentials/index.md @@ -36,7 +36,7 @@ Method: GET ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `strategy`: authentication strategy --- diff --git a/src/core/1/api/controllers/security/m-delete-users/index.md b/src/core/1/api/controllers/security/m-delete-users/index.md index a0971f562..71d4084ce 100644 --- a/src/core/1/api/controllers/security/m-delete-users/index.md +++ b/src/core/1/api/controllers/security/m-delete-users/index.md @@ -52,7 +52,7 @@ Body: ## Body properties -- `ids`: an array of user [kuids](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) to delete +- `ids`: an array of user [kuids](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) to delete --- diff --git a/src/core/1/api/controllers/security/replace-user/index.md b/src/core/1/api/controllers/security/replace-user/index.md index 7989685c7..c4d411b14 100644 --- a/src/core/1/api/controllers/security/replace-user/index.md +++ b/src/core/1/api/controllers/security/replace-user/index.md @@ -49,7 +49,7 @@ Body: ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) ### Optional: diff --git a/src/core/1/api/controllers/security/scroll-profiles/index.md b/src/core/1/api/controllers/security/scroll-profiles/index.md index e1d8f7cc9..b5466378d 100644 --- a/src/core/1/api/controllers/security/scroll-profiles/index.md +++ b/src/core/1/api/controllers/security/scroll-profiles/index.md @@ -8,7 +8,7 @@ title: scrollProfiles -Moves a result set cursor forward, created by a [searchProfiles](/core/1/api/api-reference/controller-security/search-profiles/) query with the `scroll` argument provided. +Moves a result set cursor forward, created by a [searchProfiles](/core/1/api/controllers/security/search-profiles/) query with the `scroll` argument provided. Results returned by a `scrollProfiles` request reflect the state of the index at the time of the initial search request, like a fixed snapshot. Subsequent changes to documents do not affect the scroll results. diff --git a/src/core/1/api/controllers/security/scroll-users/index.md b/src/core/1/api/controllers/security/scroll-users/index.md index 36f1a8184..2b5de58e8 100644 --- a/src/core/1/api/controllers/security/scroll-users/index.md +++ b/src/core/1/api/controllers/security/scroll-users/index.md @@ -8,7 +8,7 @@ title: scrollUsers -Moves a result set cursor forward, created by a [searchUsers](/core/1/api/api-reference/controller-security/search-users/) query with the `scroll` argument provided. +Moves a result set cursor forward, created by a [searchUsers](/core/1/api/controllers/security/search-users/) query with the `scroll` argument provided. Results returned by a `scrollUsers` request reflect the state of the index at the time of the initial search request, like a fixed snapshot. Subsequent changes to documents do not affect the scroll results. @@ -51,7 +51,7 @@ Method: GET Returns a paginated search result set, with the following properties: - `hits`: array of found profiles. Each document has the following properties: - - `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) + - `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `_source`: user definition - `scrollId`: identifier to the next page of result. Can be different than the previous one(s) - `total`: total number of found users. Usually greater than the number of users in a result page diff --git a/src/core/1/api/controllers/security/search-profiles/index.md b/src/core/1/api/controllers/security/search-profiles/index.md index e9a96eac7..f4e7b0dd5 100644 --- a/src/core/1/api/controllers/security/search-profiles/index.md +++ b/src/core/1/api/controllers/security/search-profiles/index.md @@ -57,7 +57,7 @@ Body: ### Optional: - `from`: the offset from the first result you want to fetch. Usually used with the `size` argument -- `scroll`: create a new forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` will be returned in the results. This cursor can then be moved forward using the [scrollProfiles](/core/1/api/api-reference/controller-security/scroll-profiles/) API action +- `scroll`: create a new forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` will be returned in the results. This cursor can then be moved forward using the [scrollProfiles](/core/1/api/controllers/security/scroll-profiles/) API action - `size`: the maximum number of profiles returned in one response page --- diff --git a/src/core/1/api/controllers/security/search-users/index.md b/src/core/1/api/controllers/security/search-users/index.md index 996d612a6..5a77070a4 100644 --- a/src/core/1/api/controllers/security/search-users/index.md +++ b/src/core/1/api/controllers/security/search-users/index.md @@ -87,7 +87,7 @@ Body: ### Optional: - `from`: the offset from the first result you want to fetch. Usually used with the `size` argument -- `scroll`: create a new forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` will be returned in the results. This cursor can then be moved forward using the [scrollUsers](/core/1/api/api-reference/controller-security/scroll-users/) API action +- `scroll`: create a new forward-only result cursor. This option must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/common-options.html#time-units), at the end of which the cursor is destroyed. If set, a cursor identifier named `scrollId` will be returned in the results. This cursor can then be moved forward using the [scrollUsers](/core/1/api/controllers/security/scroll-users/) API action - `size`: the maximum number of users returned in one response page --- @@ -107,7 +107,7 @@ If the body is left empty, the result will return all available users. Returns an object with the following properties: - `hits`: array of object. Each object describes a found user: - - `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) + - `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `_source`: user definition - `total`: total number of users found. Depending on pagination options, this can be greater than the actual number of users in a single result page diff --git a/src/core/1/api/controllers/security/update-credentials/index.md b/src/core/1/api/controllers/security/update-credentials/index.md index 3fcc6092f..4d0e1aec5 100644 --- a/src/core/1/api/controllers/security/update-credentials/index.md +++ b/src/core/1/api/controllers/security/update-credentials/index.md @@ -48,7 +48,7 @@ Body: ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `strategy`: authentication strategy --- diff --git a/src/core/1/api/controllers/security/update-profile/index.md b/src/core/1/api/controllers/security/update-profile/index.md index ce6bf5faf..2cd410612 100644 --- a/src/core/1/api/controllers/security/update-profile/index.md +++ b/src/core/1/api/controllers/security/update-profile/index.md @@ -93,7 +93,7 @@ Body: ## Body properties -- `policies`: [profile definition](/core/1/guide/guides/essentials/security/#defining-profiles) +- `policies`: [profile definition](/core/1/guides/essentials/security/#defining-profiles) --- diff --git a/src/core/1/api/controllers/security/update-role/index.md b/src/core/1/api/controllers/security/update-role/index.md index 7aedbb08f..c89ade68e 100644 --- a/src/core/1/api/controllers/security/update-role/index.md +++ b/src/core/1/api/controllers/security/update-role/index.md @@ -69,7 +69,7 @@ Body: ## Body properties -- `controllers`: [role definition](/core/1/guide/guides/essentials/security/#defining-roles) +- `controllers`: [role definition](/core/1/guides/essentials/security/#defining-roles) --- diff --git a/src/core/1/api/controllers/security/update-user/index.md b/src/core/1/api/controllers/security/update-user/index.md index 2760a7fca..64c9088b4 100644 --- a/src/core/1/api/controllers/security/update-user/index.md +++ b/src/core/1/api/controllers/security/update-user/index.md @@ -45,7 +45,7 @@ Body: ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) ### Optional: diff --git a/src/core/1/api/controllers/security/validate-credentials/index.md b/src/core/1/api/controllers/security/validate-credentials/index.md index e5d607968..9f2349342 100644 --- a/src/core/1/api/controllers/security/validate-credentials/index.md +++ b/src/core/1/api/controllers/security/validate-credentials/index.md @@ -50,7 +50,7 @@ Body: ## Arguments -- `_id`: user [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) +- `_id`: user [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier) - `strategy`: authentication strategy --- diff --git a/src/core/1/api/essentials/connecting-to-kuzzle/index.md b/src/core/1/api/essentials/connecting-to-kuzzle/index.md index 97affc7d6..b1af9d60b 100644 --- a/src/core/1/api/essentials/connecting-to-kuzzle/index.md +++ b/src/core/1/api/essentials/connecting-to-kuzzle/index.md @@ -16,7 +16,7 @@ A connection to Kuzzle can be made using different protocols. Currently Kuzzle n By default, Kuzzle can be reached via HTTP on port 7512. Thus, assuming the Kuzzle server is running locally, it can be reached at `http://localhost:7512/`. -The default response for the root endpoint is the [ServerInfo](/core/1/api/api-reference/controller-server/info/), which gives detailed information about the available HTTP API routes. +The default response for the root endpoint is the [ServerInfo](/core/1/api/controllers/server/info/), which gives detailed information about the available HTTP API routes. ### Example diff --git a/src/core/1/api/essentials/errors/index.md b/src/core/1/api/essentials/errors/index.md index de55d738f..ad5892c1d 100644 --- a/src/core/1/api/essentials/errors/index.md +++ b/src/core/1/api/essentials/errors/index.md @@ -86,7 +86,7 @@ An `InternalError` error is thrown if Kuzzle encountered an unexpected error. **status**: 500 -A `PluginImplementationError` error is a generic error thrown by Kuzzle on a [plugin](/plugins/1) failure. +A `PluginImplementationError` error is a generic error thrown by Kuzzle on a [plugin](/core/1/plugins) failure. --- @@ -154,7 +154,7 @@ For instance, this error can be generated when trying to create a document on a **status**: 413 -A `SizeLimitError` error is thrown by Kuzzle if the request size exceeds the limits defined in the [configuration](/core/1/guide/guides/essentials/configuration/). +A `SizeLimitError` error is thrown by Kuzzle if the request size exceeds the limits defined in the [configuration](/core/1/guides/essentials/configuration/). --- diff --git a/src/core/1/api/essentials/notifications/index.md b/src/core/1/api/essentials/notifications/index.md index 4c6fdb9b5..337226d8a 100644 --- a/src/core/1/api/essentials/notifications/index.md +++ b/src/core/1/api/essentials/notifications/index.md @@ -7,7 +7,7 @@ order: 500 # Real-time Notifications -Clients can [subscribe](/core/1/api/api-reference/controller-realtime/subscribe/) to documents, messages and events, in order to receive a notification whenever a change occurs matching the subscription scope. +Clients can [subscribe](/core/1/api/controllers/realtime/subscribe/) to documents, messages and events, in order to receive a notification whenever a change occurs matching the subscription scope. --- @@ -90,7 +90,7 @@ User notifications about users are triggered by the following events: - A user subscribes to the same room - A user leaves that room -These notifications are sent only if the `users` argument is set to any other value than the default `none` one (see [subscription request](/core/1/api/api-reference/controller-realtime/subscribe/)). +These notifications are sent only if the `users` argument is set to any other value than the default `none` one (see [subscription request](/core/1/api/controllers/realtime/subscribe/)). ### Format @@ -142,7 +142,7 @@ The `result` object is the notification content, and it has the following struct Server notifications are triggered by global events, and they are sent to all of a client's subscriptions at the same time. -Currently, the only event generating a server notification is when an [authentication token](/core/1/guide/guides/essentials/user-authentication/) has expired, closing the subscription. +Currently, the only event generating a server notification is when an [authentication token](/core/1/guides/essentials/user-authentication/) has expired, closing the subscription. Other events may be added in the future. diff --git a/src/core/1/api/essentials/query-syntax/index.md b/src/core/1/api/essentials/query-syntax/index.md index 0947deda9..99fda4a5f 100644 --- a/src/core/1/api/essentials/query-syntax/index.md +++ b/src/core/1/api/essentials/query-syntax/index.md @@ -23,7 +23,7 @@ Every API route documentation has a dedicated HTTP section, explaining how to us The following list of HTTP headers can be added to any and all HTTP requests: - `Accept-Encoding`: compression algorithm(s) usable by Kuzzle to encode the query response. Accepted encodings, in order of preference: `gzip`, `deflate`, `identity`. -- `Authorization` (expected value: `Bearer `): user's authentification token, obtained through the [login](/core/1/api/api-reference/controller-auth/login/) method +- `Authorization` (expected value: `Bearer `): user's authentification token, obtained through the [login](/core/1/api/controllers/auth/login/) method - `Content-Encoding`: compression algorithm(s) used to encode the body sent to Kuzzle. Accepted encodings: `deflate`, `gzip`, `identity` ### Body encoding @@ -82,7 +82,7 @@ Depending on the API route executed, other parameters may be required. Those are There are 3 parameters that can be provided to all queries, independently to the API route executed: -- `jwt`: user's authentification token, obtained through the [login](/core/1/api/api-reference/controller-auth/login/) method +- `jwt`: user's authentification token, obtained through the [login](/core/1/api/controllers/auth/login/) method - `requestId`: user-defined request identifier. Kuzzle does not guarantee that responses are sent back in the same order than queries are made; use that field to link responses to their query of origin - `volatile`: user-defined data, without any impact to the query. Use that object to pass information about the query itself to real-time subscribers. Read more [here](/core/1/api/essentials/volatile-data/) diff --git a/src/core/1/api/essentials/volatile-data/index.md b/src/core/1/api/essentials/volatile-data/index.md index 5069e6079..1e275467b 100644 --- a/src/core/1/api/essentials/volatile-data/index.md +++ b/src/core/1/api/essentials/volatile-data/index.md @@ -26,7 +26,7 @@ Lastly, if a query triggers [document notifications](/core/1/api/essentials/noti ### Example: -The following [document:update](/core/1/api/api-reference/controller-document/update/) query: +The following [document:update](/core/1/api/controllers/document/update/) query: ```javascript { @@ -77,7 +77,7 @@ There is one special case, where volatile data are stored by Kuzzle for a later Volatile data passed to a new subscription query are used two times by Kuzzle: - if the new subscription triggers [user notifications](/core/1/api/essentials/notifications#user-events-default), its volatile data are included into those -- if that subscription is cancelled, whether because of a call to [realtime:unsubscribe](/core/1/api/api-reference/controller-realtime/unsubscribe/), or after the user disconnects: the volatile data provided **at the time of the subscription** are once again copied into user notifications triggered by that event +- if that subscription is cancelled, whether because of a call to [realtime:unsubscribe](/core/1/api/controllers/realtime/unsubscribe/), or after the user disconnects: the volatile data provided **at the time of the subscription** are once again copied into user notifications triggered by that event This allows other real-time subscribers to get context information about a user joining or leaving the same subscription as them. diff --git a/src/core/1/guides/code-examples/dbsearch/android/index.md b/src/core/1/guides/code-examples/dbsearch/android/index.md index 6e6e33cdd..c2979fce2 100644 --- a/src/core/1/guides/code-examples/dbsearch/android/index.md +++ b/src/core/1/guides/code-examples/dbsearch/android/index.md @@ -50,7 +50,7 @@ collection.createDocument(document); Now that the document is created and stored in Kuzzle, let's perform a search that will return this document in the result. -First we need to define the search criteria. Here we use the `match` term to find any document that has a `mountain` terrain. For additional terms refer to our [Elasticsearch Cookbook](/core/1/guide/elasticsearch) or Elasticsearch's own documentation. +First we need to define the search criteria. Here we use the `match` term to find any document that has a `mountain` terrain. For additional terms refer to our [Elasticsearch Cookbook](/core/1/guides/cookbooks/elasticsearch) or Elasticsearch's own documentation. Create the JSONObject with the search criteria: diff --git a/src/core/1/guides/code-examples/dbsearch/go/index.md b/src/core/1/guides/code-examples/dbsearch/go/index.md index 926a9b98f..720fb22be 100644 --- a/src/core/1/guides/code-examples/dbsearch/go/index.md +++ b/src/core/1/guides/code-examples/dbsearch/go/index.md @@ -67,7 +67,7 @@ c.CreateDocument("", planet, q) Now that the document is created and stored in Kuzzle, let's perform a search that will return this document in the result. -First we need to define the search criteria. Here we use the `match` term to find any document that has a `mountain` terrain. For additional terms refer to our [Elasticsearch Cookbook](/core/1/guide/elasticsearch) or Elasticsearch's own documentation. +First we need to define the search criteria. Here we use the `match` term to find any document that has a `mountain` terrain. For additional terms refer to our [Elasticsearch Cookbook](/core/1/guides/cookbooks/elasticsearch) or Elasticsearch's own documentation. We use the Collection `Search` method to search for the document in Kuzzle once the document is created: diff --git a/src/core/1/guides/code-examples/dbsearch/introduction/index.md b/src/core/1/guides/code-examples/dbsearch/introduction/index.md index 46818bffe..b18aa28d5 100644 --- a/src/core/1/guides/code-examples/dbsearch/introduction/index.md +++ b/src/core/1/guides/code-examples/dbsearch/introduction/index.md @@ -12,7 +12,7 @@ Kuzzle uses Elasticsearch as its datastore and provides a user friendly interfac ## Configure Kuzzle -First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guide/guides/getting-started//#running-kuzzle). +First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guides/getting-started//#running-kuzzle). ## Create Your App diff --git a/src/core/1/guides/code-examples/geofencing/android/index.md b/src/core/1/guides/code-examples/geofencing/android/index.md index eba1cef50..321c7826d 100644 --- a/src/core/1/guides/code-examples/geofencing/android/index.md +++ b/src/core/1/guides/code-examples/geofencing/android/index.md @@ -47,7 +47,7 @@ This defines a circular boundary centered around [Big Ben](https://www.google.co Note that we use the field name `location` to store the geopoint we are centered around. This means that Kuzzle will monitor the field named `location` for position changes, and so any user location document sent to Kuzzle must also contain this field. -Now the App must request a subscription to the geographical boundary defined in our `filter` object. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/android/3/controllers/collection/subscribe/). +Now the App must request a subscription to the geographical boundary defined in our `filter` object. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/android/3/core-classes/collection/subscribe/). Let's create a _subscribe_ method and add the following code to it: diff --git a/src/core/1/guides/code-examples/geofencing/go/index.md b/src/core/1/guides/code-examples/geofencing/go/index.md index f87c87ba2..3c6741d3f 100644 --- a/src/core/1/guides/code-examples/geofencing/go/index.md +++ b/src/core/1/guides/code-examples/geofencing/go/index.md @@ -104,7 +104,7 @@ This defines a circular boundary centered around [Big Ben](https://www.google.co Note that we use the field name `location` to store the geopoint we are centered around. This means that Kuzzle will monitor the field named `location` for position changes, and so any user location document sent to Kuzzle must also contain this field. -Now the App must request a subscription to the geographical boundary defined in our `filters` object. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/js/5/collection/subscribe/). +Now the App must request a subscription to the geographical boundary defined in our `filters` object. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/js/5/core-classes/collection/subscribe/). Now use the Collection `Subscribe` method to execute the subscription request, add this to your `Subscribe` function: diff --git a/src/core/1/guides/code-examples/geofencing/introduction/index.md b/src/core/1/guides/code-examples/geofencing/introduction/index.md index d19b24b04..3e396c2ab 100644 --- a/src/core/1/guides/code-examples/geofencing/introduction/index.md +++ b/src/core/1/guides/code-examples/geofencing/introduction/index.md @@ -14,7 +14,7 @@ In this code example we will show you how geofencing works with Kuzzle. ## Configure Kuzzle -First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guide/guides/getting-started//#running-kuzzle). +First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guides/getting-started//#running-kuzzle). ## Create Your App diff --git a/src/core/1/guides/code-examples/geofencing/javascript/index.md b/src/core/1/guides/code-examples/geofencing/javascript/index.md index 55e3f97c4..3ddbabd9a 100644 --- a/src/core/1/guides/code-examples/geofencing/javascript/index.md +++ b/src/core/1/guides/code-examples/geofencing/javascript/index.md @@ -46,7 +46,7 @@ This defines a circular boundary centered around [Big Ben](https://www.google.co Note that we use the field name `location` to store the geopoint we are centered around. This means that Kuzzle will monitor the field named `location` for position changes, and so any user location document sent to Kuzzle must also contain this field. -Now the App must request a subscription to the geographical boundary defined in our JSONObject. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/js/5/collection/subscribe/). +Now the App must request a subscription to the geographical boundary defined in our JSONObject. To ensure that the App only receives a message when the `location` changes from inside the boundary to outside the boundary, we need to set the subscription scope to `out`, for more scope options click [here](/sdk/js/5/core-classes/collection/subscribe/). Let's use the _subscribe_ method : diff --git a/src/core/1/guides/code-examples/iot/introduction/index.md b/src/core/1/guides/code-examples/iot/introduction/index.md index 4b2781fff..08a418e48 100644 --- a/src/core/1/guides/code-examples/iot/introduction/index.md +++ b/src/core/1/guides/code-examples/iot/introduction/index.md @@ -15,7 +15,7 @@ In this code example we will show you how to connect to Kuzzle using MQTT, a wid ## Install Kuzzle and enable the MQTT protocol First, you need to download Kuzzle. -To do that you can follow these [intstructions](/core/1/guide/guides/getting-started//#running-kuzzle). +To do that you can follow these [intstructions](/core/1/guides/getting-started//#running-kuzzle). In order to enable the MQTT protocol in Kuzzle, we just need to add 3 lines in the docker-compose file. Specifically, we need to open the port `1883`, which is the default for MQTT, and we need to set 2 environment variables. diff --git a/src/core/1/guides/code-examples/pubsub/introduction/index.md b/src/core/1/guides/code-examples/pubsub/introduction/index.md index 4b50a560b..29f75ef21 100644 --- a/src/core/1/guides/code-examples/pubsub/introduction/index.md +++ b/src/core/1/guides/code-examples/pubsub/introduction/index.md @@ -14,7 +14,7 @@ In this code example we will show you how pub/sub works with Kuzzle. ## Configure Kuzzle -First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guide/guides/getting-started//#running-kuzzle). +First let's make sure Kuzzle is running and create the index and collection we will use to store documents. Follow these [instructions](/core/1/guides/getting-started//#running-kuzzle). ## Create Your App @@ -29,4 +29,4 @@ Before we get started on the App, there are a few basics you need to know: - Firstly, a subscription is done at the collection level. This means that Kuzzle will only monitor changes to documents in the specified collection. - Secondly, unlike typical pub/sub solutions, there is no need to create a topic first. In Kuzzle, the topic is replaced by a document `filter` which is sent by the Client when it makes a subscription request. Clients can subscribe using the same document filter, effectively simulating a `topic`. - For more information about subscriptions click [here](/core/1/api/api-reference/controller-realtime/subscribe/) + For more information about subscriptions click [here](/core/1/api/controllers/realtime/subscribe/) diff --git a/src/core/1/guides/cookbooks/datavalidation/introduction/index.md b/src/core/1/guides/cookbooks/datavalidation/introduction/index.md index dc3f48d7b..a999cef1c 100644 --- a/src/core/1/guides/cookbooks/datavalidation/introduction/index.md +++ b/src/core/1/guides/cookbooks/datavalidation/introduction/index.md @@ -13,7 +13,7 @@ You can specify the validation specification in the Kuzzle configuration file un Validation specifications are always attached to the collection of an index. -The API offers several actions to perform on validation specifications, allowing you to read, update, delete or validate them. Please refer to the [API documentation](/core/1/api/api-reference/controller-collection/update-specifications/) for more information. +The API offers several actions to perform on validation specifications, allowing you to read, update, delete or validate them. Please refer to the [API documentation](/core/1/api/controllers/collection/update-specifications/) for more information. A validation specification is composed of three properties: diff --git a/src/core/1/guides/cookbooks/datavalidation/schema/index.md b/src/core/1/guides/cookbooks/datavalidation/schema/index.md index 6fe4b6296..2b8c81f10 100644 --- a/src/core/1/guides/cookbooks/datavalidation/schema/index.md +++ b/src/core/1/guides/cookbooks/datavalidation/schema/index.md @@ -10,7 +10,7 @@ order: 0 When a collection is created, its specification is empty. As a result, any document will be valid. -In order to update the specification, you can use the [updateSpecifications](/core/1/api/api-reference/controller-collection/update-specifications/) action. +In order to update the specification, you can use the [updateSpecifications](/core/1/api/controllers/collection/update-specifications/) action. Here is an example of a full specification: diff --git a/src/core/1/guides/essentials/cli/index.md b/src/core/1/guides/essentials/cli/index.md index a5b42257b..0d6a801aa 100644 --- a/src/core/1/guides/essentials/cli/index.md +++ b/src/core/1/guides/essentials/cli/index.md @@ -18,8 +18,8 @@ Kuzzle ships with a [Command line interface](https://en.wikipedia.org/wiki/Comma - Clear Kuzzle cache - Diagnose the Kuzzle installation -The CLI is located in the `bin` folder of your Kuzzle installation. -If you have already created an admin, you will need to provide your login information to the CLI. +The CLI is located in the `bin` folder of your Kuzzle installation. +If you have already created an admin, you will need to provide your login information to the CLI. To get a list of commands and options run the CLI: ```bash @@ -65,7 +65,7 @@ The `createFirstAdmin` command lets you create an administrator to manage securi
NB: This command can only be run interactively
-This call the action [security#createFirstAdmin](/core/1/api/api-reference/controller-security/create-first-admin/) +This call the action [security#createFirstAdmin](/core/1/api/controllers/security/create-first-admin/) --- @@ -77,7 +77,7 @@ This call the action [security#createFirstAdmin](/core/1/api/api-reference/contr Kuzzle uses Redis to store frequently accessed internal data. Use this command if you need to clear this data (cache). -This call the action [admin#resetCache](/core/1/api/api-reference/controller-admin/reset-cache/) +This call the action [admin#resetCache](/core/1/api/controllers/admin/reset-cache/) --- @@ -105,7 +105,7 @@ The `dump` command creates a snapshot of the state of Kuzzle, including: The generated directory can be used to feed a crash report to the support team. -This call the action [admin#dump](/core/1/api/api-reference/controller-admin/reset-security/) +This call the action [admin#dump](/core/1/api/controllers/admin/reset-security/) --- @@ -133,7 +133,7 @@ Asynchronously start the following sequence in Kuzzle, in this order: This action has no impact on Plugin and Document storage. -This call the action [admin#resetKuzzleData](/core/1/api/api-reference/controller-admin/reset-kuzzle-data/) +This call the action [admin#resetKuzzleData](/core/1/api/controllers/admin/reset-kuzzle-data/) --- @@ -156,7 +156,7 @@ This call the action [admin#resetKuzzleData](/core/1/api/api-reference/controlle The `resetSecurity` command deletes all created users, profiles and roles and reset the default roles and profiles : `anonymous`, `admin` and `default`. -This call the action [admin#resetSecurity](/core/1/api/api-reference/controller-admin/reset-security/) +This call the action [admin#resetSecurity](/core/1/api/controllers/admin/reset-security/) --- @@ -179,7 +179,7 @@ This call the action [admin#resetSecurity](/core/1/api/api-reference/controller- The `resetDatabase` delete all indexes created by users. This does not include Kuzzle's internal index. -This call the action [admin#resetDatabase](/core/1/api/api-reference/controller-admin/reset-database/) +This call the action [admin#resetDatabase](/core/1/api/controllers/admin/reset-database/) Note: this command has no impact on any plugins stored data, or on any Kuzzle stored documents. @@ -196,7 +196,7 @@ Note: this command has no impact on any plugins stored data, or on any Kuzzle st The `shutdown` command lets you stop a Kuzzle instance after any remaining requests are processed, ensuring that no unnecessary `Service Unavailable` errors are returned to connected clients. -This call the action [admin#shutdown](/core/1/api/api-reference/controller-admin/shutdown/) +This call the action [admin#shutdown](/core/1/api/controllers/admin/shutdown/) --- @@ -294,7 +294,7 @@ The file must be a JSON file with the following structure: **Notes:** - The file can contain any number of index and collection configurations. -- Each collection contains an array of data to load, just like the [bulk:import API](/core/1/api/api-reference/controller-bulk/import/). +- Each collection contains an array of data to load, just like the [bulk:import API](/core/1/api/controllers/bulk/import/). - If an index or collection does not exist, the load will fail. - Fixtures are loaded sequentially, one index/collection pair at a time. If a failure occurs, Kuzzle immediately interrupts the sequence. @@ -342,9 +342,9 @@ The file must be a JSON file with the following structure: The roles, profiles and users definition follow the same structure as in the body parameter of the API: -- [createRole](/core/1/api/api-reference/controller-security/create-role/) -- [createProfile](/core/1/api/api-reference/controller-security/create-profile/) -- [createUser](/core/1/api/api-reference/controller-security/create-user/) +- [createRole](/core/1/api/controllers/security/create-role/) +- [createProfile](/core/1/api/controllers/security/create-profile/) +- [createUser](/core/1/api/controllers/security/create-user/) **Notes:** diff --git a/src/core/1/guides/essentials/data-validation/index.md b/src/core/1/guides/essentials/data-validation/index.md index f58818c98..404dd069d 100644 --- a/src/core/1/guides/essentials/data-validation/index.md +++ b/src/core/1/guides/essentials/data-validation/index.md @@ -11,15 +11,15 @@ One common requirement when you are managing data is to perform **data validatio A common example is **email validation**. Let's say you have developed a registration page where you request a user's name and email and you want to ensure that the email they provide is valid. -With Kuzzle, instead of programming the validation logic yourself, you can pick from a set of predefined [validation patterns](/core/1/guide/datavalidation). Validations are defined in a validation schema which determines what pattern is linked to what field, every time Kuzzle receives input data, it checks this validation schema and returns an error if a validation pattern fails. The validation schema can be configured in the `validation` field of the [configuration file](/core/1/guide/guides/essentials/configuration/). +With Kuzzle, instead of programming the validation logic yourself, you can pick from a set of predefined [validation patterns](/core/1/guides/cookbooks/datavalidation). Validations are defined in a validation schema which determines what pattern is linked to what field, every time Kuzzle receives input data, it checks this validation schema and returns an error if a validation pattern fails. The validation schema can be configured in the `validation` field of the [configuration file](/core/1/guides/essentials/configuration/). -For a detailed look at data validation, please refer to our [Data Validation Reference](/core/1/guide/datavalidation). +For a detailed look at data validation, please refer to our [Data Validation Reference](/core/1/guides/cookbooks/datavalidation). --- ## Basic Validation -A validation schema is defined using a [hierarchical](/core/1/guide/datavalidation) structure that contains a set of rules within an index, collection, and document field. +A validation schema is defined using a [hierarchical](/core/1/guides/cookbooks/datavalidation) structure that contains a set of rules within an index, collection, and document field. For example, below is a validation schema for the `onlineshop` index and `products` collection that defines the validation pattern for field `price` and field `productDescription`: @@ -50,7 +50,7 @@ Let's take a look at what this validation schema does: - It ensures that `price` exists and is a `Number`. - It ensures that `productDescription` is a `String` and has a value when none is provided. -For a complete list of validation patterns please refer to our [Validation Patterns Reference](/core/1/guide/datavalidation). +For a complete list of validation patterns please refer to our [Validation Patterns Reference](/core/1/guides/cookbooks/datavalidation). --- @@ -86,7 +86,7 @@ Below is an example of how the `range` type option is used to ensure that the fi } ``` -For more information regarding Type Options, please refer to [this](/core/1/guide/cookbooks/datavalidation//#field-typeoptions-default) section of the Data Validation Reference. +For more information regarding Type Options, please refer to [this](/core/1/guides/cookbooks/datavalidation#field-typeoptions-default) section of the Data Validation Reference. --- diff --git a/src/core/1/guides/essentials/database-mappings/index.md b/src/core/1/guides/essentials/database-mappings/index.md index 7c6f976ab..4cd059182 100644 --- a/src/core/1/guides/essentials/database-mappings/index.md +++ b/src/core/1/guides/essentials/database-mappings/index.md @@ -10,13 +10,13 @@ order: 400 With Elasticsearch, it is possible to define mappings for collections. These mappings allow you to configure the way Elasticsearch will handle these collections. There are 3 root fields for mapping configuration: - - [properties](/core/1/guide/guides/essentials/database-mappings/#properties-types-definition): collection types definition - - [dynamic](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy): dynamic mapping policy against new fields - - [_meta](/core/1/guide/guides/essentials/database-mappings/#collection-metadata): collection metadata + - [properties](/core/1/guides/essentials/database-mappings/#properties-types-definition): collection types definition + - [dynamic](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy): dynamic mapping policy against new fields + - [_meta](/core/1/guides/essentials/database-mappings/#collection-metadata): collection metadata The following API methods can be used to modify these mappings: - - [collection:create](/core/1/api/api-reference/controller-collection/create/) - - [collection:updateMapping](/core/1/api/api-reference/controller-collection/update-mapping/) + - [collection:create](/core/1/api/controllers/collection/create/) + - [collection:updateMapping](/core/1/api/controllers/collection/update-mapping/) --- @@ -65,7 +65,7 @@ The following mapping must first be defined: } ``` -This mapping is then passed in the body to the methods [collection:create](/core/1/api/api-reference/controller-collection/create/) or [collection:updateMapping](/core/1/api/api-reference/controller-collection/update-mapping/). +This mapping is then passed in the body to the methods [collection:create](/core/1/api/controllers/collection/create/) or [collection:updateMapping](/core/1/api/controllers/collection/update-mapping/). ```bash # First create a collection yellow-taxi in the nyc-open-index @@ -94,7 +94,7 @@ The value of this configuration will change the way Elasticsearch manages the cr Refer to Elasticsearch documentation for more informations: [Elasticsearch dynamic mapping](https://www.elastic.co/guide/en/elasticsearch/guide/current/dynamic-mapping.html) -The default policy for new collections is `"true"` and is configurable in the [kuzzlerc](/core/1/guide/guides/essentials/configuration/) file under the key `services.db.dynamic`. +The default policy for new collections is `"true"` and is configurable in the [kuzzlerc](/core/1/guides/essentials/configuration/) file under the key `services.db.dynamic`. ::: warning We advise not to let Elasticsearch dynamically infer the type of new fields in production. @@ -146,7 +146,7 @@ If you set the ```_meta``` field in your request, the old value will be overwrit Refer to Elasticsearch documentation for more informations: [Elasticsearch mapping meta field](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/mapping-meta-field.html) -These metadata can be retrieved with the [collection:getMapping](/core/1/api/api-reference/controller-collection/get-mapping/) API method. +These metadata can be retrieved with the [collection:getMapping](/core/1/api/controllers/collection/get-mapping/) API method. ### Example @@ -170,7 +170,7 @@ curl -X GET -H "Content-Type: application/json" "http://localhost:7512/nyc-open ## What Now? -* Learn to work with [Persistent Data](/core/1/guide/guides/essentials/persisted) +* Learn to work with [Persistent Data](/core/1/guides/essentials/persisted) * Read our [Elasticsearch Cookbook](/core/1/guide/cookbooks/elasticsearch) to learn more about how querying works in Kuzzle -* Use [document metadata](/core/1/guide/guides/essentials/document-metadata) to find or recover documents -* Keep track of data changes using [Real-time Notifications](/core/1/guide/guides/essentials/real-time) +* Use [document metadata](/core/1/guides/essentials/document-metadata) to find or recover documents +* Keep track of data changes using [Real-time Notifications](/core/1/guides/essentials/real-time) diff --git a/src/core/1/guides/essentials/document-metadata/index.md b/src/core/1/guides/essentials/document-metadata/index.md index 9a5c43cff..0f96da56c 100644 --- a/src/core/1/guides/essentials/document-metadata/index.md +++ b/src/core/1/guides/essentials/document-metadata/index.md @@ -19,10 +19,10 @@ Metadata can be viewed in the document's `_meta` field and contains the followin Metadata can be viewed in the document's `_kuzzle_info` field and contains the following properties: -- `author`: The [unique identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuidd) of the user who created the document. +- `author`: The [unique identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuidd) of the user who created the document. - `createdAt`: Timestamp of document creation (create or replace), in epoch-milliseconds format. - `updatedAt`: Timestamp of last document update in epoch-milliseconds format, or `null` if no update has been made. -- `updater`: The [unique identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) of the user that updated the document, or `null` if the document has never been updated. +- `updater`: The [unique identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) of the user that updated the document, or `null` if the document has never been updated. - `active`: The status of the document. `true` if the document is active and `false` if the document has been put in the trashcan. - `deletedAt`: Timestamp of document deletion in epoch-milliseconds format, or `null` if the document has not been deleted. @@ -115,7 +115,7 @@ Documents in the `trashcan` cannot be accessed, searched or counted, unless the ## Garbage Collection -Kuzzle will routinely search and permanently delete the oldest documents in the `trashcan`. This garbage collecting can be configured using the `services.garbageCollector` property in the Kuzzle [configuration file](/core/1/guide/guides/essentials/configuration/). In general, garbage collection works as follows: +Kuzzle will routinely search and permanently delete the oldest documents in the `trashcan`. This garbage collecting can be configured using the `services.garbageCollector` property in the Kuzzle [configuration file](/core/1/guides/essentials/configuration/). In general, garbage collection works as follows: - When Kuzzle is started, it will check the `services.garbageCollector` property and wait the configured delay before running the garbage collection for the first time. - If Kuzzle is in [overload](/core/1/plugins/guides/events/core-overload) the garbage collecting will be postponed until the load is reduced. diff --git a/src/core/1/guides/essentials/installing-console/index.md b/src/core/1/guides/essentials/installing-console/index.md index aed419cff..61ffea1c5 100644 --- a/src/core/1/guides/essentials/installing-console/index.md +++ b/src/core/1/guides/essentials/installing-console/index.md @@ -11,7 +11,7 @@ The Kuzzle Admin Console is a web application that lets you manage Kuzzle, inclu If you don't want to install Kuzzle Admin Console yourself you can use our publicly hosted Kuzzle Admin Console. Otherwise, grab the source code [here](https://github.com/kuzzleio/kuzzle-admin-console/releases) and install it on your own environment. -In both cases the configuration is the same and you'll be able to select which [Kuzzle](/core/1/guide/guides/essentials/installing-console/#connect-to-kuzzle) installation you want to manage. +In both cases the configuration is the same and you'll be able to select which [Kuzzle](/core/1/guides/essentials/installing-console/#connect-to-kuzzle) installation you want to manage.
Having trouble? Get in touch with us on Gitter! We're happy to help. diff --git a/src/core/1/guides/essentials/installing-kuzzle/index.md b/src/core/1/guides/essentials/installing-kuzzle/index.md index 4b4d1842e..77169757b 100644 --- a/src/core/1/guides/essentials/installing-kuzzle/index.md +++ b/src/core/1/guides/essentials/installing-kuzzle/index.md @@ -87,9 +87,9 @@ Our AMI is stored on AWS Marketplace. It's set up with: - Elasticsearch (**v5.4.1**). - Redis (**v3.2.12**). -Go to the marketplace and type **kuzzle** in the search form. -Choose your Amazon EC2 instance type (the minimal requirement is a **t2-medium**). -Recover the public IP or the hostname provided by AWS before you proceed. +Go to the marketplace and type **kuzzle** in the search form. +Choose your Amazon EC2 instance type (the minimal requirement is a **t2-medium**). +Recover the public IP or the hostname provided by AWS before you proceed. Check that Kuzzle is up and running with following HTTP request: ```sh @@ -109,7 +109,7 @@ $ curl 'http://yourInstanceIpOrHostname:7512?pretty' } ``` -You should see information about your Kuzzle Server. +You should see information about your Kuzzle Server. If not, wait a few minutes and retry the request. ### Connect with default credentials @@ -126,7 +126,7 @@ Associated password is your unique instance ID. You can get it from the EC2 AWS In this section we will perform a manual installation of Kuzzle on a Linux distribution. We choose Linux because all Kuzzle components work natively on it. ::: info -By default, Kuzzle expects all the components to be running on localhost but you can [change](/core/1/guide/guides/essentials/configuration/)'ll be able to select which Kuzzle installation that you want to manage. this behavior. +By default, Kuzzle expects all the components to be running on localhost but you can [change](/core/1/guides/essentials/configuration/)'ll be able to select which Kuzzle installation that you want to manage. this behavior. ::: We will run Kuzzle using [pm2](http://pm2.keymetrics.io/), a process management tool used to monitor Node.js applications. @@ -200,7 +200,7 @@ done Kuzzle uses Elasticsearch and Redis as a persistent and key-value store, respectively. If you are running these components on the same machine as your Kuzzle installation then no additional configuration is needed. If; however, you are running them on another host, you will need to create or update the `.kuzzlerc` file in your installation folder. -Please refer to the [configuration section](/core/1/guide/guides/essentials/configuration/) for more details. +Please refer to the [configuration section](/core/1/guides/essentials/configuration/) for more details. ### Setup PM2 @@ -276,7 +276,7 @@ pm2 "" kuzzlebackend ``` ::: success -Now that Kuzzle is up and running you can [install](/core/1/guide/guides/essentials/installing-console/) the Kuzzle Admin Console. +Now that Kuzzle is up and running you can [install](/core/1/guides/essentials/installing-console/) the Kuzzle Admin Console. ::: ### Troubleshooting @@ -327,7 +327,7 @@ Elasticsearch WARNING: 2018-01-12T13:36:34Z No living connections ``` -If you see the following message and your Elasticsearch installation uses a security layer, configure the Elasticsearch client options in the `.kuzzlerc` file. For more information click [here](/core/1/guide/guides/essentials/configuration/). +If you see the following message and your Elasticsearch installation uses a security layer, configure the Elasticsearch client options in the `.kuzzlerc` file. For more information click [here](/core/1/guides/essentials/configuration/). ``` [ℹ] Starting Kuzzle server @@ -353,7 +353,7 @@ If you see the following message make sure that you have installed Redis and tha at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1090:14) ``` -If you see the following message when running `pm2 logs`, then make sure that your `pm2.conf.yml` file was created correctly. +If you see the following message when running `pm2 logs`, then make sure that your `pm2.conf.yml` file was created correctly. To recreate that file: - delete the current version from pm2: `pm2 delete kuzzlebackend` @@ -381,5 +381,5 @@ Once your Kuzzle instance is up and running, dive even deeper to learn how to le - take a look at the [SDK Reference](/sdk) - learn how to use [Koncorde](/core/1/koncorde) to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to [implement basic authentication](/core/1/guide/guides/essentials/user-authentication/#local-strategy). -- follow our guide to learn how to [implement manage users and setup fine-grained access control](/core/1/guide/guides/essentials/security/). +- follow our guide to learn how to [implement basic authentication](/core/1/guides/essentials/user-authentication/#local-strategy). +- follow our guide to learn how to [implement manage users and setup fine-grained access control](/core/1/guides/essentials/security/). diff --git a/src/core/1/guides/essentials/introduction/index.md b/src/core/1/guides/essentials/introduction/index.md index aa22ee8a2..dba95026a 100644 --- a/src/core/1/guides/essentials/introduction/index.md +++ b/src/core/1/guides/essentials/introduction/index.md @@ -36,20 +36,20 @@ You can interact directly with Kuzzle through its API, read the [Kuzzle API refe ## Manage your data -Kuzzle relies on [Elasticsearch](https://www.elastic.co/) to store, fetch and peform a variety of CRUD and fine-grained search operations on persistent data. Please refer to our [working with persistent data](/core/1/guide/guides/essentials/persisted/) section for more details. +Kuzzle relies on [Elasticsearch](https://www.elastic.co/) to store, fetch and peform a variety of CRUD and fine-grained search operations on persistent data. Please refer to our [working with persistent data](/core/1/guides/essentials/persisted/) section for more details. ## Trigger real-time notifications Kuzzle lets you to setup subscriptions on specific datasets in order to trigger real-time notifications based on different data events. To define what events will trigger a notification we use **filters**, which describe what data to observe using a domain-specific language (DSL) that we tailored for this purpose. -Please click [here](/core/1/guide/guides/essentials/real-time/) for more details. +Please click [here](/core/1/guides/essentials/real-time/) for more details. ## Manage Authentication Kuzzle supports a variety of authentication strategies via [Passport.js](http://passportjs.org/). Local and OAuth-based authentication is natively supported, but you can also add your own custom strategy. -Please click [here](/core/1/guide/guides/essentials/security/) for more details. +Please click [here](/core/1/guides/essentials/security/) for more details. ## Customize your backend @@ -61,4 +61,4 @@ Kuzzle can be tailored to your specific requirements thanks to the Plugin Engine - add new communication protocols - add new authentication strategies -Please click [here](/core/1/guide/guides/essentials/plugins/) for more details. +Please click [here](/core/1/guides/essentials/plugins/) for more details. diff --git a/src/core/1/guides/essentials/persisted/index.md b/src/core/1/guides/essentials/persisted/index.md index 1111d217f..04447b09c 100644 --- a/src/core/1/guides/essentials/persisted/index.md +++ b/src/core/1/guides/essentials/persisted/index.md @@ -25,7 +25,7 @@ Kuzzle automatically generates document ids and indexes them. The generated id i ## Creating an Index -We will start off by [**creating a new index**](/core/1/api/api-reference/controller-index/create/) which we will use to store a collection. +We will start off by [**creating a new index**](/core/1/api/controllers/index/create/) which we will use to store a collection. To create a new index, send a `POST` request to the following API endpoint and leave the request body empty: `http://localhost:7512//_create`. @@ -56,7 +56,7 @@ You should receive the following response: ## Creating a Collection -Next, we will [**create a new collection**](/core/1/api/api-reference/controller-collection/create/), which we will use to store documents. +Next, we will [**create a new collection**](/core/1/api/controllers/collection/create/), which we will use to store documents. To create a collection, send a `PUT` request to the following API endpoint and leave the request body empty: `http://localhost:7512//`. @@ -84,13 +84,13 @@ You should receive the following response: } ``` -**Note:** we have just created a new collection without specifying any mappings. As a result, the database layer will automatically create a mapping that assigns a best guess data type to any new field it detects in input documents. Since these mappings cannot be changed once they are created, we strongly recommend that you [**create your own mappings**](/core/1/guide/guides/essentials/database-mappings) as soon as the collection has been created. For the purpose of this tutorial, we will continue without defining our own mappings. +**Note:** we have just created a new collection without specifying any mappings. As a result, the database layer will automatically create a mapping that assigns a best guess data type to any new field it detects in input documents. Since these mappings cannot be changed once they are created, we strongly recommend that you [**create your own mappings**](/core/1/guides/essentials/database-mappings) as soon as the collection has been created. For the purpose of this tutorial, we will continue without defining our own mappings. --- ## Browse Collections -To browse the [**list of collections**](/core/1/api/api-reference/controller-collection/list/) in a given index you can send a `GET` request to the following API endpoint: `http://localhost:7512//_list`. +To browse the [**list of collections**](/core/1/api/controllers/collection/list/) in a given index you can send a `GET` request to the following API endpoint: `http://localhost:7512//_list`. Let's get the list of collections in the `myindex` index: @@ -124,7 +124,7 @@ You should receive the following response: ``` The `result` field in the response contains an array of `collections`, each with its own `name` and a `type`. -Note that the `mycollection`'s type is `stored`, which means it is a persistant store. The `type` allows us to distinguish between persistant store collections and temporary store collections, such as those used for [real-time messaging](/core/1/guide/guides/essentials/real-time/). +Note that the `mycollection`'s type is `stored`, which means it is a persistant store. The `type` allows us to distinguish between persistant store collections and temporary store collections, such as those used for [real-time messaging](/core/1/guides/essentials/real-time/). --- @@ -134,7 +134,7 @@ Kuzzle ships with a full data [CRUD](https://en.wikipedia.org/wiki/Create,_read, ### CREATE -We can [**create a new document**](/core/1/api/api-reference/controller-document/create/) by sending a `POST` request to the following API endpoint and setting the document contents in the request body: `http://localhost:7512///_create`. +We can [**create a new document**](/core/1/api/controllers/document/create/) by sending a `POST` request to the following API endpoint and setting the document contents in the request body: `http://localhost:7512///_create`. Let's create a new document in the `mycollection` collection of the `myindex` index: @@ -190,11 +190,11 @@ You should receive the following response (with your own `_id` value): } ``` -Note that the document contains the auto-generated id `AVkDBl3YsT6qHI7MxLz0`. Take some time to examine the content of the [response](/core/1/guide/guides/essentials/request-and-response-format/#status-codes) message as it contains useful information, like the name of the controller, the action performed in the request, and of course the object we just created in the `source` field. +Note that the document contains the auto-generated id `AVkDBl3YsT6qHI7MxLz0`. Take some time to examine the content of the [response](/core/1/guides/essentials/request-and-response-format/#status-codes) message as it contains useful information, like the name of the controller, the action performed in the request, and of course the object we just created in the `source` field. ### READ -We can [**read a document**](/core/1/api/api-reference/controller-document/get/) by sending a `GET` request to `http://localhost:7512///`. +We can [**read a document**](/core/1/api/controllers/document/get/) by sending a `GET` request to `http://localhost:7512///`. Let's read the document we just created in the `mycollection` collection of the `myindex` index: @@ -235,7 +235,7 @@ You should receive the following response (with your own `_id` value): ### UPDATE -We can [**update a document**](/core/1/api/api-reference/controller-document/update/) by sending a `PUT` request to the following API endpoint and setting the document's updated contents in the request body: `http://localhost:7512////_update`. +We can [**update a document**](/core/1/api/controllers/document/update/) by sending a `PUT` request to the following API endpoint and setting the document's updated contents in the request body: `http://localhost:7512////_update`. Let's update the document we just created, with id `AVkDBl3YsT6qHI7MxLz0`, in the `mycollection` collection of the `myindex` index: @@ -273,7 +273,7 @@ You should receive the following response (with your own `_id` value): ### DELETE -We can [**delete a document**](/core/1/api/api-reference/controller-document/delete/) by sending a `DELETE` request to the following API endpoint with no request body: `http://localhost:7512///`. +We can [**delete a document**](/core/1/api/controllers/document/delete/) by sending a `DELETE` request to the following API endpoint with no request body: `http://localhost:7512///`. Let's delete the document we just created in the `mycollection` collection of the `myindex` index: @@ -312,9 +312,9 @@ You should receive the following response (with your own `_id` value): ## Document Search -One thing that Elasticsearch is _really_ good at doing is... Searching! Thanks to its powerful query DSL it can create extremely precise search queries. We wrote an [Elasticsearch Cookbook](/core/1/guide/elasticsearch) to help you understand how it works in detail, but let's take a look at a couple of simple examples, just to get started. +One thing that Elasticsearch is _really_ good at doing is... Searching! Thanks to its powerful query DSL it can create extremely precise search queries. We wrote an [Elasticsearch Cookbook](/core/1/guides/cookbooks/elasticsearch) to help you understand how it works in detail, but let's take a look at a couple of simple examples, just to get started. -Say we want to [**find**](/core/1/api/api-reference/controller-document/search/) all documents in the `mycollection` collection. Whe can do this by sending a `POST` request to `http://localhost:7512///_search` and setting any search filters in the request body. +Say we want to [**find**](/core/1/api/controllers/document/search/) all documents in the `mycollection` collection. Whe can do this by sending a `POST` request to `http://localhost:7512///_search` and setting any search filters in the request body. As an example, let's create some documents in the `mycollection` collection of the `myindex` index and then search for them: @@ -487,6 +487,6 @@ You should receive the following response (with your own `_id` values): ## What Now? -- Read our [Elasticsearch Cookbook](/core/1/guide/elasticsearch) to learn more about how querying works in Kuzzle -- Use [document metadata](/core/1/guide/guides/essentials/document-metadata/) to find or recover documents -- Keep track of data changes using [Real-time Notifications](/core/1/guide/guides/essentials/real-time/) +- Read our [Elasticsearch Cookbook](/core/1/guides/cookbooks/elasticsearch) to learn more about how querying works in Kuzzle +- Use [document metadata](/core/1/guides/essentials/document-metadata/) to find or recover documents +- Keep track of data changes using [Real-time Notifications](/core/1/guides/essentials/real-time/) diff --git a/src/core/1/guides/essentials/plugins/index.md b/src/core/1/guides/essentials/plugins/index.md index 2b8a45cb8..ac1832152 100644 --- a/src/core/1/guides/essentials/plugins/index.md +++ b/src/core/1/guides/essentials/plugins/index.md @@ -11,7 +11,7 @@ Our prepackaged multi-feature backend solution will meet basic project requireme For example, imagine you are developing a mobile application that accesses a **third-party payment platform**, such as Braintree, through its third-party's API. For **security** reasons, you will want to avoid accessing the third-party's API directly from the mobile device. Also, you will not want users to purchase more items than are currently in stock, so your backend will need to **monitor** what has been purchased. To achieve all this, you will want to develop a custom Plugin that lets Kuzzle communicate directly with the third-party payment platform. -Kuzzle's **[Plugin Engine](/plugins/1)** is a powerful feature that ensures that Kuzzle meets any project requirement: +Kuzzle's **[Plugin Engine](/core/1/plugins)** is a powerful feature that ensures that Kuzzle meets any project requirement: - select from a set of prebuilt plugins (such as the [OAuth2 Authentication Plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth) or the [MQTT Protocol](https://github.com/kuzzleio/protocol-mqtt)). - [create your own plugin](/core/1/plugins/essentials) to meet your specific requirements. @@ -22,19 +22,19 @@ Kuzzle's **[Plugin Engine](/plugins/1)** is a powerful feature that ensures that Plugins are used to extend Kuzzle's functionalities. They are loaded into Kuzzle during startup and share its execution thread. A plugin can implement one or multiple of the following interfaces: -[Hooks](/core/1/plugins/essentials/hooks): adds asynchronous listeners that perform operations triggered by data events. When a listened event occurs, the data is sent to the listeners and Kuzzle continues its process without waiting for the listener to complete. +[Hooks](/core/1/plugins/guides/hooks/): adds asynchronous listeners that perform operations triggered by data events. When a listened event occurs, the data is sent to the listeners and Kuzzle continues its process without waiting for the listener to complete. _Example - "Write a log to a third-party logging service every time a document is deleted"_. The [Logger Plugin](https://github.com/kuzzleio/kuzzle-plugin-logger) (shipped with Kuzzle) uses this feature to log all the data-related events. -[Pipes](/core/1/plugins/essentials/pipes): adds synchronous listeners that perform operations triggered by data events. When a listened event occurs, the data is passed synchronously to listeners, each modifying the input data and returning the result to the next listener. Kuzzle waits until the last listener completes and returns its data. If any listener returns an error, it will interrupt the Kuzzle lifecycle, and the thrown error will be used as a response by Kuzzle. +[Pipes](/core/1/plugins/guides/pipes): adds synchronous listeners that perform operations triggered by data events. When a listened event occurs, the data is passed synchronously to listeners, each modifying the input data and returning the result to the next listener. Kuzzle waits until the last listener completes and returns its data. If any listener returns an error, it will interrupt the Kuzzle lifecycle, and the thrown error will be used as a response by Kuzzle. _Example - "Compare the ordered quantity with the available stock and return an error if the amount of ordered items exceeds the amount in stock"_. -[Controllers](/core/1/plugins/essentials/controllers): extends Kuzzle API. +[Controllers](/core/1/plugins/guides/controllers): extends Kuzzle API. _Example - "Expose a `checkout` API endpoint that handles a third-party payment process"_. -[Strategies](/core/1/plugins/essentials/strategies): add an authentication strategy to identify and authenticate users. +[Strategies](/core/1/plugins/guides/strategies): add an authentication strategy to identify and authenticate users. _Example - "Enable OAuth based authentication in Kuzzle"_ Kuzzle ships with the [Local Strategy Plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local) and thanks to PassportJS, more than 300 authentication strategies are readily available. @@ -168,7 +168,7 @@ ln -s ../available/protocol-mqtt . ## Going Further -To get more insight into how plugins work, please refer to the [Plugin Reference](/plugins/1). +To get more insight into how plugins work, please refer to the [Plugin Reference](/core/1/plugins). Here is a list of official plugins: diff --git a/src/core/1/guides/essentials/real-time/index.md b/src/core/1/guides/essentials/real-time/index.md index 9a4e020b8..d1f8d99ef 100644 --- a/src/core/1/guides/essentials/real-time/index.md +++ b/src/core/1/guides/essentials/real-time/index.md @@ -54,7 +54,7 @@ But, how does this work in Kuzzle? **How do we select the data that we want to s Let's dive into the implementation of the Collaborative TO-DO list application.
-All the following examples are written in Javascript, therefore using the Javascript Kuzzle SDK. If this is not your usual development language, take a look at the different flavors of the `subscribe` method in the [/sdk/js/5/collection/subscribe](SDK Reference)). +All the following examples are written in Javascript, therefore using the Javascript Kuzzle SDK. If this is not your usual development language, take a look at the different flavors of the `subscribe` method in the [/sdk/js/5/core-classes/collection/subscribe](SDK Reference)).
--- @@ -142,7 +142,7 @@ The last point may seem a little bit inconvenient. What if Tom does not want to The `subscribe` method can be called with an extra argument, which is an object containing a set of options to be passed to the subscription Room. We just introduced a new concept here, the Room. A Room is a class representing a single subscription and its constructor is called internally by the `subscribe` method. -This object supports a wide range of options that can be passed directly to its [constructor](/sdk/js/5/room/), allowing to configure the kind of notifications we want to receive. +This object supports a wide range of options that can be passed directly to its [constructor](/sdk/js/5/core-classes/room/), allowing to configure the kind of notifications we want to receive. For now, let's concentrate on the question asked at the end of the previous chapter: how do we filter the notifications resulting of our own actions? The option we are looking for is `subscribeToSelf`, which is set to `true` by default. diff --git a/src/core/1/guides/essentials/request-and-response-format/index.md b/src/core/1/guides/essentials/request-and-response-format/index.md index f0bebdc5c..6208aa67a 100644 --- a/src/core/1/guides/essentials/request-and-response-format/index.md +++ b/src/core/1/guides/essentials/request-and-response-format/index.md @@ -7,7 +7,7 @@ order: 800 # Request and Response Format -Any access to a Kuzzle resource must be made through a [request](https://github.com/kuzzleio/kuzzle-common-objects#request). The `Request` object is [sealed](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/seal), which means you cannot add or delete fields once the object is initialized. The `Request` state evolves along with the [lifecycle of the transaction](/core/1/guide/guides/essentials/request-and-response-format/#request-life-cycle). +Any access to a Kuzzle resource must be made through a [request](https://github.com/kuzzleio/kuzzle-common-objects#request). The `Request` object is [sealed](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/seal), which means you cannot add or delete fields once the object is initialized. The `Request` state evolves along with the [lifecycle of the transaction](/core/1/guides/essentials/request-and-response-format/#request-life-cycle). Let's take a look at the structure of the `Request` object. diff --git a/src/core/1/guides/essentials/security/index.md b/src/core/1/guides/essentials/security/index.md index 7f29f6281..a24e1625d 100644 --- a/src/core/1/guides/essentials/security/index.md +++ b/src/core/1/guides/essentials/security/index.md @@ -15,7 +15,7 @@ Kuzzle provides a full set of functionalities to configure fine-grained permissi When Kuzzle is first installed there is no administrator account and anonymous users (i.e. unauthenticated users) have administrative privileges. -To secure your Kuzzle installation you will need to create an administrator account by either using the [Kuzzle Admin Console](/core/1/guide/guides/essentials/installing-console/#create-an-admin-account) or using the [CLI](/core/1/guide/guides/essentials/cli/#createfirstadmin) tool. +To secure your Kuzzle installation you will need to create an administrator account by either using the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/#create-an-admin-account) or using the [CLI](/core/1/guides/essentials/cli/#createfirstadmin) tool. Once the administrator account is created, you can remove anonymous access rights and properly secure your installation. You can then use the Kuzzle Admin Console or Kuzzle API to create new users and assign them permissions. @@ -47,7 +47,7 @@ A `profile` is linked to a set of `roles`, and each `role` defines a set of perm ![Users, Profiles and Roles](profiles-roles.png) -All `roles` and `profiles` can be edited in the [Kuzzle Admin Console](/core/1/guide/guides/essentials/installing-console/). +All `roles` and `profiles` can be edited in the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/). --- @@ -78,7 +78,7 @@ When `controller` is declared within a Plugin, its name must be prefixed with th The `action permission` value can be set to either: - a boolean. If `true`, the `role` allows the given action. -- an object describing a dynamic right definition. For more information check out the [advanced roles documentation](/core/1/guide/guides/kuzzle-depth/roles-definitions/)). +- an object describing a dynamic right definition. For more information check out the [advanced roles documentation](/core/1/guides/kuzzle-depth/roles-definitions/)). As an example, below is the `role` definition that Kuzzle uses to request authorization from the anonymous user once the administrator account is created and anonymous access is blocked. @@ -98,7 +98,7 @@ As an example, below is the `role` definition that Kuzzle uses to request author ``` -In the above `role` definition, anonymous users can perform the [login](/api/1/controller-auth/login/), [checkToken](/api/1/controller-auth/check-token/), [getCurrentUser](/api/1/controller-auth/get-current-user/) and [getMyRights](/api/1/controller-auth/get-my-rights/) actions of the `auth` controller. +In the above `role` definition, anonymous users can perform the [login](/core/1/api/controllers/auth/login/), [checkToken](/core/1/api/controllers/auth/check-token/), [getCurrentUser](/core/1/api/controllers/auth/get-current-user/) and [getMyRights](/core/1/api/controllers/auth/get-my-rights/) actions of the `auth` controller. For a list of available controllers and actions from Kuzzle's API by sending a `GET` request as follows: @@ -208,6 +208,6 @@ For instance, suppose you have a chat application and you want the users to only There are multiple ways of adding a business logic layer on top of the standard Kuzzle security one: -* With a [Pipe Plugin](/core/1/plugins/essentials/pipes), you can listen to one or multiple [API events](/core/1/plugins/guides/events/), and decide whether you accept a query or document according to your business rules (you can see an example on [Github](https://github.com/kuzzleio/kuzzle-plugin-sample-custom-policies)) +* With a [Pipe Plugin](/core/1/plugins/guides/pipes), you can listen to one or multiple [API events](/core/1/plugins/guides/events/), and decide whether you accept a query or document according to your business rules (you can see an example on [Github](https://github.com/kuzzleio/kuzzle-plugin-sample-custom-policies)) * If all you need is to make sure that submitted documents follow a strict set of formatting rules, you can add [document validators](/core/1/guide/cookbooks/datavalidation/) -* Using Permission Closures, you can add functions directly into role definitions \ No newline at end of file +* Using Permission Closures, you can add functions directly into role definitions \ No newline at end of file diff --git a/src/core/1/guides/essentials/signal-handling/index.md b/src/core/1/guides/essentials/signal-handling/index.md index 4b8a96289..90bfe7b48 100644 --- a/src/core/1/guides/essentials/signal-handling/index.md +++ b/src/core/1/guides/essentials/signal-handling/index.md @@ -24,7 +24,7 @@ Unix signal names: - `SIGPIPE` These signals are the result of a critical error and will force Kuzzle to shutdown. -When one of the aforementioned Unix signals is detected, Kuzzle will first generate a [dump report](/core/1/guide/guides/essentials/cli/#dump) and then shutdown. +When one of the aforementioned Unix signals is detected, Kuzzle will first generate a [dump report](/core/1/guides/essentials/cli/#dump) and then shutdown. ## Normal termination diff --git a/src/core/1/guides/essentials/user-authentication/index.md b/src/core/1/guides/essentials/user-authentication/index.md index 1da6c966b..30aaa0ff5 100644 --- a/src/core/1/guides/essentials/user-authentication/index.md +++ b/src/core/1/guides/essentials/user-authentication/index.md @@ -9,15 +9,15 @@ order: 750 ## Creating Users -Once we have created security [roles and profiles](/core/1/guide/guides/essentials/security/), we can go on to create the users that will access the Kuzzle. +Once we have created security [roles and profiles](/core/1/guides/essentials/security/), we can go on to create the users that will access the Kuzzle. -Users can be created by either using the [Kuzzle Admin Console](/core/1/guide/guides/essentials/installing-console/) or the [API](/core/1/api/api-reference/controller-security/create-user/). +Users can be created by either using the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/) or the [API](/core/1/api/controllers/security/create-user/). -When creating a user, you will need to assign them one or more [profiles](/core/1/guide/guides/essentials/security/#defining-profiles). +When creating a user, you will need to assign them one or more [profiles](/core/1/guides/essentials/security/#defining-profiles). Additionally, you can set: -- [User credentials](/core/1/guide/guides/essentials/user-authentication/#user-credentials): If no credentials are provided, then the user cannot [login](/core/1/api/api-reference/controller-auth/login/) +- [User credentials](/core/1/guides/essentials/user-authentication/#user-credentials): If no credentials are provided, then the user cannot [login](/core/1/api/controllers/auth/login/) - Any number of properties that you want to store in your user object, such as a lastname or a list of hobbies. These properties are stored at the user level and are not linked to any particular authentication strategy. Let's create a user with username `johndoe` and password `letmein` using the HTTP API: @@ -63,15 +63,15 @@ When a user is created, Kuzzle will automatically generate a random unique ident This system allows a user to login to Kuzzle using different strategies and, potentially, different login identifiers, while still being considered as an unique entity by Kuzzle. -If you're interested for a more in-depth explanation on how all of this work, then please check our [Kuzzle In-Depth Documentation](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid). +If you're interested for a more in-depth explanation on how all of this work, then please check our [Kuzzle In-Depth Documentation](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid). --- ## Authentication Strategies -Once a user has been created, they can access resources in Kuzzle as permitted by their security profile. However; in order to access these resources they will first need to identify & authenticate themselves using an authentication strategy. The authentication strategy defines what credentials are used and how Kuzzle should validate them. Kuzzle supports multiple authentication strategies, giving you more flexibility when building your security layer: use [OAuth](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth), Kerberos, Salesforce, and many more. And, if none of these suit your needs, follow our [Plugin Documentation](/core/1/plugins/essentials/strategies) to learn how to build a custom authentication strategy. +Once a user has been created, they can access resources in Kuzzle as permitted by their security profile. However; in order to access these resources they will first need to identify & authenticate themselves using an authentication strategy. The authentication strategy defines what credentials are used and how Kuzzle should validate them. Kuzzle supports multiple authentication strategies, giving you more flexibility when building your security layer: use [OAuth](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth), Kerberos, Salesforce, and many more. And, if none of these suit your needs, follow our [Plugin Documentation](/core/1/plugins/guides/strategies) to learn how to build a custom authentication strategy. -To request access to Kuzzle, a user must first send an [authentication request](/core/1/api/api-reference/controller-auth/login/). Kuzzle will validate the credentials it receives in the request using the predefined authentication strategy and return a [JSON Web Token](https://tools.ietf.org/html/rfc7519) if the user credentials are valid. +To request access to Kuzzle, a user must first send an [authentication request](/core/1/api/controllers/auth/login/). Kuzzle will validate the credentials it receives in the request using the predefined authentication strategy and return a [JSON Web Token](https://tools.ietf.org/html/rfc7519) if the user credentials are valid. The JSON Web Token must then be [appended to all subsequent requests](/core/1/api/essentials/query-syntax/) to access Kuzzle resources. diff --git a/src/core/1/guides/getting-started/first-steps/index.md b/src/core/1/guides/getting-started/first-steps/index.md index 1165eba33..e6604b560 100644 --- a/src/core/1/guides/getting-started/first-steps/index.md +++ b/src/core/1/guides/getting-started/first-steps/index.md @@ -96,7 +96,7 @@ document created ```
-You have now successfully stored your first document into Kuzzle. Click core/1/guide/guides/essentials/installing-console/">here to see how you can use the +You have now successfully stored your first document into Kuzzle. Click core/1/guides/essentials/installing-console/">here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
@@ -120,7 +120,7 @@ Run your file in Node.js node create.js ``` -This creates a new document in Kuzzle, triggering a [notification](/core/1/guide/guides/essentials/real-time/): +This creates a new document in Kuzzle, triggering a [notification](/core/1/guides/essentials/real-time/): ```bash subscribe ok @@ -142,5 +142,5 @@ Now that you're more familiar with Kuzzle, dive even deeper to learn how to leve - take a look at the [/sdk](SDK Reference) - learn how to use [/core/1/koncorde](Koncorde) to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to implement [/core/1/guide/guides/essentials/user-authentication/#local-strategy](basic authentication) -- follow our guide to learn how to implement [/core/1/guide/guides/essentials/security/](manage users and setup fine-grained access control) +- follow our guide to learn how to implement [/core/1/guides/essentials/user-authentication/#local-strategy](basic authentication) +- follow our guide to learn how to implement [/core/1/guides/essentials/security/](manage users and setup fine-grained access control) diff --git a/src/core/1/guides/getting-started/running-kuzzle/index.md b/src/core/1/guides/getting-started/running-kuzzle/index.md index a339103dd..787a5213d 100644 --- a/src/core/1/guides/getting-started/running-kuzzle/index.md +++ b/src/core/1/guides/getting-started/running-kuzzle/index.md @@ -19,7 +19,7 @@ bash -c "$(curl https://get.kuzzle.io/)" This command downloads and executes the installation script. The script checks the system for a set of prerequisites and installs missing ones, such as [Docker](https://www.docker.com/). When the installation is complete, it will automatically run Kuzzle. ::: info -There are also more [alternative ways](/core/1/guide/guides/essentials/installing-kuzzle/) to install Kuzzle. +There are also more [alternative ways](/core/1/guides/essentials/installing-kuzzle/) to install Kuzzle. ::: This command downloads, installs and runs Kuzzle. @@ -51,7 +51,7 @@ Congratulations! You have completed the Kuzzle installation, it will now accept Having trouble? - Get in touch with us on [Gitter!](https://gitter.im/kuzzleio/kuzzle) We're happy to help. -- Try one of [these](/core/1/guide/guides/essentials/installing-kuzzle/) alternative installation methods. +- Try one of [these](/core/1/guides/essentials/installing-kuzzle/) alternative installation methods. ::: @@ -69,6 +69,6 @@ If you want to run Kuzzle automatically at startup there are a few scripts in `$ Now that Kuzzle is up and running, you can start playing around with it: - install and learn a [Kuzzle SDK](/sdk/) to power-up one of your projects -- install [Kuzzle Admin Console](/core/1/guide/guides/essentials/installing-console/), a handy way to manage data and security in your Kuzzle installation +- install [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/), a handy way to manage data and security in your Kuzzle installation - explore the [Kuzzle API](/core/1/api) documentation -- install Kuzzle [without Docker](/core/1/guide/guides/essentials/installing-kuzzle/#manual-installation) +- install Kuzzle [without Docker](/core/1/guides/essentials/installing-kuzzle/#manual-installation) diff --git a/src/core/1/guides/kuzzle-depth/architecture/index.md b/src/core/1/guides/kuzzle-depth/architecture/index.md index 719054762..e795dc75d 100644 --- a/src/core/1/guides/kuzzle-depth/architecture/index.md +++ b/src/core/1/guides/kuzzle-depth/architecture/index.md @@ -19,7 +19,7 @@ The diagram above depicts the various components that make up the server archite - **Funnel**: receives normalized requests and forwards it to the appropriate controller, sends results back to the _Entry Points_. - **Controllers**: receives data fom the _Funnel_, processes it, and returns a result to the _Funnel_ (see [API reference](/core/1/api)). - **Internal Components**: are internal modules used by controllers to process a request. -- **Service Components**: are interfaces used by controllers to connect to external services (see [below](/core/1/guide/guides/kuzzle-depth//#services)). +- **Service Components**: are interfaces used by controllers to connect to external services (see [below](/core/1/guides/kuzzle-depth//#services)). ## Services diff --git a/src/core/1/guides/kuzzle-depth/authentication/index.md b/src/core/1/guides/kuzzle-depth/authentication/index.md index 2da248b44..7a9ce636e 100644 --- a/src/core/1/guides/kuzzle-depth/authentication/index.md +++ b/src/core/1/guides/kuzzle-depth/authentication/index.md @@ -12,14 +12,14 @@ Kuzzle uses [Passport.js](http://Passportjs.org/) to support numerous authentica - SAML: for authentication using providers such as OneLogin and for supporting single sign-on. - Local: for authentication using a user's username and password managed in your own domain. -In the diagram below, we highlighted components of Kuzzle's server [architecture](/core/1/guide/kuzzle-depth) that are used in the authentication process: +In the diagram below, we highlighted components of Kuzzle's server [architecture](/core/1/guides/kuzzle-depth) that are used in the authentication process: ![read_scenario_http_overview](./Authentication_Overview.png) - The Auth Controller: to manage the authentication process. - The Passport Wrapper: to interface between Kuzzle and the Passport.js library. - The User and Token [Repositories](https://github.com/kuzzleio/kuzzle/tree/master/lib/api/core/models/repositories): to store user data. -- The Auth Strategy: to identify and validate a user's credential using a [dedicated plugin](/core/1/plugins/essentials/strategies). +- The Auth Strategy: to identify and validate a user's credential using a [dedicated plugin](/core/1/plugins/guides/strategies). --- @@ -194,6 +194,6 @@ Location: http://< kuzzle >/_login/github?code=OAUTH2_CODE ## Additional Authentication Strategies -Kuzzle can implement any strategy supported by Passport.js. For more information, please refer to the [Plugins Reference](/core/1/plugins/essentials/strategies). +Kuzzle can implement any strategy supported by Passport.js. For more information, please refer to the [Plugins Reference](/core/1/plugins/guides/strategies). --- diff --git a/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md b/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md index acda8fcb4..b80db44eb 100644 --- a/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md +++ b/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md @@ -12,7 +12,7 @@ Kuzzle has two main modes of communication: - **Synchronous**: Clients send requests to the Kuzzle server, which processes the data using the [Document Controller](/core/1/api/controller-document) and then sends a response back to the client. -- **Asynchronous**: Clients subscribe to the Kuzzle server via the [Real-time/Subscribe](/core/1/api/api-reference/controller-realtime/publish/) API action and receive data asynchronously as a result of a [Real-time/Publish](/core/1/api/api-reference/controller-realtime/publish/) API action or a [Document Controller](/core/1/api/controller-document) event. +- **Asynchronous**: Clients subscribe to the Kuzzle server via the [Real-time/Subscribe](/core/1/api/controllers/realtime/publish/) API action and receive data asynchronously as a result of a [Real-time/Publish](/core/1/api/controllers/realtime/publish/) API action or a [Document Controller](/core/1/api/controller-document) event. These modes of communication are generally independant from the transport protocol. For example, a synchronous request can be made via HTTP or Websockets. @@ -28,7 +28,7 @@ Depending on the transport protocol used to communicate with the Kuzzle server, ### Synchronous Request using HTTP Protocol -In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guide/kuzzle-depth) that are used in a read request using HTTP: +In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guides/kuzzle-depth) that are used in a read request using HTTP: ![read_scenario_http_overview](Synchronous_Request_HTTP_Protocol_Overview.png) @@ -86,7 +86,7 @@ The following diagram shows how a request flows between the client application, ### Synchronous Request using Websocket Protocol -In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guide/kuzzle-depth) that are used in a read request using Websockets: +In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guides/kuzzle-depth) that are used in a read request using Websockets: ![read_scenario_websocket_overview](Synchronous_Request_Websocket_Protocol_Overview.png) @@ -170,7 +170,7 @@ In an asynchronous request, Kuzzle server will receive a request over one channe This form of communication is generally referred to as publish/subscribe, because on the one side a client is **subscribing** to a channel and on the other side a client is **publishing** to a channel. -This subsection describes the life-cycle of real-time notifications which implement the [Publish/Subscribe](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) pattern. In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guide/kuzzle-depth) that are used in this pattern: +This subsection describes the life-cycle of real-time notifications which implement the [Publish/Subscribe](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) pattern. In the diagram below, we highlighted the components of Kuzzle's server [architecture](/core/1/guides/kuzzle-depth) that are used in this pattern: ![pubsub_overview](Asynchronous_Communication_Overview.png) #### Subscribing to a Channel @@ -179,7 +179,7 @@ The following diagram shows how a client can subscribe to a channel. ![pubsub_scenario_details1](Asynchronous_Communication_Subscription.png) -- The client application opens a socket (or MQ) connection, sends a subscription request (see the [API Documentation](/core/1/api/api-reference/controller-realtime/subscribe/)), and then listens for the `< requestId >` event on the socket. The subscription request is a message that contains a filter description that defines which events should trigger a response. For instance, the following filter will trigger a response anytime content is posted to the `users` collection that contains the field `hobby` with value `computer` (see the [Koncorde Reference](/core/1/koncorde/) for more details): +- The client application opens a socket (or MQ) connection, sends a subscription request (see the [API Documentation](/core/1/api/controllers/realtime/subscribe/)), and then listens for the `< requestId >` event on the socket. The subscription request is a message that contains a filter description that defines which events should trigger a response. For instance, the following filter will trigger a response anytime content is posted to the `users` collection that contains the field `hobby` with value `computer` (see the [Koncorde Reference](/core/1/koncorde/) for more details): ```javascript { @@ -249,7 +249,7 @@ The following diagram shows how a client can subscribe to a channel. #### Publishing to a Channel Directly -The following diagram shows how the Kuzzle server triggers a response as a result of a publish request made using the [Real-time/Publish](/core/1/api/api-reference/controller-realtime/publish/) action. +The following diagram shows how the Kuzzle server triggers a response as a result of a publish request made using the [Real-time/Publish](/core/1/api/controllers/realtime/publish/) action. ![pubsub_scenario_details2](Asynchronous_Communication_Publishing_Directly.png) diff --git a/src/core/1/guides/kuzzle-depth/roles-definitions/index.md b/src/core/1/guides/kuzzle-depth/roles-definitions/index.md index 0ec8a3de5..03a7e4850 100644 --- a/src/core/1/guides/kuzzle-depth/roles-definitions/index.md +++ b/src/core/1/guides/kuzzle-depth/roles-definitions/index.md @@ -6,13 +6,13 @@ title: Dynamic Roles Definitions # Dynamic Roles Definitions -In the [Getting Started Guide](/core/1/guide/guides/essentials/security/#user-permissions), we discussed how to assign basic permissions to users through roles and profiles. We are now going to look at more complex and dynamic permissions. +In the [Getting Started Guide](/core/1/guides/essentials/security/#user-permissions), we discussed how to assign basic permissions to users through roles and profiles. We are now going to look at more complex and dynamic permissions. By definition, permissions only control to what API actions users can access depending on their profiles, without conditions. But there are times when more dynamic rules are needed, for instance when an API action can only be executed if the payload matches some arbitrary business rules. -This can be address either with a [**Pipe Plugin**](/core/1/plugins/essentials/pipes), or **Permission Closures**. +This can be address either with a [**Pipe Plugin**](/core/1/plugins/guides/pipes), or **Permission Closures**. --- @@ -20,7 +20,7 @@ This can be address either with a [**Pipe Plugin**](/core/1/plugins/essentials/p -Permission closures are deprecated in favor of [Pipe Plugin](/core/1/plugins/essentials/pipes), which are more flexible and simpler to use. +Permission closures are deprecated in favor of [Pipe Plugin](/core/1/plugins/guides/pipes), which are more flexible and simpler to use. With Permission Closures, instead of hard-coding the permission boolean value, we assign a function (or closure) that evaluates to a boolean value and determines whether or not an action is permitted. @@ -51,8 +51,8 @@ For example, here is a role definition that limits access to documents such that In the definition above: -- `test` is the body of [the permission function](/core/1/guide/guides/kuzzle-depth/roles-definitions/#the-permission-function) -- `args` is the parameter given to [the fetch definition function](/core/1/guide/guides/kuzzle-depth/roles-definitions/#the-fetch-definition) +- `test` is the body of [the permission function](/core/1/guides/kuzzle-depth/roles-definitions/#the-permission-function) +- `args` is the parameter given to [the fetch definition function](/core/1/guides/kuzzle-depth/roles-definitions/#the-fetch-definition) --- @@ -82,13 +82,13 @@ function ($request, $currentUserId, args) { There are a set of predefined variables which are automatically accessible in a Permission Function, these are: - `$request`: The complete [request](https://github.com/kuzzleio/kuzzle-common-objects#request) object being evaluated. -- `$currentUserId`: The current user [``](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) (equivalent to `request.context.token.userId`). +- `$currentUserId`: The current user [``](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) (equivalent to `request.context.token.userId`). #### Permission Function Args The main purpose of the "closure" behavior is to grant permissions based on the current state of the storage layer. This means that, in order to determine if an action can be granted, we will first need to fetch documents used in the permission function from the storage layer. -Documents fetched from the storage layer are stored in the `args` object as defined by the [fetch definition](/core/1/guide/guides/kuzzle-depth/roles-definitions/#the-fetch-definition). +Documents fetched from the storage layer are stored in the `args` object as defined by the [fetch definition](/core/1/guides/kuzzle-depth/roles-definitions/#the-fetch-definition). Each `args` object will look like: @@ -138,7 +138,7 @@ We define the Fetch Definition in a `args` object with the following structure: } ``` -You can define one or more variables inside the `args` object and, for each variable, define the action used to populate it. Each of these variables will then be available in the [permission function](/core/1/guide/guides/kuzzle-depth/roles-definitions/#the-permission-function), accessible in the `args` object as follows: `args.`. +You can define one or more variables inside the `args` object and, for each variable, define the action used to populate it. Each of these variables will then be available in the [permission function](/core/1/guides/kuzzle-depth/roles-definitions/#the-permission-function), accessible in the `args` object as follows: `args.`. #### Fetch Definition Actions @@ -215,7 +215,7 @@ args.myDocuments = [ ##### SEARCH -The `search` action type performs a search on the persistence layer and returns the resulting documents. It is a typical [document search](/core/1/guide/guides/essentials/persisted/#document-search). For example: +The `search` action type performs a search on the persistence layer and returns the resulting documents. It is a typical [document search](/core/1/guides/essentials/persisted/#document-search). For example: ```javascript { diff --git a/src/core/1/koncorde/essentials/introduction/index.md b/src/core/1/koncorde/essentials/introduction/index.md index 09672b437..8ce021e52 100644 --- a/src/core/1/koncorde/essentials/introduction/index.md +++ b/src/core/1/koncorde/essentials/introduction/index.md @@ -11,8 +11,8 @@ description: Introduction to Koncorde [Koncorde](https://www.npmjs.com/package/koncorde) is a data percolation engine and is part of Kuzzle's real-time engine. It is used to: -- trigger notifications on [real-time subscriptions](/core/1/guide/guides/essentials/real-time/) -- [perform data validation](/core/1/guide/guides/essentials/data-validation/) +- trigger notifications on [real-time subscriptions](/core/1/guides/essentials/real-time/) +- [perform data validation](/core/1/guides/essentials/data-validation/) Koncorde exposes a [DSL](https://wikipedia.org/en/Domain-specific_language) that enables you to define filters you can apply to any stream of data and be notified whenever the content of the stream matches the filter. @@ -21,7 +21,7 @@ This paradigm is called "percolation" and is the foundation of Kuzzle's real-tim In other words, a percolation engine is the inverse of a search engine, where data is indexed and filters are used to retrieve data that matches them. -**This is different from document search [read more about how to search persistent data](/core/1/guide/guides/essentials/persisted/#document-search).** +**This is different from document search [read more about how to search persistent data](/core/1/guides/essentials/persisted/#document-search).** A data percolation engine has the following properties: @@ -37,7 +37,7 @@ data**, for example, by defining a bounding polgon and checking whether the poin contained in your data are contained or not in it. If you are looking for information about how to setup a live data subscription -in Kuzzle, please refer to [the specific docs in the Essentials section](/core/1/guide/guides/essentials/real-time/). +in Kuzzle, please refer to [the specific docs in the Essentials section](/core/1/guides/essentials/real-time/). ## Quick start diff --git a/src/core/1/plugins/essentials/getting-started/index.md b/src/core/1/plugins/essentials/getting-started/index.md index 4f325340f..860438f2e 100644 --- a/src/core/1/plugins/essentials/getting-started/index.md +++ b/src/core/1/plugins/essentials/getting-started/index.md @@ -40,7 +40,7 @@ The main Plugin class is defined in the `index.js`. You can start edit it adding We need to provide the `configuration` and the `context` to plugins. In that purpose, plugins must have an `init` function which will have them as parameters : this `init` function is the very first one to be called by Kuzzle and is mandatory to start a plugin. You can now write your own functions and your own routes as described inside the `index.js`. You can also write unit tests : see `steps.js`.
-You can find more information about the init function here. +You can find more information about the init function here.
You have now everything you need to start writing your own Kuzzle plugin. diff --git a/src/core/1/plugins/guides/controllers/index.md b/src/core/1/plugins/guides/controllers/index.md index 87329cc96..36b12bf3a 100644 --- a/src/core/1/plugins/guides/controllers/index.md +++ b/src/core/1/plugins/guides/controllers/index.md @@ -11,7 +11,7 @@ Kuzzle's API is divided into controllers, each exposing executable actions (see Plugins can extend Kuzzle's API by adding new controllers to it. -[Security access](/core/1/guide/guides/essentials/security/) to plugin controllers must be given (or denied), using the exact same way as with native API controllers. +[Security access](/core/1/guides/essentials/security/) to plugin controllers must be given (or denied), using the exact same way as with native API controllers. --- diff --git a/src/core/1/plugins/guides/events/api-events/index.md b/src/core/1/plugins/guides/events/api-events/index.md index a12220990..2d6a1e2f6 100644 --- a/src/core/1/plugins/guides/events/api-events/index.md +++ b/src/core/1/plugins/guides/events/api-events/index.md @@ -21,7 +21,7 @@ All API actions, without exception, trigger two of these three events: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | A `before` event is triggered before an API request starts. @@ -38,8 +38,8 @@ The `before` event name is built using the following template: | API action | After event name | | -------------------------------------------------------------------------------------------- | -------------------------------- | -| [auth:login](/core/1/api/api-reference/controller-auth/login/) | `auth:beforeLogin` | -| [document:createOrReplace](/core/1/api/api-reference/controller-document/create-or-replace/) | `document:beforeCreateOrReplace` | +| [auth:login](/core/1/api/controllers/auth/login/) | `auth:beforeLogin` | +| [document:createOrReplace](/core/1/api/controllers/document/create-or-replace/) | `document:beforeCreateOrReplace` | --- @@ -47,7 +47,7 @@ The `before` event name is built using the following template: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | An `after` event is triggered after an API request succeeds. @@ -64,8 +64,8 @@ The `after` event name is built using the following template: | API action | After event name | | -------------------------------------------------------------------------------------------- | ------------------------------- | -| [auth:login](/core/1/api/api-reference/controller-auth/login/) | `auth:afterLogin` | -| [document:createOrReplace](/core/1/api/api-reference/controller-document/create-or-replace/) | `document:afterCreateOrReplace` | +| [auth:login](/core/1/api/controllers/auth/login/) | `auth:afterLogin` | +| [document:createOrReplace](/core/1/api/controllers/document/create-or-replace/) | `document:afterCreateOrReplace` | --- @@ -73,7 +73,7 @@ The `after` event name is built using the following template: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | An `error` event is triggered after an API request fails. @@ -90,5 +90,5 @@ The `error` event name is built using the following template: | API action | After event name | | -------------------------------------------------------------------------------------------- | ------------------------------- | -| [auth:login](/core/1/api/api-reference/controller-auth/login/) | `auth:errorLogin` | -| [document:createOrReplace](/core/1/api/api-reference/controller-document/create-or-replace/) | `document:errorCreateOrReplace` | +| [auth:login](/core/1/api/controllers/auth/login/) | `auth:errorLogin` | +| [document:createOrReplace](/core/1/api/controllers/document/create-or-replace/) | `document:errorCreateOrReplace` | diff --git a/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md b/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md index ef1c9bd72..b11ccb853 100644 --- a/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md +++ b/src/core/1/plugins/guides/events/auth-strategy-authenticated/index.md @@ -10,7 +10,7 @@ title: auth:strategyAuthenticated | Arguments | Type | Description | | ---------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `strategy` | 
string
| [Authentication strategy](/core/1/guide/guides/essentials/user-authentication/#authentication-strategies-default) name | +| `strategy` | 
string
| [Authentication strategy](/core/1/guides/essentials/user-authentication/#authentication-strategies-default) name | | `user` | 
object
| Authenticated user properties | This event is triggered after a successful user authentication, but before a token is generated. @@ -25,5 +25,5 @@ The provided `user` object has the following properties: | Properties | Type | Description | | ------------ | ------------------- | ----------------------------------------------------------------------------------------------- | -| `_id` | 
string
| User's [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `_id` | 
string
| User's [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `profileIds` | 
string[]
| List of associated profiles | diff --git a/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md b/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md index aa6b6f792..e003860fd 100644 --- a/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md +++ b/src/core/1/plugins/guides/events/core-auth-strategy-added/index.md @@ -26,4 +26,4 @@ The provided `strategy` object has the following properties: | ------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------- | | `pluginName` | 
string
| The plugin's name defined in the [manifest file](/core/1/plugins/essentials/getting-started/#prerequisites-default) | | `name` | 
string
| Authentication strategy name | -| `strategy` | 
object
| Authentication [strategy properties](/core/1/plugins/essentials/strategies/#managing-credentials-default) | +| `strategy` | 
object
| Authentication [strategy properties](/core/1/plugins/guides/strategies/#managing-credentials-default) | diff --git a/src/core/1/plugins/guides/events/core-overload/index.md b/src/core/1/plugins/guides/events/core-overload/index.md index f08f0f358..d1aec10ed 100644 --- a/src/core/1/plugins/guides/events/core-overload/index.md +++ b/src/core/1/plugins/guides/events/core-overload/index.md @@ -14,7 +14,7 @@ title: core:overload Triggered when the requests buffer fills up more quickly than requests can be processed. -The requests buffer is configurable through the `limits` parameters in the [Kuzzle configuration](/core/1/guide/guides/essentials/configuration/). +The requests buffer is configurable through the `limits` parameters in the [Kuzzle configuration](/core/1/guides/essentials/configuration/). Requests submitted while the request buffer is completely filled (i.e. the payload is equal to `100`) are rejected with a [ServiceUnavailableError](/core/1/api/essentials/errors/#common-errors-default) (code `503`) diff --git a/src/core/1/plugins/guides/events/http-delete/index.md b/src/core/1/plugins/guides/events/http-delete/index.md index c36bb86ce..1057af4a1 100644 --- a/src/core/1/plugins/guides/events/http-delete/index.md +++ b/src/core/1/plugins/guides/events/http-delete/index.md @@ -10,6 +10,6 @@ title: http:delete | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP DELETE methods. diff --git a/src/core/1/plugins/guides/events/http-get/index.md b/src/core/1/plugins/guides/events/http-get/index.md index 6e0aafc76..e19e896ae 100644 --- a/src/core/1/plugins/guides/events/http-get/index.md +++ b/src/core/1/plugins/guides/events/http-get/index.md @@ -10,6 +10,6 @@ title: http:get | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP GET methods. diff --git a/src/core/1/plugins/guides/events/http-head/index.md b/src/core/1/plugins/guides/events/http-head/index.md index 9c6c40ee6..d146c2192 100644 --- a/src/core/1/plugins/guides/events/http-head/index.md +++ b/src/core/1/plugins/guides/events/http-head/index.md @@ -10,6 +10,6 @@ title: http:head | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP HEAD methods. diff --git a/src/core/1/plugins/guides/events/http-options/index.md b/src/core/1/plugins/guides/events/http-options/index.md index 0293a7c96..2709963ab 100644 --- a/src/core/1/plugins/guides/events/http-options/index.md +++ b/src/core/1/plugins/guides/events/http-options/index.md @@ -10,6 +10,6 @@ title: http:options | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP OPTIONS methods. diff --git a/src/core/1/plugins/guides/events/http-patch/index.md b/src/core/1/plugins/guides/events/http-patch/index.md index c5bd06d51..f3d93d88a 100644 --- a/src/core/1/plugins/guides/events/http-patch/index.md +++ b/src/core/1/plugins/guides/events/http-patch/index.md @@ -10,6 +10,6 @@ title: http:patch | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP PATCH methods. diff --git a/src/core/1/plugins/guides/events/http-post/index.md b/src/core/1/plugins/guides/events/http-post/index.md index bd92a2b64..1ce734683 100644 --- a/src/core/1/plugins/guides/events/http-post/index.md +++ b/src/core/1/plugins/guides/events/http-post/index.md @@ -10,6 +10,6 @@ title: http:post | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP POST methods. diff --git a/src/core/1/plugins/guides/events/http-put/index.md b/src/core/1/plugins/guides/events/http-put/index.md index 0cf4e6f52..77f4782a3 100644 --- a/src/core/1/plugins/guides/events/http-put/index.md +++ b/src/core/1/plugins/guides/events/http-put/index.md @@ -10,6 +10,6 @@ title: http:put | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request has been submitted through HTTP PUT methods. diff --git a/src/core/1/plugins/guides/events/notify-dispatch/index.md b/src/core/1/plugins/guides/events/notify-dispatch/index.md index 3c13bc226..100c5321d 100644 --- a/src/core/1/plugins/guides/events/notify-dispatch/index.md +++ b/src/core/1/plugins/guides/events/notify-dispatch/index.md @@ -14,4 +14,4 @@ title: notify:dispatch Triggered whenever a real-time notification is about to be sent. -A [pipe](/core/1/plugins/essentials/pipes/) can block some (or all) notifications by rejecting the provided promise. +A [pipe](/core/1/plugins/guides/pipes/) can block some (or all) notifications by rejecting the provided promise. diff --git a/src/core/1/plugins/guides/events/notify-document/index.md b/src/core/1/plugins/guides/events/notify-document/index.md index 59289e324..d93a08275 100644 --- a/src/core/1/plugins/guides/events/notify-document/index.md +++ b/src/core/1/plugins/guides/events/notify-document/index.md @@ -14,4 +14,4 @@ title: notify:document Triggered whenever a real-time document notification is about to be sent. -A [pipe](/core/1/plugins/essentials/pipes/) can block some (or all) notifications by rejecting the provided promise. +A [pipe](/core/1/plugins/guides/pipes/) can block some (or all) notifications by rejecting the provided promise. diff --git a/src/core/1/plugins/guides/events/notify-server/index.md b/src/core/1/plugins/guides/events/notify-server/index.md index 9f1450f81..62add3968 100644 --- a/src/core/1/plugins/guides/events/notify-server/index.md +++ b/src/core/1/plugins/guides/events/notify-server/index.md @@ -14,4 +14,4 @@ title: notify:server Triggered whenever a real-time server notification is about to be sent. -A [pipe](/core/1/plugins/essentials/pipes/) can block some (or all) notifications by rejecting the provided promise. +A [pipe](/core/1/plugins/guides/pipes/) can block some (or all) notifications by rejecting the provided promise. diff --git a/src/core/1/plugins/guides/events/notify-user/index.md b/src/core/1/plugins/guides/events/notify-user/index.md index 3a220f4c0..a1628d0dd 100644 --- a/src/core/1/plugins/guides/events/notify-user/index.md +++ b/src/core/1/plugins/guides/events/notify-user/index.md @@ -14,4 +14,4 @@ title: notify:user Triggered whenever a real-time user notification is about to be sent. -A [pipe](/core/1/plugins/essentials/pipes/) can block some (or all) notifications by rejecting the provided promise. +A [pipe](/core/1/plugins/guides/pipes/) can block some (or all) notifications by rejecting the provided promise. diff --git a/src/core/1/plugins/guides/events/plugin-events/index.md b/src/core/1/plugins/guides/events/plugin-events/index.md index 07b8c7c0e..8748c0f7d 100644 --- a/src/core/1/plugins/guides/events/plugin-events/index.md +++ b/src/core/1/plugins/guides/events/plugin-events/index.md @@ -9,7 +9,7 @@ order: 200 -Plugins can [add new controllers](/core/1/plugins/essentials/controllers) to the Kuzzle API. +Plugins can [add new controllers](/core/1/plugins/guides/controllers) to the Kuzzle API. These new controllers and actions behave exactly like [native API actions](/core/1/plugins/guides/events/api-events/). All calls to plugins API actions trigger two of these three events: @@ -24,7 +24,7 @@ All calls to plugins API actions trigger two of these three events: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | A `before` event is triggered before a plugin API request starts. @@ -50,7 +50,7 @@ The `before` event name is built using the following template: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | An `after` event is triggered after a plugin API request succeeds. @@ -76,7 +76,7 @@ The `after` event name is built using the following template: | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | An `error` event is triggered after a plugin API request fails. diff --git a/src/core/1/plugins/guides/events/request-on-authorized/index.md b/src/core/1/plugins/guides/events/request-on-authorized/index.md index 71de9afd6..386b954c4 100644 --- a/src/core/1/plugins/guides/events/request-on-authorized/index.md +++ b/src/core/1/plugins/guides/events/request-on-authorized/index.md @@ -10,7 +10,7 @@ title: request:onAuthorized | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request passes authorization checks and is ready to be processed. diff --git a/src/core/1/plugins/guides/events/request-on-error/index.md b/src/core/1/plugins/guides/events/request-on-error/index.md index b064c750e..46732e721 100644 --- a/src/core/1/plugins/guides/events/request-on-error/index.md +++ b/src/core/1/plugins/guides/events/request-on-error/index.md @@ -10,7 +10,7 @@ title: request:onError | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request execution fails. diff --git a/src/core/1/plugins/guides/events/request-on-success/index.md b/src/core/1/plugins/guides/events/request-on-success/index.md index d8c6b40f8..9a844c4b9 100644 --- a/src/core/1/plugins/guides/events/request-on-success/index.md +++ b/src/core/1/plugins/guides/events/request-on-success/index.md @@ -10,7 +10,7 @@ title: request:onSuccess | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request execution succeeds. diff --git a/src/core/1/plugins/guides/events/request-on-unauthorized/index.md b/src/core/1/plugins/guides/events/request-on-unauthorized/index.md index 5717b247a..47278be7c 100644 --- a/src/core/1/plugins/guides/events/request-on-unauthorized/index.md +++ b/src/core/1/plugins/guides/events/request-on-unauthorized/index.md @@ -10,6 +10,6 @@ title: request:onUnauthorized | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | -------------------------- | -| `request` | 
Request
| The normalized API request | +| `request` | 
Request
| The normalized API request | Triggered whenever a request fails authorization checks, and is about to be rejected with a `401` error code. diff --git a/src/core/1/plugins/guides/events/room-new/index.md b/src/core/1/plugins/guides/events/room-new/index.md index 2133fdf1b..dff7fdd5d 100644 --- a/src/core/1/plugins/guides/events/room-new/index.md +++ b/src/core/1/plugins/guides/events/room-new/index.md @@ -12,7 +12,7 @@ title: room:new | --------- | ----------------- | ----------------------- | | `room` | 
object
| Joined room information | -Triggered whenever a new [subscription](/core/1/api/api-reference/controller-realtime/subscribe/) is created. +Triggered whenever a new [subscription](/core/1/api/controllers/realtime/subscribe/) is created.
Pipes cannot listen to that event, only hooks can.
diff --git a/src/core/1/plugins/guides/manual-setup/config/index.md b/src/core/1/plugins/guides/manual-setup/config/index.md index 2019f9b5b..023bb15eb 100644 --- a/src/core/1/plugins/guides/manual-setup/config/index.md +++ b/src/core/1/plugins/guides/manual-setup/config/index.md @@ -10,7 +10,7 @@ order: 1 When Kuzzle calls the plugin `init` method, it passes the plugin's custom configuration to it. -Custom configuration parameters are specified for each plugin in the `plugins` object of the Kuzzle [configuration file](/core/1/guide/guides/essentials/configuration/). +Custom configuration parameters are specified for each plugin in the `plugins` object of the Kuzzle [configuration file](/core/1/guides/essentials/configuration/). For example: diff --git a/src/core/1/plugins/guides/manual-setup/init-function/index.md b/src/core/1/plugins/guides/manual-setup/init-function/index.md index 83f9de12b..9420a952c 100644 --- a/src/core/1/plugins/guides/manual-setup/init-function/index.md +++ b/src/core/1/plugins/guides/manual-setup/init-function/index.md @@ -29,6 +29,6 @@ init(config, context); The `init` function can optionally return a promise. If it does, Kuzzle waits for the promise to be resolved before continuing its own initialization. -If a promise is returned, it must be resolved within the configured timeout (see `plugins.common.initTimeout` in Kuzzle's [configuration](/core/1/guide/guides/essentials/configuration/)) +If a promise is returned, it must be resolved within the configured timeout (see `plugins.common.initTimeout` in Kuzzle's [configuration](/core/1/guides/essentials/configuration/)) If a promise is returned and rejected, or if the `init` function throws an error, Kuzzle aborts its start sequence and shuts down. diff --git a/src/core/1/plugins/guides/pipes/index.md b/src/core/1/plugins/guides/pipes/index.md index 247b95670..e2fecaacb 100644 --- a/src/core/1/plugins/guides/pipes/index.md +++ b/src/core/1/plugins/guides/pipes/index.md @@ -14,7 +14,7 @@ Pipes can: - Decide to abort a task. If a pipe throws an error, Kuzzle interrupts the task, and forwards a standardized version of the thrown error to the originating user - Change the received information. Kuzzle will use the updated information upon resuming the task -
If a pipe takes too long to respond, Kuzzle will eventually abort the entire task with a GatewayTimeout error. The timeout value can be changed in the configuration files.
+
If a pipe takes too long to respond, Kuzzle will eventually abort the entire task with a GatewayTimeout error. The timeout value can be changed in the configuration files.
--- @@ -34,9 +34,9 @@ If multiple pipes are plugged to the same event (either from the same plugin or Pipes must notify Kuzzle about their completion by one of these two means: - by calling the `callback(error, request)` function received as their last argument (leave the `error` null if the pipe executed successfully) -- by returning a promise, resolved (or rejected) with a valid [Request](/core/1/guide/guides/essentials/request-and-response-format/) upon the completion of the pipe +- by returning a promise, resolved (or rejected) with a valid [Request](/core/1/guides/essentials/request-and-response-format/) upon the completion of the pipe -
You must either call the callback with a valid Request or return a promise resolving to one.
+
You must either call the callback with a valid Request or return a promise resolving to one.
If a pipe throws an error, it is advised to throw one of the available [KuzzleError](/core/1/plugins/plugin-context/errors/kuzzleerror) object. Otherwise, Kuzzle will reject the task with a `PluginImplementationError` error. diff --git a/src/core/1/plugins/guides/strategies/auth-functions/index.md b/src/core/1/plugins/guides/strategies/auth-functions/index.md index c5253c308..5f3f937c6 100644 --- a/src/core/1/plugins/guides/strategies/auth-functions/index.md +++ b/src/core/1/plugins/guides/strategies/auth-functions/index.md @@ -11,15 +11,15 @@ The `methods` part of the `strategies` object can contain the following properti | Arguments | Type | Description | | --------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `create` | 
string
| The name of the exposed [create](/core/1/plugins/essentials/strategies/#create-default) function | -| `delete` | 
string
| The name of the exposed [delete](/core/1/plugins/essentials/strategies/#delete-default) function | -| `exists` | 
string
| The name of the exposed [exists](/core/1/plugins/essentials/strategies/#exists-default) function | -| `update` | 
string
| The name of the exposed [update](/core/1/plugins/essentials/strategies/#update-default) function | -| `validate` | 
string
| The name of the exposed [validate](/core/1/plugins/essentials/strategies/#update-default) function | -| `verify` | 
string
| The name of the exposed [verify](/core/1/plugins/essentials/strategies/#verify-default) function | -| `afterRegister` | 
string
| (optional) The name of the exposed [afterRegister](/core/1/plugins/essentials/strategies/#optional-afterregister-default) function | -| `getById` | 
string
| (optional) The name of the exposed [getById](/core/1/plugins/essentials/strategies/#optional-getbyid-default) function | -| `getInfo` | 
string
| (optional) The name of the exposed [getInfo](/core/1/plugins/essentials/strategies/#optional-getinfo-default) function | +| `create` | 
string
| The name of the exposed [create](/core/1/plugins/guides/strategies/#create-default) function | +| `delete` | 
string
| The name of the exposed [delete](/core/1/plugins/guides/strategies/#delete-default) function | +| `exists` | 
string
| The name of the exposed [exists](/core/1/plugins/guides/strategies/#exists-default) function | +| `update` | 
string
| The name of the exposed [update](/core/1/plugins/guides/strategies/#update-default) function | +| `validate` | 
string
| The name of the exposed [validate](/core/1/plugins/guides/strategies/#update-default) function | +| `verify` | 
string
| The name of the exposed [verify](/core/1/plugins/guides/strategies/#verify-default) function | +| `afterRegister` | 
string
| (optional) The name of the exposed [afterRegister](/core/1/plugins/guides/strategies/#optional-afterregister-default) function | +| `getById` | 
string
| (optional) The name of the exposed [getById](/core/1/plugins/guides/strategies/#optional-getbyid-default) function | +| `getInfo` | 
string
| (optional) The name of the exposed [getInfo](/core/1/plugins/guides/strategies/#optional-getinfo-default) function | Even though each strategy must declare its own set of properties, the same strategy method can be used by multiple strategies. @@ -43,9 +43,9 @@ create(request, credentials, kuid, strategy); | Arguments | Type | Description | | ------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| `request` | 
Request
| API request asking for the credentials creation | +| `request` | 
Request
| API request asking for the credentials creation | | `credentials` | 
object
| New credentials to create, already validated by this strategy's [validate](#validate) function | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy used by these credentials | ### Returned value @@ -70,8 +70,8 @@ delete (request, kuid, strategy); | Arguments | Type | Description | | ---------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| `request` | 
Request
| API request asking for the credentials deletion | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `request` | 
Request
| API request asking for the credentials deletion | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy name | ### Returned value @@ -94,8 +94,8 @@ exists(request, kuid, strategy); | Arguments | Type | Description | | ---------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| `request` | 
Request
| Source API request | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `request` | 
Request
| Source API request | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy name | ### Returned value @@ -118,9 +118,9 @@ update(request, credentials, kuid, strategy); | Arguments | Type | Description | | ------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `request` | 
Request
| Source API request | +| `request` | 
Request
| Source API request | | `credentials` | 
object
| Updated credentials.
Those are already validated by this strategy's [validate](#validate) function | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy name | ### Returned value @@ -145,9 +145,9 @@ validate(request, credentials, kuid, strategy, isUpdate); | Arguments | Type | Description | | ------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `request` | 
Request
| Source API request | +| `request` | 
Request
| Source API request | | `credentials` | 
object
| Credentials to validate | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy name | | `isUpdate` | 
boolean
| Tells whether the request is a credentials update. In the case of an update, the `credentials` object may only contain changes to be applied, instead of a complete credentials description | @@ -185,7 +185,7 @@ The `payload` object has the following properties: | Properties | Type | Description | | ---------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `original` | 
Request
| Source API login request | +| `original` | 
Request
| Source API login request | | `query` | 
object
| Direct link to `original.input.args`, containing the optional request arguments | | `body` | 
object
| Direct link to `original.input.body`, containing the request body content | @@ -197,7 +197,7 @@ The `verify` function must return a promise, resolving to an object with the fol | Properties | Type | Description | | ---------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `kuid` | 
string
| If the authentication succeeds, this property must be set to the user's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid). Otherwise, this must be set to `null` | +| `kuid` | 
string
| If the authentication succeeds, this property must be set to the user's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid). Otherwise, this must be set to `null` | | `message` | 
string
| If `kuid` is set to `null` (authentication failed), this optional property can be set with a rejection reason |
A failed authentication is not an error. The returned promise should only be rejected if an actual error occurs.
@@ -224,7 +224,7 @@ afterRegister(strategyInstance); ## (optional) getById -The `getById` function returns credentials information using the authentication strategy's user identifier (which may not be the [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid)). +The `getById` function returns credentials information using the authentication strategy's user identifier (which may not be the [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid)). If this function is not implemented, an empty object is returned by Kuzzle instead. @@ -240,7 +240,7 @@ getById(request, id, strategy); | Arguments | Type | Description | | ---------- | -------------------------------------------------------------- | -------------------------------------------------- | -| `request` | 
Request
| The API request asking for credentials information | +| `request` | 
Request
| The API request asking for credentials information | | `id` | 
string
| Strategy's user identifier | | `strategy` | 
string
| Authentication strategy name | @@ -268,8 +268,8 @@ getInfo(request, kuid, strategy); | Arguments | Type | Description | | ---------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| `request` | 
Request
| The API request asking for credentials information | -| `kuid` | 
string
| User's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | +| `request` | 
Request
| The API request asking for credentials information | +| `kuid` | 
string
| User's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid) | | `strategy` | 
string
| Authentication strategy name | ### Returned value diff --git a/src/core/1/plugins/guides/strategies/overview/index.md b/src/core/1/plugins/guides/strategies/overview/index.md index 681209af1..d7576fb90 100644 --- a/src/core/1/plugins/guides/strategies/overview/index.md +++ b/src/core/1/plugins/guides/strategies/overview/index.md @@ -37,7 +37,7 @@ To do so, Kuzzle guarantees that it never interprets, modifies, or stores creden Instead, Kuzzle: -- provides a global user unique identifier (referred from now on as the user's [kuid](/core/1/guide/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid)), giving the possibility to a user to authenticate with multiple strategies +- provides a global user unique identifier (referred from now on as the user's [kuid](/core/1/guides/kuzzle-depth/authentication/#the-kuzzle-user-identifier-kuid)), giving the possibility to a user to authenticate with multiple strategies - entrusts implemented strategies with credentials protection, validation, verification and storage --- @@ -62,8 +62,8 @@ The `config` part of the `strategies` object can contain the following propertie | Arguments | Type | Description | | --------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authenticator` | 
string
| One of the exposed [authenticators](/core/1/plugins/essentials/strategies/#registering-authentication-strategies-default) name | +| `authenticator` | 
string
| One of the exposed [authenticators](/core/1/plugins/guides/strategies/#registering-authentication-strategies-default) name | | `constructor` | 
object
| (use the `authenticator` property instead)
The constructor of the Passport.js strategy. Does not support [dynamic strategy registration](/core/1/plugins/plugin-context/accessors/strategies) | | `authenticateOptions` | 
object
| (optional) Additional options to be provided to the Passport's [authenticate method](http://passportjs.org/docs/authenticate) | -| `fields` | 
string[]
| (optional) The list of accepted field names by the strategy credentials.
The list is informative only, meant to be used by the [getAllCredentialFields](/core/1/api/api-reference/controller-security/get-all-credential-fields/) and the [getCredentialFields](/core/1/api/api-reference/controller-security/get-credential-fields/) API methods | +| `fields` | 
string[]
| (optional) The list of accepted field names by the strategy credentials.
The list is informative only, meant to be used by the [getAllCredentialFields](/core/1/api/controllers/security/get-all-credential-fields/) and the [getCredentialFields](/core/1/api/controllers/security/get-credential-fields/) API methods | | `strategyOptions` | 
object
| (optional) Options provided to the Passport.js strategy constructor | diff --git a/src/core/1/plugins/plugin-context/accessors/execute/index.md b/src/core/1/plugins/plugin-context/accessors/execute/index.md index 22f337b3e..84b38ce26 100644 --- a/src/core/1/plugins/plugin-context/accessors/execute/index.md +++ b/src/core/1/plugins/plugin-context/accessors/execute/index.md @@ -22,7 +22,7 @@ execute(request, [callback]); | Arguments | Type | Description | | ---------- | -------------------------------------------------------------- | ---------------------------------------------- | -| `request` | 
Request
 | The API query to execute | +| `request` | 
Request
 | The API query to execute | | `callback` | 
function
| Callback to call with the API execution result | --- diff --git a/src/core/1/plugins/plugin-context/accessors/sdk/index.md b/src/core/1/plugins/plugin-context/accessors/sdk/index.md index 4dea0e7ed..7250430ca 100644 --- a/src/core/1/plugins/plugin-context/accessors/sdk/index.md +++ b/src/core/1/plugins/plugin-context/accessors/sdk/index.md @@ -19,7 +19,7 @@ Also, the low-level [query](/sdk/js/6/core-classes/kuzzle/query/) method is avai By default, when using the embedded SDK, requests made to Kuzzle API don't have the same context as the original request received by the plugin. -Typically, the `request.context.user` property is not set and thus [Kuzzle metadata](/core/1/guide/guides/essentials/document-metadata/) will not be set when creating or updating documents. +Typically, the `request.context.user` property is not set and thus [Kuzzle metadata](/core/1/guides/essentials/document-metadata/) will not be set when creating or updating documents. It is possible to use the same user context as the original request with the embedded SDK, for this purpose it is necessary to use the [as()](/core/1/plugins/plugin-context/accessors/sdk/#as) impersonation method. @@ -31,14 +31,14 @@ When the complete original context is needed to execute your request, plugin dev The following controllers are available in the embedded SDK: -- [auth](/sdk/js/6/auth) -- [bulk](/sdk/js/6/bulk) -- [collection](/sdk/js/6/collection) -- [document](/sdk/js/6/document) -- [index](/sdk/js/6/index) +- [auth](/sdk/js/6/controllers/auth) +- [bulk](/sdk/js/6/controllers/bulk) +- [collection](/sdk/js/6/controllers/collection) +- [document](/sdk/js/6/controllers/document) +- [index](/sdk/js/6/controllers/index) - [memoryStorage (ms)](/sdk/js/6/ms) -- [security](/sdk/js/6/security) -- [server](/sdk/js/6/server) +- [security](/core/1/api/controllers/security) +- [server](/sdk/js/6/controllers/server) ### Example diff --git a/src/core/1/plugins/plugin-context/accessors/storage/index.md b/src/core/1/plugins/plugin-context/accessors/storage/index.md index 755a74926..7a16e3db2 100644 --- a/src/core/1/plugins/plugin-context/accessors/storage/index.md +++ b/src/core/1/plugins/plugin-context/accessors/storage/index.md @@ -10,7 +10,7 @@ Initializes the plugin's private data storage. Data stored in this space can only be accessed by their proprietary plugin, using the [Repository](/core/1/plugins/plugin-context/constructors/repository) constructor. -The only way documents stored in this space can be accessed using Kuzzle is if the plugin voluntarily exposes that data by [adding new API routes](/core/1/plugins/essentials/controllers/). +The only way documents stored in this space can be accessed using Kuzzle is if the plugin voluntarily exposes that data by [adding new API routes](/core/1/plugins/guides/controllers/). --- @@ -32,7 +32,7 @@ bootstrap(collections); | Arguments | Type | Description | | ------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `collections` | 
object
| List of collection to create, with their corresponding [data mapping](/core/1/guide/guides/essentials/persisted/#document-mapping) | +| `collections` | 
object
| List of collection to create, with their corresponding [data mapping](/core/1/guides/essentials/persisted/#document-mapping) | ### Return @@ -84,7 +84,7 @@ createCollection(collection, mapping); | Arguments | Type | Description | | ------------ | ----------------- | --------------------------------------------------------------------------------- | | `collection` | 
string
| Collection name | -| `mapping` | 
object
| Collection [mapping](/core/1/guide/guides/essentials/persisted/#document-mapping) | +| `mapping` | 
object
| Collection [mapping](/core/1/guides/essentials/persisted/#document-mapping) | ### Return diff --git a/src/core/1/plugins/plugin-context/accessors/strategies/index.md b/src/core/1/plugins/plugin-context/accessors/strategies/index.md index ce2c64502..45949490c 100644 --- a/src/core/1/plugins/plugin-context/accessors/strategies/index.md +++ b/src/core/1/plugins/plugin-context/accessors/strategies/index.md @@ -6,7 +6,7 @@ title: strategies # strategies -Dynamically adds or removes [authentication strategies](/core/1/plugins/essentials/strategies). +Dynamically adds or removes [authentication strategies](/core/1/plugins/guides/strategies). --- @@ -33,7 +33,7 @@ add(name, properties); | Arguments | Type | Description | | ------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------- | | `name` | 
string
| Name of the new authentication strategy | -| `properties` | 
object
| Strategy properties (see [managing credentials](/core/1/plugins/essentials/strategies/#managing-credentials-default)) | +| `properties` | 
object
| Strategy properties (see [managing credentials](/core/1/plugins/guides/strategies/#managing-credentials-default)) | ### Return diff --git a/src/core/1/plugins/plugin-context/accessors/validation/index.md b/src/core/1/plugins/plugin-context/accessors/validation/index.md index fa5e91edf..6100e9431 100644 --- a/src/core/1/plugins/plugin-context/accessors/validation/index.md +++ b/src/core/1/plugins/plugin-context/accessors/validation/index.md @@ -6,7 +6,7 @@ title: validation # validation -Accessor to the [data validation API](/core/1/guide/datavalidation) +Accessor to the [data validation API](/core/1/guides/cookbooks/datavalidation) --- @@ -46,7 +46,7 @@ validate(request, [verbose]); | Arguments | Type | Description | | --------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `request` | 
Request
 | Request object with a non-empty body content | +| `request` | 
Request
 | Request object with a non-empty body content | | `verbose` | 
boolean
| If true, returns an exhaustive validation report, instead of failing at the first error encountered | ### Return diff --git a/src/core/1/plugins/plugin-context/constructors/request/index.md b/src/core/1/plugins/plugin-context/constructors/request/index.md index 305c77964..8ed4aa392 100644 --- a/src/core/1/plugins/plugin-context/constructors/request/index.md +++ b/src/core/1/plugins/plugin-context/constructors/request/index.md @@ -58,7 +58,7 @@ The `options` argument accepts the following parameters: | -------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `connection` | 
object
| Connection information (see the connection object documentation) | | `connectionId` | 
string
| Connection unique identifier | -| `error` | 
KuzzleError, Error
| Sets the request response with the provided error | +| `error` | 
KuzzleError, Error
| Sets the request response with the provided error | | `requestId` | 
string
| User-defined request identifier | | `result` | 
\*
| Sets the request response with the provided result, and the request status is set to `200` | | `status` | 
integer
| Request status, following the [HTTP error code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) standard | @@ -72,7 +72,7 @@ Read-only: | Property | Type | Description | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | `context` | 
RequestContext
| General request information (logged user, network information, ...) | -| `error` | 
KuzzleError
| Request error | +| `error` | 
KuzzleError
| Request error | | `input` | 
RequestInput
| Input request representation | | `response` | 
RequestResponse
| Serialized [request response](/core/1/api/essentials/kuzzle-response) | | `result` | 
\*
| Request result | @@ -128,7 +128,7 @@ setError(error); | Arguments | Type | Description | | --------- | ---------------------------------------------------- | ------------- | -| `error` | 
KuzzleError
| Request error | +| `error` | 
KuzzleError
| Request error | If a `KuzzleError` object is provided, the request's status attribute is set to the error one. diff --git a/src/core/1/plugins/plugin-context/errors/partialerror/index.md b/src/core/1/plugins/plugin-context/errors/partialerror/index.md index f2e555ec4..c41f8fd12 100644 --- a/src/core/1/plugins/plugin-context/errors/partialerror/index.md +++ b/src/core/1/plugins/plugin-context/errors/partialerror/index.md @@ -21,7 +21,7 @@ new context.error.PartialError(message, failures); | Arguments | Type | Description | | ---------- | ------------------------------------------------------------------ | -------------------------- | | `message` | 
string
| Error message | -| `failures` | 
KuzzleError[]
| List of encountered errors | +| `failures` | 
KuzzleError[]
| List of encountered errors | ## Status Code diff --git a/src/core/1/plugins/plugin-context/log/intro/index.md b/src/core/1/plugins/plugin-context/log/intro/index.md index ebaf3f345..5337311e2 100644 --- a/src/core/1/plugins/plugin-context/log/intro/index.md +++ b/src/core/1/plugins/plugin-context/log/intro/index.md @@ -13,7 +13,7 @@ Each plugin receives its own context instance, provided to the plugin's [init fu This section documents the `context.log` object, exposing functions used to send messages to Kuzzle's logging system. -Log levels are assigned to each exposed log function, corresponding to the log priority. +Log levels are assigned to each exposed log function, corresponding to the log priority. The lower the log level, the higher its priority. -Levels above the threshold configued in the `logs` section of Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/) are ignored. +Levels above the threshold configued in the `logs` section of Kuzzle's [configuration file](/core/1/guides/essentials/configuration/) are ignored. diff --git a/src/core/1/protocols/api/context/clientconnection/index.md b/src/core/1/protocols/api/context/clientconnection/index.md index 3ddeed036..67404d957 100644 --- a/src/core/1/protocols/api/context/clientconnection/index.md +++ b/src/core/1/protocols/api/context/clientconnection/index.md @@ -8,7 +8,7 @@ title: ClientConnection -The `ClientConnection` class must be instantiated whenever a new client connection is created, and that instance must be provided to the [entryPoint.newConnection](/core/1/protocols/entrypoint/newconnection) method. +The `ClientConnection` class must be instantiated whenever a new client connection is created, and that instance must be provided to the [entryPoint.newConnection](/core/1/protocols/api/entrypoint/newconnection) method. --- diff --git a/src/core/1/protocols/api/context/errors/index.md b/src/core/1/protocols/api/context/errors/index.md index d8a7ae23f..b031b76df 100644 --- a/src/core/1/protocols/api/context/errors/index.md +++ b/src/core/1/protocols/api/context/errors/index.md @@ -140,7 +140,7 @@ const err = new context.errors.NotFoundError('error message'); / -Parse error. Use [BadRequestError](/core/1/protocols/context/errors/#badrequesterror-default) instead. +Parse error. Use [BadRequestError](/core/1/protocols/api/context/errors/#badrequesterror-default) instead. ### Status Code @@ -171,7 +171,7 @@ new context.error.PartialError(message, errors); | Arguments | Type | Description | | ---------- | ------------------------------------------------------------------------------------------ | -------------------------- | | `message` | 
string
| Error message | -| `failures` | 
KuzzleError[]
| List of encountered errors | +| `failures` | 
KuzzleError[]
| List of encountered errors | ### Status Code diff --git a/src/core/1/protocols/api/context/intro/index.md b/src/core/1/protocols/api/context/intro/index.md index f4306cc80..e4f87b871 100644 --- a/src/core/1/protocols/api/context/intro/index.md +++ b/src/core/1/protocols/api/context/intro/index.md @@ -9,4 +9,4 @@ order: 0 The `context` object contains general functions and objects used to interact with Kuzzle. -This object is passed to the protocol [init](/core/1/protocols/essentials/init/) method. +This object is passed to the protocol [init](/core/1/protocols/api/methods/init//) method. diff --git a/src/core/1/protocols/api/context/log/index.md b/src/core/1/protocols/api/context/log/index.md index 4e73c40e7..bc91ff337 100644 --- a/src/core/1/protocols/api/context/log/index.md +++ b/src/core/1/protocols/api/context/log/index.md @@ -8,10 +8,10 @@ title: log The `context.log` object exposes functions used to send messages to Kuzzle's logging system. -Log levels are assigned to each exposed log function, corresponding to the log priority. +Log levels are assigned to each exposed log function, corresponding to the log priority. The lower the log level, the higher its priority. -Levels above the threshold configued in the `logs` section of Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/) are ignored. +Levels above the threshold configued in the `logs` section of Kuzzle's [configuration file](/core/1/guides/essentials/configuration/) are ignored. --- diff --git a/src/core/1/protocols/api/context/request/index.md b/src/core/1/protocols/api/context/request/index.md index 84090270b..b4c989097 100644 --- a/src/core/1/protocols/api/context/request/index.md +++ b/src/core/1/protocols/api/context/request/index.md @@ -8,7 +8,7 @@ title: Request -Object representation of a Kuzzle [API call](/core/1/api/essentials/query-syntax), to be used with the [entryPoint.execute](/core/1/protocols/entrypoint/execute) function. +Object representation of a Kuzzle [API call](/core/1/api/essentials/query-syntax), to be used with the [entryPoint.execute](/core/1/protocols/api/entrypoint/execute) function. That object is continuously updated to reflect the current state of the request, during its entire lifecycle. @@ -45,7 +45,7 @@ The `options` object can contain the following properties: | -------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `connection` | `object` | Connection information (see the connection object documentation) | | `connectionId` | `string` | Connection unique identifier | -| `error` | KuzzleError,
Error | Sets the request response with the provided error | +| `error` | KuzzleError,
Error | Sets the request response with the provided error | | `requestId` | `string` | User-defined request identifier | | `result` | `*` | Sets the request response with the provided result, and the request status is set to `200` | | `status` | `integer` | Request status, following the [HTTP error code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) standard | @@ -59,7 +59,7 @@ Read-only: | Properties | Type | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | `context` | `RequestContext` | General request information (logged user, network information, ...) | -| `error` | `KuzzleError | Request error | +| `error` | `KuzzleError | Request error | | `input` | `RequestInput` | Input request representation | | `response` | `RequestResponse` | Serialized [request response](/core/1/api/essentials/kuzzle-response) | | `result` | `*` | Request result | @@ -115,11 +115,11 @@ setError(error); | Arguments | Type | Description | | --------- | ----------------------------------------------------------------- | ------------- | -| `error` | `KuzzleError, Error` | Request error | +| `error` | `KuzzleError, Error` | Request error | If a `KuzzleError` object is provided, the request's status attribute is set to the error one. -Otherwise, the provided error is embedded into a [InternalError](/core/1/protocols/context/errors/#internalerror-default) object, and the request status is set to 500. +Otherwise, the provided error is embedded into a [InternalError](/core/1/protocols/api/context/errors/#internalerror-default) object, and the request status is set to 500. --- diff --git a/src/core/1/protocols/api/context/requestcontext/index.md b/src/core/1/protocols/api/context/requestcontext/index.md index 0cdd99d87..74c9e61d2 100644 --- a/src/core/1/protocols/api/context/requestcontext/index.md +++ b/src/core/1/protocols/api/context/requestcontext/index.md @@ -8,7 +8,7 @@ title: RequestContext Connection context. -This is the class used to build the `context` property of any [Request](/core/1/protocols/context/request) object. +This is the class used to build the `context` property of any [Request](/core/1/protocols/api/context/request) object. Technical information: [github repository](https://github.com/kuzzleio/kuzzle-common-objects/blob/master/README.md#modelsrequestcontext) @@ -32,7 +32,7 @@ The `options` object can contain the following properties: | Properties | Type | Description | | ------------ | ---------------------------------------------------------------------------------- | -------------------------------- | -| `connection` | 
ClientConnection
| Connection information | +| `connection` | 
ClientConnection
| Connection information | | `token` | 
string
| Authorization token | | `user` | 
object
| Kuzzle internal user information | @@ -42,6 +42,6 @@ The `options` object can contain the following properties: | Properties | Type | Description | | ------------ | ---------------------------------------------------------------------------------- | -------------------------------- | -| `connection` | 
ClientConnection
| Connection information | +| `connection` | 
ClientConnection
| Connection information | | `token` | 
string
| Authorization token | | `user` | 
object
| Kuzzle internal user information | diff --git a/src/core/1/protocols/api/context/requestinput/index.md b/src/core/1/protocols/api/context/requestinput/index.md index 98e4edbcf..3bf06fcb8 100644 --- a/src/core/1/protocols/api/context/requestinput/index.md +++ b/src/core/1/protocols/api/context/requestinput/index.md @@ -8,7 +8,7 @@ title: RequestInput Request input, normalizing a [Kuzzle API call](/core/1/api/essentials/query-syntax/#other-protocols-default) in JSON format. -This is the class used to build the `input` property of any [Request](/core/1/protocols/context/request) object. +This is the class used to build the `input` property of any [Request](/core/1/protocols/api/context/request) object. Technical information: [github repository](https://github.com/kuzzleio/kuzzle-common-objects/blob/master/README.md#modelsrequestinput) diff --git a/src/core/1/protocols/api/entrypoint/execute/index.md b/src/core/1/protocols/api/entrypoint/execute/index.md index e917221ed..964b13512 100644 --- a/src/core/1/protocols/api/entrypoint/execute/index.md +++ b/src/core/1/protocols/api/entrypoint/execute/index.md @@ -24,14 +24,14 @@ execute(request, [callback]); | Arguments | Type | Description | | ---------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `request` | 
Request
| The API query to execute | +| `request` | 
Request
| The API query to execute | | `callback` | 
function
| Callback to call with the API execution result.
If not provided, `execute` returns a promise instead | --- ## Return -The `execute` function resolves to an updated Request object, with its [response part](/core/1/protocols/context/request) set. +The `execute` function resolves to an updated Request object, with its [response part](/core/1/protocols/api/context/request) set. How the response is returned depends whether a callback argument is provided: diff --git a/src/core/1/protocols/api/entrypoint/intro/index.md b/src/core/1/protocols/api/entrypoint/intro/index.md index f6e96d7f0..e8d19331a 100644 --- a/src/core/1/protocols/api/entrypoint/intro/index.md +++ b/src/core/1/protocols/api/entrypoint/intro/index.md @@ -7,7 +7,7 @@ order: 0 # Properties -An instance of the `EntryPoint` class is provided as an argument to the protocol's required [init](/core/1/protocols/essentials/init) function. +An instance of the `EntryPoint` class is provided as an argument to the protocol's required [init](/core/1/protocols/api/methods/init/) function. That instance contains the necessary methods to make Kuzzle aware of user connections, and to pass API requests to Kuzzle. @@ -17,6 +17,6 @@ That instance contains the necessary methods to make Kuzzle aware of user connec | Properties | Type | Description | | ---------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `config` | 
object
| Link to the `server` section of Kuzzle's [configuration](/core/1/guide/guides/essentials/configuration/) file. Custom configuration for the protocol can be found at the following path:
`entryPoint.config.protocols.` | +| `config` | 
object
| Link to the `server` section of Kuzzle's [configuration](/core/1/guides/essentials/configuration/) file. Custom configuration for the protocol can be found at the following path:
`entryPoint.config.protocols.` | | `httpServer` | 
object
| Kuzzle's [HTTP server](https://nodejs.org/dist/latest-v8.x/docs/api/http.html#http_class_http_server) | | `isShuttingDown` | 
boolean
| If `true`, then this Kuzzle node is shutting down, and it will kill itself once all ongoing requests are finished. This flag should be checked regularly and the network protocol should not accept any new request when it is active | diff --git a/src/core/1/protocols/api/entrypoint/newconnection/index.md b/src/core/1/protocols/api/entrypoint/newconnection/index.md index 9c99d31ff..6fb0d6c8e 100644 --- a/src/core/1/protocols/api/entrypoint/newconnection/index.md +++ b/src/core/1/protocols/api/entrypoint/newconnection/index.md @@ -22,7 +22,7 @@ newConnection(connection); | Arguments | Type | Description | | ------------ | ---------------------------------------------------------------------------------- | ------------------- | -| `connection` | 
ClientConnection
| New user connection | +| `connection` | 
ClientConnection
| New user connection | --- diff --git a/src/core/1/protocols/api/entrypoint/removeconnection/index.md b/src/core/1/protocols/api/entrypoint/removeconnection/index.md index 7834afff4..12852db9d 100644 --- a/src/core/1/protocols/api/entrypoint/removeconnection/index.md +++ b/src/core/1/protocols/api/entrypoint/removeconnection/index.md @@ -22,4 +22,4 @@ removeConnection(connectionId); | Arguments | Type | Description | | -------------- | ----------------- | ---------------------------------------------------------------------------------------------- | -| `connectionId` | 
string
| The [ClientConnection](/core/1/protocols/context/clientconnection) unique identifier to remove | +| `connectionId` | 
string
| The [ClientConnection](/core/1/protocols/api/context/clientconnection) unique identifier to remove | diff --git a/src/core/1/protocols/api/methods/disconnect/index.md b/src/core/1/protocols/api/methods/disconnect/index.md index 5a7fcb419..cdf677c31 100644 --- a/src/core/1/protocols/api/methods/disconnect/index.md +++ b/src/core/1/protocols/api/methods/disconnect/index.md @@ -20,7 +20,7 @@ disconnect(connectionId); | Arguments | Type | Description | | -------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/entrypoint/newconnection) | +| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/api/entrypoint/newconnection) | --- diff --git a/src/core/1/protocols/api/methods/init/index.md b/src/core/1/protocols/api/methods/init/index.md index 920325b47..8e29c5826 100644 --- a/src/core/1/protocols/api/methods/init/index.md +++ b/src/core/1/protocols/api/methods/init/index.md @@ -22,8 +22,8 @@ init(entryPoint, context); | Arguments | Type | Description | | ------------ | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `entryPoint` | 
EntryPoint
| Provides an interface to protocol related methods | -| `context` | 
context
| Generic interface exposing objects and methods not directly related to the network layer | +| `entryPoint` | 
EntryPoint
| Provides an interface to protocol related methods | +| `context` | 
context
| Generic interface exposing objects and methods not directly related to the network layer | --- @@ -31,6 +31,6 @@ init(entryPoint, context); The `init` function can optionally return a promise. If it does, Kuzzle waits for the promise to be resolved before continuing its own initialization. -If a promise is returned, it must be resolved within the configured timeout (see `services.common.defaultInitTimeout` in Kuzzle's [configuration](/core/1/guide/guides/essentials/configuration/)) +If a promise is returned, it must be resolved within the configured timeout (see `services.common.defaultInitTimeout` in Kuzzle's [configuration](/core/1/guides/essentials/configuration/)) If a promise is returned and rejected, or if the `init` function throws an error, Kuzzle aborts its start sequence and shuts down. diff --git a/src/core/1/protocols/api/methods/joinchannel/index.md b/src/core/1/protocols/api/methods/joinchannel/index.md index 4be69a83a..de36aa326 100644 --- a/src/core/1/protocols/api/methods/joinchannel/index.md +++ b/src/core/1/protocols/api/methods/joinchannel/index.md @@ -21,7 +21,7 @@ joinChannel(channel, connectionId); | Arguments | Type | Description | | -------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `channel` | 
string
| Joined channel identifier | -| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/entrypoint/newconnection) | +| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/api/entrypoint/newconnection) | --- diff --git a/src/core/1/protocols/api/methods/leavechannel/index.md b/src/core/1/protocols/api/methods/leavechannel/index.md index 36e6a7778..870e6fe98 100644 --- a/src/core/1/protocols/api/methods/leavechannel/index.md +++ b/src/core/1/protocols/api/methods/leavechannel/index.md @@ -21,7 +21,7 @@ leaveChannel(channel, connectionId); | Arguments | Type | Description | | -------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `channel` | 
string
| Left channel identifier | -| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/entrypoint/newconnection) | +| `connectionId` | 
string
| Connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/api/entrypoint/newconnection) | --- diff --git a/src/core/1/protocols/api/methods/notify/index.md b/src/core/1/protocols/api/methods/notify/index.md index 5e0a349e2..00fe93f9f 100644 --- a/src/core/1/protocols/api/methods/notify/index.md +++ b/src/core/1/protocols/api/methods/notify/index.md @@ -15,7 +15,7 @@ Asks the protocol to send data to a specific connection, on some of its [channel `notify(channels, connectionId, payload)` - `channels` | 
string[]
| list of channels -- `connectionId` | 
string
| connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/entrypoint/newconnection) +- `connectionId` | 
string
| connection unique identifier, previously registered by the protocol using [newConnection](/core/1/protocols/api/entrypoint/newconnection) - `payload` | 
object
| data payload --- diff --git a/src/core/1/protocols/essentials/getting-started/index.md b/src/core/1/protocols/essentials/getting-started/index.md index 5066f3659..2d91b8296 100644 --- a/src/core/1/protocols/essentials/getting-started/index.md +++ b/src/core/1/protocols/essentials/getting-started/index.md @@ -16,8 +16,8 @@ Protocols can even decide to propose a dedicated message format and/or query syn Protocols are provided with objects to interact with Kuzzle: -- [EntryPoint](/core/1/protocols/entrypoint): base communication layer (declare user connections, forward API requests, ...) -- [context](/core/1/protocols/context): utilities and object constructors not directly related to network communications +- [EntryPoint](/core/1/protocols/api/entrypoint): base communication layer (declare user connections, forward API requests, ...) +- [context](/core/1/protocols/api/context/): utilities and object constructors not directly related to network communications --- @@ -56,12 +56,12 @@ The following properties can be defined in this `manifest.json` file: To add new network capabilities, a protocol must implement a set of functions, to be called by Kuzzle: -- [broadcast](/core/1/protocols/essentials/broadcast) -- [disconnect](/core/1/protocols/essentials/disconnect) -- [init](/core/1/protocols/essentials/init) -- [joinChannel](/core/1/protocols/essentials/joinchannel) -- [leaveChannel](/core/1/protocols/essentials/leavechannel) -- [notify](/core/1/protocols/essentials/notify) +- [broadcast](/core/1/protocols/api/methods/broadcast/) +- [disconnect](/core/1/protocols/api/methods/disconnect/) +- [init](/core/1/protocols/api/methods/init/) +- [joinChannel](/core/1/protocols/api/methods/joinchannel/) +- [leaveChannel](/core/1/protocols/api/methods/leavechannel/) +- [notify](/core/1/protocols/api/methods/notify/) If one or multiple of these functions are missing, Kuzzle fails to load the protocol, and refuses to start. @@ -71,17 +71,17 @@ If one or multiple of these functions are missing, Kuzzle fails to load the prot `channel` is a recurrent concept in the protocol interface, one that must be implemented by the protocol itself. -Simply put: it is the same `channel` identifier returned to a user after a [real-time subscription](/core/1/api/api-reference/controller-realtime/subscribe/). Many users can share the same channel, as it is calculated from the provided subscription filters, after they are normalized (i.e. equivalent yet differently written filters still share the same identifier). +Simply put: it is the same `channel` identifier returned to a user after a [real-time subscription](/core/1/api/controllers/realtime/subscribe/). Many users can share the same channel, as it is calculated from the provided subscription filters, after they are normalized (i.e. equivalent yet differently written filters still share the same identifier). -Kuzzle notifies protocols when one of their managed connection [joins](/core/1/protocols/essentials/joinchannel) or [leaves](/core/1/protocols/essentials/leavechannel) a channel. +Kuzzle notifies protocols when one of their managed connection [joins](/core/1/protocols/api/methods/joinchannel/) or [leaves](/core/1/protocols/api/methods/leavechannel/) a channel. -Kuzzle has no opinion on how a protocol handles channels and their associated users. It simply asks protocols to [broadcast](/core/1/protocols/essentials/broadcast), or to [notify](/core/1/protocols/essentials/notify) messages to listening users. +Kuzzle has no opinion on how a protocol handles channels and their associated users. It simply asks protocols to [broadcast](/core/1/protocols/api/methods/broadcast/), or to [notify](/core/1/protocols/api/methods/notify/) messages to listening users. --- ## Configuration -Protocols can be configured in the Kuzzle [configuration](/core/1/guide/guides/essentials/configuration/) file, under the `server/protocols/` section. +Protocols can be configured in the Kuzzle [configuration](/core/1/guides/essentials/configuration/) file, under the `server/protocols/` section. ### Example diff --git a/src/core/1/protocols/native-protocols/http/index.md b/src/core/1/protocols/native-protocols/http/index.md index 47bc7ad16..649c61be0 100644 --- a/src/core/1/protocols/native-protocols/http/index.md +++ b/src/core/1/protocols/native-protocols/http/index.md @@ -9,7 +9,7 @@ order: 0 ## Configuration -The protocol can be configured via the [kuzzlerc configuration file](/core/1/guide/guides/essentials/configuration/), under the `server > protocols > http` section. +The protocol can be configured via the [kuzzlerc configuration file](/core/1/guides/essentials/configuration/), under the `server > protocols > http` section. | Option | Type | Description | Default | | ------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | @@ -26,7 +26,7 @@ HTTP, WebSocket and Socket.IO protocols share the same underlying server instanc By default, Kuzzle listens to the `7512` port. -The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guide/guides/essentials/configuration/). +The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guides/essentials/configuration/). ## Limitations diff --git a/src/core/1/protocols/native-protocols/mqtt/index.md b/src/core/1/protocols/native-protocols/mqtt/index.md index ec8c259b5..b26e07bfe 100644 --- a/src/core/1/protocols/native-protocols/mqtt/index.md +++ b/src/core/1/protocols/native-protocols/mqtt/index.md @@ -15,7 +15,7 @@ By default, the MQTT protocol is disabled in Kuzzle configuration. ## Configuration -The protocol can be configured via the [kuzzlerc configuration file](/core/1/guide/guides/essentials/configuration/), under the `server > protocols > mqtt` section. +The protocol can be configured via the [kuzzlerc configuration file](/core/1/guides/essentials/configuration/), under the `server > protocols > mqtt` section. | Option | Type | Description | Default | | ----------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | @@ -88,7 +88,7 @@ client.on('message', (topic, raw) => { ### Using Kuzzle subscriptions -Kuzzle allows to [subscribe](https://docs.kuzzle.io/core/1/api/api-reference/controller-realtime/subscribe/) to messages and events using advanced filters. +Kuzzle allows to [subscribe](https://docs.kuzzle.io/core/1/api/controllers/realtime/subscribe/) to messages and events using advanced filters. Each time a subscription is sent, a dedicated MQTT topic is created, named after the `channel` property issued by Kuzzle. @@ -162,7 +162,7 @@ Subscription attempts to the `requestTopic` topic (defaults to `Kuzzle/request`) The MQTT `Kuzzle/response` topic is by default a special topic that acts as a private channel. Each client receives its own responses only, offering a simple first security layer. -While this behavior is urgently recommended in production, it can bring a small drawback when testing and developing applications: it does not allow using most CLI tools. +While this behavior is urgently recommended in production, it can bring a small drawback when testing and developing applications: it does not allow using most CLI tools. Many CLI tools, such as Mosquitto offer two separate binaries, one for subscribing and one for publishing. These act as two different clients and the subscriber won't receive any response sent to the publisher by default. To use these tools, one can enable the **development mode**, in which `Kuzzle/response` will act as a regular public topic. diff --git a/src/core/1/protocols/native-protocols/socketio/index.md b/src/core/1/protocols/native-protocols/socketio/index.md index 523aa8452..af805506f 100644 --- a/src/core/1/protocols/native-protocols/socketio/index.md +++ b/src/core/1/protocols/native-protocols/socketio/index.md @@ -9,7 +9,7 @@ order: 0 ## Configuration -The protocol can be configured via the [kuzzlerc configuration file](/core/1/guide/guides/essentials/configuration/), under the `server > protocols > socketio` section. +The protocol can be configured via the [kuzzlerc configuration file](/core/1/guides/essentials/configuration/), under the `server > protocols > socketio` section. | Option | Type | Description | Default | | --------- | ------------------ | ------------------------------------------------------------------------- | ------- | @@ -24,4 +24,4 @@ HTTP, WebSocket and Socket.IO protocols share the same underlying server instanc By default, Kuzzle listens to the `7512` port. -The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guide/guides/essentials/configuration/). +The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guides/essentials/configuration/). diff --git a/src/core/1/protocols/native-protocols/websocket/index.md b/src/core/1/protocols/native-protocols/websocket/index.md index 22ae7428f..46b12c655 100644 --- a/src/core/1/protocols/native-protocols/websocket/index.md +++ b/src/core/1/protocols/native-protocols/websocket/index.md @@ -9,7 +9,7 @@ order: 0 ## Configuration -The protocol can be configured via the [kuzzlerc configuration file](/core/1/guide/guides/essentials/configuration/), under the `server > protocols > websocket` section. +The protocol can be configured via the [kuzzlerc configuration file](/core/1/guides/essentials/configuration/), under the `server > protocols > websocket` section. | Option | Type | Description | Default | | ----------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------- | @@ -24,4 +24,4 @@ HTTP, WebSocket and Socket.IO protocols share the same underlying server instanc By default, Kuzzle listens to the `7512` port. -The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guide/guides/essentials/configuration/). +The port can be modified under the `server > port` section of [Kuzzle configuration](/core/1/guides/essentials/configuration/). diff --git a/src/sdk/android/3/core-classes/collection-mapping/constructor/index.md b/src/sdk/android/3/core-classes/collection-mapping/constructor/index.md index e4d957eff..25f713577 100644 --- a/src/sdk/android/3/core-classes/collection-mapping/constructor/index.md +++ b/src/sdk/android/3/core-classes/collection-mapping/constructor/index.md @@ -23,7 +23,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | Arguments | Type | Description | | ------------ | ---------------------------------------------------- | --------------------------------- | -| `Collection` | [Collection](/sdk/android/3/controllers/collection/) | An instantiated Collection object | +| `Collection` | [Collection](/sdk/android/3/core-classes/collection/) | An instantiated Collection object | | `mapping` | JSON Object | Optional mapping | --- @@ -35,7 +35,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | `headers` | JSON Object | Common headers for all sent documents. | get/set | | `mapping` | object | Easy-to-understand list of mappings per field | get/set | -**Note:** the `headers` property is inherited from the provided [Collection](/sdk/android/3/controllers/collection/) object and can be overrided +**Note:** the `headers` property is inherited from the provided [Collection](/sdk/android/3/core-classes/collection/) object and can be overrided ## Usage diff --git a/src/sdk/android/3/core-classes/collection/collection-mapping/index.md b/src/sdk/android/3/core-classes/collection/collection-mapping/index.md index 039e798ec..2db1a36bc 100644 --- a/src/sdk/android/3/core-classes/collection/collection-mapping/index.md +++ b/src/sdk/android/3/core-classes/collection/collection-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:collectionMapping # collectionMapping -Creates a new [CollectionMapping](/sdk/android/3/controllers/collection/-mapping/) object, using its constructor. +Creates a new [CollectionMapping](/sdk/android/3/core-classes/collection-mapping/) object, using its constructor. --- @@ -21,7 +21,7 @@ Creates a new [CollectionMapping](/sdk/android/3/controllers/collection/-mapping ## Return Value -Returns the newly created [CollectionMapping](/sdk/android/3/controllers/collection/-mapping/) object. +Returns the newly created [CollectionMapping](/sdk/android/3/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/create-document/index.md b/src/sdk/android/3/core-classes/collection/create-document/index.md index 3c8d8529b..91d61aabc 100644 --- a/src/sdk/android/3/core-classes/collection/create-document/index.md +++ b/src/sdk/android/3/core-classes/collection/create-document/index.md @@ -7,7 +7,7 @@ description: Collection:createDocument # createDocument -Create a new document in Kuzzle and instantiate a [Document](/sdk/android/3/controllers/document/) object. +Create a new document in Kuzzle and instantiate a [Document](/sdk/android/3/core-classes/document/) object. --- @@ -15,7 +15,7 @@ Create a new document in Kuzzle and instantiate a [Document](/sdk/android/3/cont | Arguments | Type | Description | | ---------- | ----------- | ------------------------------------------------------- | -| `Document` | object | [Document](/sdk/android/3/controllers/document/) object | +| `Document` | object | [Document](/sdk/android/3/core-classes/document/) object | | `options` | JSON object | Optional parameters | | `callback` | function | Optional callback | @@ -51,7 +51,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns a [Document](/sdk/android/3/controllers/document/) object containing the newly created document. +Returns a [Document](/sdk/android/3/core-classes/document/) object containing the newly created document. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/create/index.md b/src/sdk/android/3/core-classes/collection/create/index.md index 3bf682c57..6a303c8b5 100644 --- a/src/sdk/android/3/core-classes/collection/create/index.md +++ b/src/sdk/android/3/core-classes/collection/create/index.md @@ -7,7 +7,7 @@ description: Collection:create # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. diff --git a/src/sdk/android/3/core-classes/collection/document/index.md b/src/sdk/android/3/core-classes/collection/document/index.md index 257431eb7..a29c7d7a2 100644 --- a/src/sdk/android/3/core-classes/collection/document/index.md +++ b/src/sdk/android/3/core-classes/collection/document/index.md @@ -7,7 +7,7 @@ description: Collection:document # document -Creates a new [Document](/sdk/android/3/controllers/document/) object, using its constructor. +Creates a new [Document](/sdk/android/3/core-classes/document/) object, using its constructor. --- @@ -22,7 +22,7 @@ Creates a new [Document](/sdk/android/3/controllers/document/) object, using its ## Return Value -Returns the newly created [Document](/sdk/android/3/controllers/document/) object. +Returns the newly created [Document](/sdk/android/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/fetch-document/index.md b/src/sdk/android/3/core-classes/collection/fetch-document/index.md index 9ceb5ce99..75955c99d 100644 --- a/src/sdk/android/3/core-classes/collection/fetch-document/index.md +++ b/src/sdk/android/3/core-classes/collection/fetch-document/index.md @@ -7,7 +7,7 @@ description: Collection:fetchDocument # fetchDocument -Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/android/3/controllers/document/) object. +Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/android/3/core-classes/document/) object. --- @@ -31,7 +31,7 @@ Retrieves a single stored document using its unique document ID, and returns it ## Callback Response -Returns a [Document](/sdk/android/3/controllers/document/) object. +Returns a [Document](/sdk/android/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/get-mapping/index.md b/src/sdk/android/3/core-classes/collection/get-mapping/index.md index 74c7036b8..3324769b6 100644 --- a/src/sdk/android/3/core-classes/collection/get-mapping/index.md +++ b/src/sdk/android/3/core-classes/collection/get-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:getMapping # getMapping -Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/android/3/controllers/collection/-mapping/) object. +Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/android/3/core-classes/collection-mapping/) object. --- @@ -30,7 +30,7 @@ Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/a ## Callback Response -Returns a [CollectionMapping](/sdk/android/3/controllers/collection/-mapping/) object. +Returns a [CollectionMapping](/sdk/android/3/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/mcreate-document/index.md b/src/sdk/android/3/core-classes/collection/mcreate-document/index.md index cdf5d75ef..45945a180 100644 --- a/src/sdk/android/3/core-classes/collection/mcreate-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mcreate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateDocument # mCreateDocument -Create the input [Documents](/sdk/android/3/controllers/document/). +Create the input [Documents](/sdk/android/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Create the input [Documents](/sdk/android/3/controllers/document/). | Arguments | Type | Description | | ----------- | ----------- | ------------------------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/android/3/controllers/document/) to create | +| `documents` | Document[] | Array of [Document](/sdk/android/3/core-classes/document/) to create | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md b/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md index dd27f3fd5..48c4f1b47 100644 --- a/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mcreate-or-replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateOrReplaceDocument # mCreateOrReplaceDocument -Create or replace the input [Documents](/sdk/android/3/controllers/document/). +Create or replace the input [Documents](/sdk/android/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Create or replace the input [Documents](/sdk/android/3/controllers/document/). | Arguments | Type | Description | | ----------- | ----------- | ------------------------------------------------------------------------------ | -| `documents` | Document[] | Array of [Document](/sdk/android/3/controllers/document/) to create or replace | +| `documents` | Document[] | Array of [Document](/sdk/android/3/core-classes/document/) to create or replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/android/3/core-classes/collection/mdelete-document/index.md b/src/sdk/android/3/core-classes/collection/mdelete-document/index.md index cfb6f65f3..2ad17bfa0 100644 --- a/src/sdk/android/3/core-classes/collection/mdelete-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mdelete-document/index.md @@ -7,7 +7,7 @@ description: Collection:mdeleteDocument # mDeleteDocument -Delete multiple [Documents](/sdk/android/3/controllers/document/) according to the input IDs. +Delete multiple [Documents](/sdk/android/3/core-classes/document/) according to the input IDs. --- diff --git a/src/sdk/android/3/core-classes/collection/mget-document/index.md b/src/sdk/android/3/core-classes/collection/mget-document/index.md index ed5ba1000..b8bbe946c 100644 --- a/src/sdk/android/3/core-classes/collection/mget-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mget-document/index.md @@ -7,7 +7,7 @@ description: Collection:mgetDocument # mGetDocument -Get multiple [Documents](/sdk/android/3/controllers/document/) according to the input document IDs. +Get multiple [Documents](/sdk/android/3/core-classes/document/) according to the input document IDs. --- diff --git a/src/sdk/android/3/core-classes/collection/mreplace-document/index.md b/src/sdk/android/3/core-classes/collection/mreplace-document/index.md index d7d96adc8..ba6ffab5c 100644 --- a/src/sdk/android/3/core-classes/collection/mreplace-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mreplace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mreplaceDocument # mReplaceDocument -Replace the provided [Documents](/sdk/android/3/controllers/document/). +Replace the provided [Documents](/sdk/android/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Replace the provided [Documents](/sdk/android/3/controllers/document/). | Arguments | Type | Description | | ----------- | ----------- | -------------------------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/android/3/controllers/document/) to replace | +| `documents` | Document[] | Array of [Document](/sdk/android/3/core-classes/document/) to replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/android/3/core-classes/collection/mupdate-document/index.md b/src/sdk/android/3/core-classes/collection/mupdate-document/index.md index 14cc23412..050a8ff13 100644 --- a/src/sdk/android/3/core-classes/collection/mupdate-document/index.md +++ b/src/sdk/android/3/core-classes/collection/mupdate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mupdateDocument # mUpdateDocument -Update the provided [Documents](/sdk/android/3/controllers/document/). +Update the provided [Documents](/sdk/android/3/core-classes/document/). --- @@ -15,7 +15,7 @@ Update the provided [Documents](/sdk/android/3/controllers/document/). | Arguments | Type | Description | | ----------- | ----------- | -------------------------------------------------------------------- | -| `documents` | Document[] | Array of [Documents](/sdk/android/3/controllers/document/) to update | +| `documents` | Document[] | Array of [Documents](/sdk/android/3/core-classes/document/) to update | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/android/3/core-classes/collection/publish-message/index.md b/src/sdk/android/3/core-classes/collection/publish-message/index.md index 9b41dd386..eafa4796c 100644 --- a/src/sdk/android/3/core-classes/collection/publish-message/index.md +++ b/src/sdk/android/3/core-classes/collection/publish-message/index.md @@ -15,7 +15,7 @@ Publish a real-time message. | Arguments | Type | Description | | ---------- | ----------- | ------------------------------------------------------- | -| `Document` | object | [Document](/sdk/android/3/controllers/document/) object | +| `Document` | object | [Document](/sdk/android/3/core-classes/document/) object | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/android/3/core-classes/collection/replace-document/index.md b/src/sdk/android/3/core-classes/collection/replace-document/index.md index 67a3568ac..de65bca28 100644 --- a/src/sdk/android/3/core-classes/collection/replace-document/index.md +++ b/src/sdk/android/3/core-classes/collection/replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:replaceDocument # replaceDocument -Replace an existing document and return the updated version as a [Document](/sdk/android/3/controllers/document/) object. +Replace an existing document and return the updated version as a [Document](/sdk/android/3/core-classes/document/) object. --- @@ -40,7 +40,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an updated [Document](/sdk/android/3/controllers/document/) object. +Returns an updated [Document](/sdk/android/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/room/index.md b/src/sdk/android/3/core-classes/collection/room/index.md index 39724991e..446fe6724 100644 --- a/src/sdk/android/3/core-classes/collection/room/index.md +++ b/src/sdk/android/3/core-classes/collection/room/index.md @@ -7,7 +7,7 @@ description: Collection:room # room -Creates a new [Room](/sdk/android/3/controllers/room/) object, using its constructor. +Creates a new [Room](/sdk/android/3/core-classes/room/) object, using its constructor. --- @@ -19,13 +19,13 @@ Creates a new [Room](/sdk/android/3/controllers/room/) object, using its constru ## Options -Provided options are passed directly to the [Room](/sdk/android/3/controllers/room/) object constructor. +Provided options are passed directly to the [Room](/sdk/android/3/core-classes/room/) object constructor. --- ## Return Value -Returns the newly created [Room](/sdk/android/3/controllers/room/) object. +Returns the newly created [Room](/sdk/android/3/core-classes/room/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/collection/scroll/index.md b/src/sdk/android/3/core-classes/collection/scroll/index.md index f5e630ea8..10e83364d 100644 --- a/src/sdk/android/3/core-classes/collection/scroll/index.md +++ b/src/sdk/android/3/core-classes/collection/scroll/index.md @@ -7,7 +7,7 @@ description: Collection:scroll # scroll -Returns a [SearchResult](/sdk/android/3/controllers/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. +Returns a [SearchResult](/sdk/android/3/core-classes/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. A scroll session is always initiated by a `search` action and including the `scroll` argument; more information below.
@@ -15,7 +15,7 @@ There is a small delay between the time a document is created and its availabili
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- @@ -41,7 +41,7 @@ There is a small delay between the time a document is created and its availabili ## Callback Response -Returns an instantiated [SearchResult](/sdk/android/3/controllers/search-result/) object. +Returns an instantiated [SearchResult](/sdk/android/3/core-classes/search-result/) object. --- diff --git a/src/sdk/android/3/core-classes/collection/search/index.md b/src/sdk/android/3/core-classes/collection/search/index.md index cfa21f9d2..3379a2d49 100644 --- a/src/sdk/android/3/core-classes/collection/search/index.md +++ b/src/sdk/android/3/core-classes/collection/search/index.md @@ -19,9 +19,9 @@ When processing a large number of documents (i.e. more than 1000), using `search Pagination of results can be done by using the from and size but the cost becomes prohibitive when deep pagination is reached. In fact, Elasticsearch, Kuzzle's embedded database, limits results to 10,000 records by default. -Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/android/3/controllers/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/android/3/controllers/search-result/fetch-next/). +Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/android/3/core-classes/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/android/3/core-classes/search-result/fetch-next/). -See [`SearchResult.fetchNext`](/sdk/android/3/controllers/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. +See [`SearchResult.fetchNext`](/sdk/android/3/core-classes/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. --- @@ -45,14 +45,14 @@ See [`SearchResult.fetchNext`](/sdk/android/3/controllers/search-result/fetch-ne | `size` | number | Provide the maximum number of results of the request (used to paginate results) | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- ## Callback Response -Returns an instance of [SearchResult](/sdk/android/3/controllers/search-result/). +Returns an instance of [SearchResult](/sdk/android/3/core-classes/search-result/). ## Usage diff --git a/src/sdk/android/3/core-classes/collection/subscribe/index.md b/src/sdk/android/3/core-classes/collection/subscribe/index.md index 7ec49d9e7..9c7660bc7 100644 --- a/src/sdk/android/3/core-classes/collection/subscribe/index.md +++ b/src/sdk/android/3/core-classes/collection/subscribe/index.md @@ -34,7 +34,7 @@ The provided callback will be called everytime a [notification](/sdk/android/3/e | `users` | string | Filter notifications fired upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | The `options` object is directly passed to the Room constructor. -See the [Room object](/sdk/android/3/controllers/room/) documentation for more information about these options and notifications. +See the [Room object](/sdk/android/3/core-classes/room/) documentation for more information about these options and notifications. --- diff --git a/src/sdk/android/3/core-classes/collection/update-document/index.md b/src/sdk/android/3/core-classes/collection/update-document/index.md index cf8f8136b..76fbe36c2 100644 --- a/src/sdk/android/3/core-classes/collection/update-document/index.md +++ b/src/sdk/android/3/core-classes/collection/update-document/index.md @@ -7,7 +7,7 @@ description: Collection:updateDocument # updateDocument -Update parts of a document, by replacing some fields or adding new ones. +Update parts of a document, by replacing some fields or adding new ones. Note that you cannot remove fields this way: missing fields will simply be left unchanged. --- @@ -42,7 +42,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an up-to-date [Document](/sdk/android/3/controllers/document/) object. +Returns an up-to-date [Document](/sdk/android/3/core-classes/document/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/document/subscribe/index.md b/src/sdk/android/3/core-classes/document/subscribe/index.md index 9186d4ecf..beb0c571a 100644 --- a/src/sdk/android/3/core-classes/document/subscribe/index.md +++ b/src/sdk/android/3/core-classes/document/subscribe/index.md @@ -25,7 +25,7 @@ The provided callback will be called everytime a [notification](/sdk/android/3/e ## Options -Options are directly passed to the [Room](/sdk/android/3/controllers/room/) object constructor. +Options are directly passed to the [Room](/sdk/android/3/core-classes/room/) object constructor. --- diff --git a/src/sdk/android/3/core-classes/kuzzle/collection/index.md b/src/sdk/android/3/core-classes/kuzzle/collection/index.md index 87e487e80..85ead1f90 100644 --- a/src/sdk/android/3/core-classes/kuzzle/collection/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/collection/index.md @@ -7,7 +7,7 @@ description: Kuzzle:collection # collection -Instantiates a new [Collection](/sdk/android/3/controllers/collection/) object. +Instantiates a new [Collection](/sdk/android/3/core-classes/collection/) object. --- @@ -26,7 +26,7 @@ The `index` argument takes precedence over the default index. ## Return Value -Returns a [Collection](/sdk/android/3/controllers/collection/) object. +Returns a [Collection](/sdk/android/3/core-classes/collection/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/kuzzle/get-my-credentials/index.md b/src/sdk/android/3/core-classes/kuzzle/get-my-credentials/index.md index 9231bfaaa..9a84c5dd1 100644 --- a/src/sdk/android/3/core-classes/kuzzle/get-my-credentials/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/get-my-credentials/index.md @@ -7,7 +7,7 @@ description: Kuzzle:getMyCredentials # getMyCredentials -Get [credential information](/core/1/guide/guides/essentials/user-authentication/#user-credentials) for the current user. +Get [credential information](/core/1/guides/essentials/user-authentication/#user-credentials) for the current user. --- diff --git a/src/sdk/android/3/core-classes/kuzzle/login/index.md b/src/sdk/android/3/core-classes/kuzzle/login/index.md index 8127880d6..fe1bf00ab 100644 --- a/src/sdk/android/3/core-classes/kuzzle/login/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/login/index.md @@ -15,11 +15,11 @@ This is the case, for instance, with the `local` authentication strategy. If the request succeeds but there is no token, then it means that the chosen strategy is a two-steps authentication method, such as the OAUTH strategy. In that case, the `loginAttempt` event is **not** fired. To complete the login, the `setJwtToken` method must be called either with a token or with an appropriate Kuzzle response. -If the login attempt fails, the `loginAttempt` event is fired with the following response: +If the login attempt fails, the `loginAttempt` event is fired with the following response: `{ success: false, error: 'error message' }`
-This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more. +This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more.
--- diff --git a/src/sdk/android/3/core-classes/kuzzle/memory-storage/index.md b/src/sdk/android/3/core-classes/kuzzle/memory-storage/index.md index f67a35843..793d30c13 100644 --- a/src/sdk/android/3/core-classes/kuzzle/memory-storage/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/memory-storage/index.md @@ -7,4 +7,4 @@ description: Kuzzle:memoryStorage ## memoryStorage -A [MemoryStorage](/sdk/android/3/controllers/memory-storage/) singleton. +A [MemoryStorage](/sdk/android/3/core-classes/memory-storage/) singleton. diff --git a/src/sdk/android/3/core-classes/kuzzle/query/index.md b/src/sdk/android/3/core-classes/kuzzle/query/index.md index f058af1f0..fbf1805eb 100644 --- a/src/sdk/android/3/core-classes/kuzzle/query/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/query/index.md @@ -42,7 +42,7 @@ Refer to Kuzzle's API Reference here ## query -## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/api-reference/controller-document/search/)) +## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/controllers/document/search/)) ## Options diff --git a/src/sdk/android/3/core-classes/kuzzle/security/index.md b/src/sdk/android/3/core-classes/kuzzle/security/index.md index 5e8d5475e..148ca7840 100644 --- a/src/sdk/android/3/core-classes/kuzzle/security/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/security/index.md @@ -7,4 +7,4 @@ description: Kuzzle:security # security -A [Security](/sdk/android/3/controllers/security/) singleton. +A [Security](/sdk/android/3/core-classes/security/) singleton. diff --git a/src/sdk/android/3/core-classes/kuzzle/who-am-i/index.md b/src/sdk/android/3/core-classes/kuzzle/who-am-i/index.md index 0da91d3ed..fb759198f 100644 --- a/src/sdk/android/3/core-classes/kuzzle/who-am-i/index.md +++ b/src/sdk/android/3/core-classes/kuzzle/who-am-i/index.md @@ -21,7 +21,7 @@ Returns informations about the user who is currently loggedin. ## Callback Response -Returns an instantiated [User](/sdk/android/3/controllers/user/) object. +Returns an instantiated [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/memory-storage/geodist/index.md b/src/sdk/android/3/core-classes/memory-storage/geodist/index.md index e3a97d8e5..c07f0823d 100644 --- a/src/sdk/android/3/core-classes/memory-storage/geodist/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/geodist/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geodist # geodist -Returns the distance between two geospatial members of a key (see [geoadd](/sdk/android/3/controllers/memory-storage/geoadd/)). +Returns the distance between two geospatial members of a key (see [geoadd](/sdk/android/3/core-classes/memory-storage/geoadd/)). The returned distance is expressed in meters by default. [[_Redis documentation_]](https://redis.io/commands/geodist) diff --git a/src/sdk/android/3/core-classes/memory-storage/geohash/index.md b/src/sdk/android/3/core-classes/memory-storage/geohash/index.md index 3fc130b27..a5f693da6 100644 --- a/src/sdk/android/3/core-classes/memory-storage/geohash/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/geohash/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geohash # geohash -Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/android/3/controllers/memory-storage/geoadd/)). +Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/android/3/core-classes/memory-storage/geoadd/)). [[_Redis documentation_]](https://redis.io/commands/geohash) diff --git a/src/sdk/android/3/core-classes/memory-storage/geopos/index.md b/src/sdk/android/3/core-classes/memory-storage/geopos/index.md index 2cecf884f..2bd3f28ff 100644 --- a/src/sdk/android/3/core-classes/memory-storage/geopos/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/geopos/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geopos # geopos -Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/android/3/controllers/memory-storage/geoadd/)). +Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/android/3/core-classes/memory-storage/geoadd/)). [[_Redis documentation_]](https://redis.io/commands/geopos) diff --git a/src/sdk/android/3/core-classes/memory-storage/georadius/index.md b/src/sdk/android/3/core-classes/memory-storage/georadius/index.md index e2d4b5c16..c03da9975 100644 --- a/src/sdk/android/3/core-classes/memory-storage/georadius/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/georadius/index.md @@ -31,7 +31,7 @@ description: MemoryStorage:georadius ] ``` -Returns the members (added with [geoadd](/sdk/android/3/controllers/memory-storage/geoadd/)) of a given key inside the provided geospatial radius. +Returns the members (added with [geoadd](/sdk/android/3/core-classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius. [[_Redis documentation_]](https://redis.io/commands/georadius) diff --git a/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md b/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md index ed2fe2bc6..cf721d3a6 100644 --- a/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/georadiusbymember/index.md @@ -25,7 +25,7 @@ description: MemoryStorage:georadiusbymember ] ``` -Returns the members (added with [geoadd](/sdk/android/3/controllers/memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. +Returns the members (added with [geoadd](/sdk/android/3/core-classes/memory-storage/geoadd/)) of a given key inside the provided geospatial radius, centered around one of a key's member. [[_Redis documentation_]](https://redis.io/commands/georadiusbymember) --- diff --git a/src/sdk/android/3/core-classes/memory-storage/hscan/index.md b/src/sdk/android/3/core-classes/memory-storage/hscan/index.md index 5df1f1612..825327ed4 100644 --- a/src/sdk/android/3/core-classes/memory-storage/hscan/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/hscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:hscan # hscan -Identical to [scan](/sdk/android/3/controllers/memory-storage/scan/), except that `hscan` iterates over the fields contained in a hash. +Identical to [scan](/sdk/android/3/core-classes/memory-storage/scan/), except that `hscan` iterates over the fields contained in a hash. [[_Redis documentation_]](https://redis.io/commands/hscan) diff --git a/src/sdk/android/3/core-classes/memory-storage/pfcount/index.md b/src/sdk/android/3/core-classes/memory-storage/pfcount/index.md index 1073e9ff9..e2ca397ca 100644 --- a/src/sdk/android/3/core-classes/memory-storage/pfcount/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/pfcount/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:pfcount # pfcount -Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/android/3/controllers/memory-storage/pfadd/)). +Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/android/3/core-classes/memory-storage/pfadd/)). [[_Redis documentation_]](https://redis.io/commands/pfcount) diff --git a/src/sdk/android/3/core-classes/memory-storage/sscan/index.md b/src/sdk/android/3/core-classes/memory-storage/sscan/index.md index 465db6deb..784bf5999 100644 --- a/src/sdk/android/3/core-classes/memory-storage/sscan/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/sscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:sscan # sscan -Identical to [scan](/sdk/android/3/controllers/memory-storage/scan/), except that `sscan` iterates the members held by a set of unique values. +Identical to [scan](/sdk/android/3/core-classes/memory-storage/scan/), except that `sscan` iterates the members held by a set of unique values. [[_Redis documentation_]](https://redis.io/commands/sscan) diff --git a/src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md index b73c2a5e0..01e50b627 100644 --- a/src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/zrevrange/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrange # zrevrange -Identical to [zrange](/sdk/android/3/controllers/memory-storage/zrange/), except that the sorted set is traversed in descending order. +Identical to [zrange](/sdk/android/3/core-classes/memory-storage/zrange/), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrange) diff --git a/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md index 6b9781ee0..2173e23b7 100644 --- a/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/zrevrangebylex/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebylex # zrevrangebylex -Identical to [zrangebylex](/sdk/android/3/controllers/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. +Identical to [zrangebylex](/sdk/android/3/core-classes/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebylex) diff --git a/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md b/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md index 8f6ca8774..ac4187f64 100644 --- a/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/zrevrangebyscore/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebyscore # zrevrangebyscore -Identical to [zrangebyscore](/sdk/android/3/controllers/memory-storage/zrangebyscore/) except that the sorted set is traversed in descending order. +Identical to [zrangebyscore](/sdk/android/3/core-classes/memory-storage/zrangebyscore/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) diff --git a/src/sdk/android/3/core-classes/memory-storage/zscan/index.md b/src/sdk/android/3/core-classes/memory-storage/zscan/index.md index 44d1bff9f..a19b9be19 100644 --- a/src/sdk/android/3/core-classes/memory-storage/zscan/index.md +++ b/src/sdk/android/3/core-classes/memory-storage/zscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zscan # zscan -Identical to [scan](/sdk/android/3/controllers/memory-storage/scan/), except that `zscan` iterates the members held by a sorted set. +Identical to [scan](/sdk/android/3/core-classes/memory-storage/scan/), except that `zscan` iterates the members held by a sorted set. [[_Redis documentation_]](https://redis.io/commands/zscan) diff --git a/src/sdk/android/3/core-classes/profile/add-policy/index.md b/src/sdk/android/3/core-classes/profile/add-policy/index.md index eb03265e1..511184a99 100644 --- a/src/sdk/android/3/core-classes/profile/add-policy/index.md +++ b/src/sdk/android/3/core-classes/profile/add-policy/index.md @@ -10,7 +10,7 @@ description: Profile:addPolicy Adds a role to the security profile.
-Updating a security profile will have no impact until the save method is called +Updating a security profile will have no impact until the save method is called
--- diff --git a/src/sdk/android/3/core-classes/profile/constructor/index.md b/src/sdk/android/3/core-classes/profile/constructor/index.md index a6191ae74..3c92c9554 100644 --- a/src/sdk/android/3/core-classes/profile/constructor/index.md +++ b/src/sdk/android/3/core-classes/profile/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructors -Instantiates a new `Profile` object, representing a security [profile](/core/1/guide/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/android/3/controllers/role/) objects. +Instantiates a new `Profile` object, representing a security [profile](/core/1/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/android/3/core-classes/role/) objects. --- @@ -16,7 +16,7 @@ Instantiates a new `Profile` object, representing a security [profile](/core/1/g | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------------------------- | -| `Security` | Security | An instantiated [Security](/sdk/android/3/controllers/security/) object | +| `Security` | Security | An instantiated [Security](/sdk/android/3/core-classes/security/) object | | `id` | string | Unique profile identifier | | `content` | JSON Object | Profile content | | `meta` | JSON Object | Profile metadata | diff --git a/src/sdk/android/3/core-classes/role/constructor/index.md b/src/sdk/android/3/core-classes/role/constructor/index.md index 02527c992..7870c066c 100644 --- a/src/sdk/android/3/core-classes/role/constructor/index.md +++ b/src/sdk/android/3/core-classes/role/constructor/index.md @@ -16,7 +16,7 @@ Instantiates a new `Role` object, which defines a set of right policies. | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------------------------- | -| `Security` | Security | An instantiated [Security](/sdk/android/3/controllers/security/) object | +| `Security` | Security | An instantiated [Security](/sdk/android/3/core-classes/security/) object | | `id` | string | Unique role identifier | | `content` | JSON Object | Role content | | `meta` | JSON Object | Role metadata | diff --git a/src/sdk/android/3/core-classes/role/set-content/index.md b/src/sdk/android/3/core-classes/role/set-content/index.md index 46a282615..fe58e91cf 100644 --- a/src/sdk/android/3/core-classes/role/set-content/index.md +++ b/src/sdk/android/3/core-classes/role/set-content/index.md @@ -10,7 +10,7 @@ description: Role:setContent Replaces the content of the `Role` object.
-Updating a role content will have no impact until the save method is called +Updating a role content will have no impact until the save method is called
--- diff --git a/src/sdk/android/3/core-classes/role/update/index.md b/src/sdk/android/3/core-classes/role/update/index.md index bac704f6e..fbd54e0c1 100644 --- a/src/sdk/android/3/core-classes/role/update/index.md +++ b/src/sdk/android/3/core-classes/role/update/index.md @@ -15,11 +15,11 @@ Updates the role object in Kuzzle. In other words, you always need to provide the complete role definition in the updateContent object.

- This method has the same effect as calling setContent followed by the save method. + This method has the same effect as calling setContent followed by the save method.

-To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions). +To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions). --- diff --git a/src/sdk/android/3/core-classes/search-result/constructor/index.md b/src/sdk/android/3/core-classes/search-result/constructor/index.md index e9a6835c7..13c5c793c 100644 --- a/src/sdk/android/3/core-classes/search-result/constructor/index.md +++ b/src/sdk/android/3/core-classes/search-result/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructor -This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/android/3/controllers/collection/search/) or a [scroll](/sdk/android/3/controllers/collection/scroll/) request. +This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/android/3/core-classes/collection/search/) or a [scroll](/sdk/android/3/core-classes/collection/scroll/) request. --- diff --git a/src/sdk/android/3/core-classes/security/constructor/index.md b/src/sdk/android/3/core-classes/security/constructor/index.md index 279b5a5a1..e3698295b 100644 --- a/src/sdk/android/3/core-classes/security/constructor/index.md +++ b/src/sdk/android/3/core-classes/security/constructor/index.md @@ -10,7 +10,7 @@ order: 1 The Security component lets you handle user permissions in Kuzzle. -Please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions) for more information. +Please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions) for more information. --- diff --git a/src/sdk/android/3/core-classes/security/create-profile/index.md b/src/sdk/android/3/core-classes/security/create-profile/index.md index 91394f535..c91d3e824 100644 --- a/src/sdk/android/3/core-classes/security/create-profile/index.md +++ b/src/sdk/android/3/core-classes/security/create-profile/index.md @@ -39,7 +39,7 @@ That means that a profile that was just created might not be returned by the @@ -39,7 +39,7 @@ That means that a user that was just created may not be returned by the se ## Callback response -Resolves to a [User](/sdk/android/3/controllers/user/) object. +Resolves to a [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/create-role/index.md b/src/sdk/android/3/core-classes/security/create-role/index.md index a33e65f42..c16d649b7 100644 --- a/src/sdk/android/3/core-classes/security/create-role/index.md +++ b/src/sdk/android/3/core-classes/security/create-role/index.md @@ -38,7 +38,7 @@ That means that a role that was just created may not be returned by the se ## Callback Response -Returns a [Role](/sdk/android/3/controllers/role/) object. +Returns a [Role](/sdk/android/3/core-classes/role/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/create-user/index.md b/src/sdk/android/3/core-classes/security/create-user/index.md index fb4134b74..2c11970ed 100644 --- a/src/sdk/android/3/core-classes/security/create-user/index.md +++ b/src/sdk/android/3/core-classes/security/create-user/index.md @@ -20,7 +20,7 @@ That means that a user that was just created may not be returned by the se | Arguments | Type | Description | | ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Unique user identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `id` | string | [Unique user identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `user` | JSON Object | A plain JSON object representing the user (see below) | | `options` | string | (Optional) Optional arguments | | `callback` | function | Callback handling the response | @@ -29,10 +29,10 @@ That means that a user that was just created may not be returned by the se The `user` object to provide must have the following properties: - `content` (JSON object): user global properties - - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guide/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user + - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user - Any other property will be copied as additional global user information - `credentials` (JSON object): a description of how the new user can identify themselves on Kuzzle - - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/essentials/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. + - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/guides/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. - If this object is left empty, the user will be created in Kuzzle but the will not be able to login. --- @@ -47,7 +47,7 @@ The `user` object to provide must have the following properties: ## Callback Response -Returns a [User](/sdk/android/3/controllers/user/) object. +Returns a [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/fetch-profile/index.md b/src/sdk/android/3/core-classes/security/fetch-profile/index.md index c85573df5..0af4c6db3 100644 --- a/src/sdk/android/3/core-classes/security/fetch-profile/index.md +++ b/src/sdk/android/3/core-classes/security/fetch-profile/index.md @@ -31,7 +31,7 @@ Fetches a single stored profile using its unique ID. ## Callback Response -Returns a security [Profile](/sdk/android/3/controllers/profile/) object. +Returns a security [Profile](/sdk/android/3/core-classes/profile/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/fetch-role/index.md b/src/sdk/android/3/core-classes/security/fetch-role/index.md index d513c8ddb..091e4e163 100644 --- a/src/sdk/android/3/core-classes/security/fetch-role/index.md +++ b/src/sdk/android/3/core-classes/security/fetch-role/index.md @@ -31,7 +31,7 @@ Fetches a single stored role using its unique ID. ## Callback Response -Returns a [Role](/sdk/android/3/controllers/role/) object. +Returns a [Role](/sdk/android/3/core-classes/role/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/fetch-user/index.md b/src/sdk/android/3/core-classes/security/fetch-user/index.md index 908c1eff2..711123a88 100644 --- a/src/sdk/android/3/core-classes/security/fetch-user/index.md +++ b/src/sdk/android/3/core-classes/security/fetch-user/index.md @@ -31,7 +31,7 @@ Fetches a single stored user using its unique ID. ## Callback Response -Returns a [User](/sdk/android/3/controllers/user/) object. +Returns a [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/get-user-rights/index.md b/src/sdk/android/3/core-classes/security/get-user-rights/index.md index 9e9943c6e..ef281cf2b 100644 --- a/src/sdk/android/3/core-classes/security/get-user-rights/index.md +++ b/src/sdk/android/3/core-classes/security/get-user-rights/index.md @@ -36,7 +36,7 @@ Given a Kuzzle user id (`kuid`), retrieves the list of permissions granted to th | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------------------------------------------------------------------- | -| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `options` | JSON Object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/android/3/core-classes/security/is-action-allowed/index.md b/src/sdk/android/3/core-classes/security/is-action-allowed/index.md index 79c2d0a6a..272e03068 100644 --- a/src/sdk/android/3/core-classes/security/is-action-allowed/index.md +++ b/src/sdk/android/3/core-classes/security/is-action-allowed/index.md @@ -16,7 +16,7 @@ Specifies if an action is allowed, denied or conditional based on the rights pro An action is defined as a pair of action and controller (mandatory), plus an index and a collection(optional).
-You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`. +You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`.
--- diff --git a/src/sdk/android/3/core-classes/security/profile/index.md b/src/sdk/android/3/core-classes/security/profile/index.md index e499632ec..7197f9461 100644 --- a/src/sdk/android/3/core-classes/security/profile/index.md +++ b/src/sdk/android/3/core-classes/security/profile/index.md @@ -7,7 +7,7 @@ description: Security:profile # profile -Instantiate a new security [Profile](/sdk/android/3/controllers/profile/) object. +Instantiate a new security [Profile](/sdk/android/3/core-classes/profile/) object. --- @@ -22,7 +22,7 @@ Instantiate a new security [Profile](/sdk/android/3/controllers/profile/) object ## Return Value -Returns the new security [Profile](/sdk/android/3/controllers/profile/) object. +Returns the new security [Profile](/sdk/android/3/core-classes/profile/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/replace-user/index.md b/src/sdk/android/3/core-classes/security/replace-user/index.md index a51307734..f82cf6693 100644 --- a/src/sdk/android/3/core-classes/security/replace-user/index.md +++ b/src/sdk/android/3/core-classes/security/replace-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns a [User](/sdk/android/3/controllers/user/) object. +Returns a [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/role/index.md b/src/sdk/android/3/core-classes/security/role/index.md index 13b82e23c..044acb67c 100644 --- a/src/sdk/android/3/core-classes/security/role/index.md +++ b/src/sdk/android/3/core-classes/security/role/index.md @@ -7,7 +7,7 @@ description: Security:role # role -Instantiate a new [Role](/sdk/android/3/controllers/role/) object. +Instantiate a new [Role](/sdk/android/3/core-classes/role/) object. --- @@ -22,7 +22,7 @@ Instantiate a new [Role](/sdk/android/3/controllers/role/) object. ## Return Value -Returns the new [Role](/sdk/android/3/controllers/role/) object. +Returns the new [Role](/sdk/android/3/core-classes/role/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/search-users/index.md b/src/sdk/android/3/core-classes/security/search-users/index.md index fb4c33e21..62394e2ee 100644 --- a/src/sdk/android/3/core-classes/security/search-users/index.md +++ b/src/sdk/android/3/core-classes/security/search-users/index.md @@ -31,7 +31,7 @@ Return users matching the given filter. | `size` | number |  Number of hits to return per result page | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- diff --git a/src/sdk/android/3/core-classes/security/update-profile/index.md b/src/sdk/android/3/core-classes/security/update-profile/index.md index e5272e2f9..16f4a7fa9 100644 --- a/src/sdk/android/3/core-classes/security/update-profile/index.md +++ b/src/sdk/android/3/core-classes/security/update-profile/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Return an updated [Profile](/sdk/android/3/controllers/profile/) object. +Return an updated [Profile](/sdk/android/3/core-classes/profile/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/update-role/index.md b/src/sdk/android/3/core-classes/security/update-role/index.md index b562a1c1f..c2aee9d28 100644 --- a/src/sdk/android/3/core-classes/security/update-role/index.md +++ b/src/sdk/android/3/core-classes/security/update-role/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [Role](/sdk/android/3/controllers/role/) object. +Returns an updated [Role](/sdk/android/3/core-classes/role/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/update-user/index.md b/src/sdk/android/3/core-classes/security/update-user/index.md index 6389a2da6..ecacfbef9 100644 --- a/src/sdk/android/3/core-classes/security/update-user/index.md +++ b/src/sdk/android/3/core-classes/security/update-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [User](/sdk/android/3/controllers/user/) object. +Returns an updated [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/security/user/index.md b/src/sdk/android/3/core-classes/security/user/index.md index 926e4a299..a77342668 100644 --- a/src/sdk/android/3/core-classes/security/user/index.md +++ b/src/sdk/android/3/core-classes/security/user/index.md @@ -7,7 +7,7 @@ description: Security:user # user -Instantiates a new [User](/sdk/android/3/controllers/user/) object. +Instantiates a new [User](/sdk/android/3/core-classes/user/) object. --- @@ -22,7 +22,7 @@ Instantiates a new [User](/sdk/android/3/controllers/user/) object. ## Return value -Returns the new [User](/sdk/android/3/controllers/user/) object. +Returns the new [User](/sdk/android/3/core-classes/user/) object. ## Usage diff --git a/src/sdk/android/3/core-classes/user/add-profile/index.md b/src/sdk/android/3/core-classes/user/add-profile/index.md index 39fe836fd..528970610 100644 --- a/src/sdk/android/3/core-classes/user/add-profile/index.md +++ b/src/sdk/android/3/core-classes/user/add-profile/index.md @@ -10,7 +10,7 @@ description: User:addProfile Replaces the security profile associated with the user.
-Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called
--- @@ -27,7 +27,7 @@ Updating a user will have no impact until the -Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called
--- diff --git a/src/sdk/android/3/core-classes/user/set-credentials/index.md b/src/sdk/android/3/core-classes/user/set-credentials/index.md index 2cdf281d5..d7e479baa 100644 --- a/src/sdk/android/3/core-classes/user/set-credentials/index.md +++ b/src/sdk/android/3/core-classes/user/set-credentials/index.md @@ -10,7 +10,7 @@ description: User:setCredentials Sets the user's credentials.
- Updating user credentials will have no impact until the create method is called.
+ Updating user credentials will have no impact until the create method is called.
The credentials to send depend on the authentication plugin and the strategy you want to create credentials for.
--- diff --git a/src/sdk/android/3/core-classes/user/set-profiles/index.md b/src/sdk/android/3/core-classes/user/set-profiles/index.md index 50040138e..18d19a145 100644 --- a/src/sdk/android/3/core-classes/user/set-profiles/index.md +++ b/src/sdk/android/3/core-classes/user/set-profiles/index.md @@ -26,7 +26,7 @@ Updating a user will have no impact until the create or repla | Arguments | Type | Description | | ---------- | ------------------------ | ------------------------------------------------------------------------------- | -| `profiles` | array of Profile objects | An array of instantiated [Profile](/sdk/android/3/controllers/profile/) objects | +| `profiles` | array of Profile objects | An array of instantiated [Profile](/sdk/android/3/core-classes/profile/) objects | --- diff --git a/src/sdk/android/3/essentials/offline-tools/index.md b/src/sdk/android/3/essentials/offline-tools/index.md index b4a19c5fe..2d5d8bb49 100644 --- a/src/sdk/android/3/essentials/offline-tools/index.md +++ b/src/sdk/android/3/essentials/offline-tools/index.md @@ -24,7 +24,7 @@ _Offline mode_ refers to the time between a `disconnected` and a `reconnected` e ## Subscriptions -A subscription opens a permanent pipe between the client and Kuzzle. Whenever a real-time message or a modified document matches a subscription filter, a notification is sent by Kuzzle to the client (for instance, see the [Collection.subscribe](/sdk/android/3/controllers/collection/subscribe/) method). +A subscription opens a permanent pipe between the client and Kuzzle. Whenever a real-time message or a modified document matches a subscription filter, a notification is sent by Kuzzle to the client (for instance, see the [Collection.subscribe](/sdk/android/3/core-classes/collection/subscribe/) method). While in offline mode, the Kuzzle SDK client maintains all subscriptions configurations and, by default, when Kuzzle SDK client reconnects, all subscriptions are renewed. This behavior can be changed by setting the `autoResubscribe` to `false`, in which case, each subscription will have to be renewed manually using the `Room.renew` method. diff --git a/src/sdk/android/3/essentials/realtime-notifications/index.md b/src/sdk/android/3/essentials/realtime-notifications/index.md index 86972ba1d..9a4f6e307 100644 --- a/src/sdk/android/3/essentials/realtime-notifications/index.md +++ b/src/sdk/android/3/essentials/realtime-notifications/index.md @@ -7,7 +7,7 @@ order: 300 # Realtime Notifications -With Kuzzle, you don't [subscribe](/sdk/android/3/controllers/collection/subscribe/) to a room or a topic but, instead, you subscribe to documents. +With Kuzzle, you don't [subscribe](/sdk/android/3/core-classes/collection/subscribe/) to a room or a topic but, instead, you subscribe to documents. This means, that when you want to subscribe you must provide a set of filter definitions, using [Koncorde](/core/1/koncorde), that tell Kuzzle what documents should trigger a notification. Then, any time a document matches the defined filters, Kuzzle will send a notification to the subscriber. You can also provide an empty set of filters, which will tell Kuzzle that you want to listen to any change occurring on a collection, emulating the behavior of a traditional topic. @@ -29,7 +29,7 @@ You may subscribe multiple times to the same room, with identical or different s | Notification field | Type | Description | Possible values | | ------------------ | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | ----------------- | -| `document` | [Document](/sdk/android/3/controllers/document/) | Content of the document or real-time message that generated the notification | | +| `document` | [Document](/sdk/android/3/core-classes/document/) | Content of the document or real-time message that generated the notification | | | `scope` | string | Indicates if the document enters or exits the subscription scope | `in`, `out` | | `state` | string | Shows if the document is about to be changed, or if the change is done | `pending`, `done` | | `type` | string | Notification type | `document` | diff --git a/src/sdk/cpp/1/controllers/auth/login/index.md b/src/sdk/cpp/1/controllers/auth/login/index.md index 87aa926e1..39ed5cd54 100644 --- a/src/sdk/cpp/1/controllers/auth/login/index.md +++ b/src/sdk/cpp/1/controllers/auth/login/index.md @@ -32,9 +32,9 @@ std::string login( #### strategy -The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. +The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example on this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. diff --git a/src/sdk/cpp/1/controllers/collection/create/index.md b/src/sdk/cpp/1/controllers/collection/create/index.md index 483445c2e..434ecc347 100644 --- a/src/sdk/cpp/1/controllers/collection/create/index.md +++ b/src/sdk/cpp/1/controllers/collection/create/index.md @@ -7,7 +7,7 @@ description: Create a new collection # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. You can also provide an optional data mapping that allow you to exploit the full capabilities of our persistent data storage layer, [ElasticSearch](https://www.elastic.co/products/elasticsearch) (check here the [mapping capabilities of ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/mapping.html)). @@ -63,7 +63,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### options diff --git a/src/sdk/cpp/1/controllers/collection/update-mapping/index.md b/src/sdk/cpp/1/controllers/collection/update-mapping/index.md index 390a277a5..d65eefcc2 100644 --- a/src/sdk/cpp/1/controllers/collection/update-mapping/index.md +++ b/src/sdk/cpp/1/controllers/collection/update-mapping/index.md @@ -54,7 +54,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### options diff --git a/src/sdk/cpp/1/controllers/collection/validate-specifications/index.md b/src/sdk/cpp/1/controllers/collection/validate-specifications/index.md index f62d8bb76..17e4c2df5 100644 --- a/src/sdk/cpp/1/controllers/collection/validate-specifications/index.md +++ b/src/sdk/cpp/1/controllers/collection/validate-specifications/index.md @@ -39,7 +39,7 @@ kuzzleio::validation_response* validateSpecifications( A JSON string representing the specifications the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/datavalidation): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```json { diff --git a/src/sdk/cpp/1/core-classes/kuzzle/add-listener/index.md b/src/sdk/cpp/1/core-classes/kuzzle/add-listener/index.md index c6d991071..85662734d 100644 --- a/src/sdk/cpp/1/core-classes/kuzzle/add-listener/index.md +++ b/src/sdk/cpp/1/core-classes/kuzzle/add-listener/index.md @@ -23,7 +23,7 @@ virtual kuzzleio::KuzzleEventEmitter* addListener( | Argument | Type | Description | | ---------- | ---------------------------------------- | ------------------------------------------------------------ | -| `event` | 
kuzzleio::Event
| An enum representing the listened [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::Event
| An enum representing the listened [event](/sdk/cpp/1/essentials/events) | | `listener` | 
kuzzleio::SharedEventListener
| Smart pointer to a c++11 lambda | ### event diff --git a/src/sdk/cpp/1/core-classes/kuzzle/constructor/index.md b/src/sdk/cpp/1/core-classes/kuzzle/constructor/index.md index 56b672790..6cb36a34c 100644 --- a/src/sdk/cpp/1/core-classes/kuzzle/constructor/index.md +++ b/src/sdk/cpp/1/core-classes/kuzzle/constructor/index.md @@ -8,7 +8,7 @@ order: 50 # Constructor -Use this constructor to create a new instance of the SDK. +Use this constructor to create a new instance of the SDK. Each instance represent a different connection to a Kuzzle server with specific options. ## Signature @@ -28,10 +28,10 @@ kuzzleio::Kuzzle(kuzzleio::Protocol* protocol, const options& options); ### protocol -The protocol used to connect to the Kuzzle instance. +The protocol used to connect to the Kuzzle instance. It can be one of the following available protocols: -- [WebSocket](/sdk/cpp/1/websocket) +- [WebSocket](/sdk/cpp/1/protocols/websocket) ### options diff --git a/src/sdk/cpp/1/core-classes/kuzzle/introduction/index.md b/src/sdk/cpp/1/core-classes/kuzzle/introduction/index.md index 072f4996c..448997400 100644 --- a/src/sdk/cpp/1/core-classes/kuzzle/introduction/index.md +++ b/src/sdk/cpp/1/core-classes/kuzzle/introduction/index.md @@ -8,24 +8,24 @@ order: 0 # Kuzzle -The Kuzzle class is the main class of the SDK. +The Kuzzle class is the main class of the SDK. Once instantiated, it represents a connection to your Kuzzle server. It gives access to the different features of the SDKs: - access to the available controllers -- [SDK events](/sdk/cpp/1/events) handling +- [SDK events](/sdk/cpp/1/essentials/events) handling - activation of resilience to connection loss - offline queue management ## Network protocol -Each instance of the class communicates with the Kuzzle server through a class representing a network protocol implementation. -Theses protocol classes must implement the [Protocol](/sdk/cpp/1/protocol) class. +Each instance of the class communicates with the Kuzzle server through a class representing a network protocol implementation. +Theses protocol classes must implement the [Protocol](/sdk/cpp/1/virtual-classes/protocol) class. The following protocols are available in the SDK CPP 1: -- [WebSocket](/sdk/cpp/1/websocket) +- [WebSocket](/sdk/cpp/1/protocols/websocket) ## Volatile data diff --git a/src/sdk/cpp/1/core-classes/user-right/introduction/index.md b/src/sdk/cpp/1/core-classes/user-right/introduction/index.md index a560576d7..ae5fc1313 100644 --- a/src/sdk/cpp/1/core-classes/user-right/introduction/index.md +++ b/src/sdk/cpp/1/core-classes/user-right/introduction/index.md @@ -8,7 +8,7 @@ order: 0 # UserRight -The `UserRight` class is the SDK representation of a single [user's right](/core/1/guide/guides/essentials/user-authentication/#creating-users-default). +The `UserRight` class is the SDK representation of a single [user's right](/core/1/guides/essentials/user-authentication/#creating-users-default). Instances of the `UserRight` class are returned by the followings methods: diff --git a/src/sdk/cpp/1/core-classes/user/getters/index.md b/src/sdk/cpp/1/core-classes/user/getters/index.md index 884402e68..63e94d86a 100644 --- a/src/sdk/cpp/1/core-classes/user/getters/index.md +++ b/src/sdk/cpp/1/core-classes/user/getters/index.md @@ -20,7 +20,7 @@ const std::string& content() const; ## id -Returns the user's unique identifier (or [kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid-default)). +Returns the user's unique identifier (or [kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid-default)). ### Signature diff --git a/src/sdk/cpp/1/core-classes/user/introduction/index.md b/src/sdk/cpp/1/core-classes/user/introduction/index.md index 7e8e4d50e..dfb88fecc 100644 --- a/src/sdk/cpp/1/core-classes/user/introduction/index.md +++ b/src/sdk/cpp/1/core-classes/user/introduction/index.md @@ -8,7 +8,7 @@ order: 0 # User -The `User` class is the SDK representation of a Kuzzle [user](/core/1/guide/guides/essentials/user-authentication/#creating-users-default). +The `User` class is the SDK representation of a Kuzzle [user](/core/1/guides/essentials/user-authentication/#creating-users-default). Instances of the `User` class are returned by the following methods: diff --git a/src/sdk/cpp/1/essentials/getting-started/index.md b/src/sdk/cpp/1/essentials/getting-started/index.md index 123e0099a..146353055 100644 --- a/src/sdk/cpp/1/essentials/getting-started/index.md +++ b/src/sdk/cpp/1/essentials/getting-started/index.md @@ -21,7 +21,7 @@ You will learn : Before proceeding, please make sure your system meets the following requirements : - A C++ compiler that supports C++ 11 sush as: **gcc** version 4.5 or higher -- A running instance of Kuzzle Server (Kuzzle installation guide) +- A running instance of Kuzzle Server (Kuzzle installation guide) @@ -107,7 +107,7 @@ Document created successfuly ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guide/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: @@ -146,5 +146,5 @@ Now that you're more familiar with the Go SDK, you can dive even deeper to learn - discover what this SDK has to offer by browsing other sections of this documentation - learn how to use Koncorde to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to perform basic authentication -- follow our guide to learn how to manage users and how to set up fine-grained access control +- follow our guide to learn how to perform basic authentication +- follow our guide to learn how to manage users and how to set up fine-grained access control diff --git a/src/sdk/cpp/1/protocols/websocket/add-listener/index.md b/src/sdk/cpp/1/protocols/websocket/add-listener/index.md index e94ebf199..08b08d2d3 100644 --- a/src/sdk/cpp/1/protocols/websocket/add-listener/index.md +++ b/src/sdk/cpp/1/protocols/websocket/add-listener/index.md @@ -19,7 +19,7 @@ void addListener(kuzzleio::Event event, kuzzleio::EventListener* listener); | Argument | Type | Description | | ---------- | ------------------------------------ | ------------------------------------------------------------ | -| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/essentials/events) | | `listener` | 
kuzzleio::EventListener\*
| Pointer to a c++11 lambda | ### event diff --git a/src/sdk/cpp/1/protocols/websocket/constructor/index.md b/src/sdk/cpp/1/protocols/websocket/constructor/index.md index 17afbff8c..11a225633 100644 --- a/src/sdk/cpp/1/protocols/websocket/constructor/index.md +++ b/src/sdk/cpp/1/protocols/websocket/constructor/index.md @@ -8,7 +8,7 @@ order: 0 # Constructor -WebSocket is a class implementing the virtual class [Protocol](/sdk/cpp/1/protocol). +WebSocket is a class implementing the virtual class [Protocol](/sdk/cpp/1/virtual-classes/protocol). This is the main entry point to communicate with Websocket protocol. Pass an instance of this class to the [constructor of the Kuzzle SDK](/sdk/cpp/1/core-classes/kuzzle/) to use this protocol to connect to the Kuzzle server. diff --git a/src/sdk/cpp/1/protocols/websocket/emit-event/index.md b/src/sdk/cpp/1/protocols/websocket/emit-event/index.md index 1ec4246bf..95be63fd2 100644 --- a/src/sdk/cpp/1/protocols/websocket/emit-event/index.md +++ b/src/sdk/cpp/1/protocols/websocket/emit-event/index.md @@ -19,7 +19,7 @@ void emitEvent(kuzzleio::Event event); | Argument | Type | Description | | -------- | -------------------------- | ------------------------------------------------------------ | -| `event` | 
kuzzleio::Event
| An enum representing the listener [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::Event
| An enum representing the listener [event](/sdk/cpp/1/essentials/events) | ### event diff --git a/src/sdk/cpp/1/protocols/websocket/listener-count/index.md b/src/sdk/cpp/1/protocols/websocket/listener-count/index.md index 9e4c84188..6420c8574 100644 --- a/src/sdk/cpp/1/protocols/websocket/listener-count/index.md +++ b/src/sdk/cpp/1/protocols/websocket/listener-count/index.md @@ -19,7 +19,7 @@ int listenerCount(kuzzleio::Event event); | Argument | Type | Description | | -------- | -------------------------- | ------------------------------------------------------------ | -| `event` | 
kuzzleio::Event
| An enum representing the listener [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::Event
| An enum representing the listener [event](/sdk/cpp/1/essentials/events) | ### event diff --git a/src/sdk/cpp/1/protocols/websocket/remove-listener/index.md b/src/sdk/cpp/1/protocols/websocket/remove-listener/index.md index 3ad8af166..fc89f128d 100644 --- a/src/sdk/cpp/1/protocols/websocket/remove-listener/index.md +++ b/src/sdk/cpp/1/protocols/websocket/remove-listener/index.md @@ -19,7 +19,7 @@ void removeListener(kuzzleio::Event event, kuzzleio::EventListener* listener); | Argument | Type | Description | | ---------- | ------------------------------------ | ------------------------------------------------------------ | -| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/essentials/events) | | `listener` | 
kuzzleio::EventListener\*
| Pointer to a c++11 lambda | ### event diff --git a/src/sdk/cpp/1/virtual-classes/protocol/add-listener/index.md b/src/sdk/cpp/1/virtual-classes/protocol/add-listener/index.md index d6eb06040..06a8ecbbe 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/add-listener/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/add-listener/index.md @@ -19,7 +19,7 @@ virtual void addListener(kuzzleio::Event event, kuzzleio::EventListener* listene | Argument | Type | Description | | ---------- | ------------------------------------ | ------------------------------------------------------------ | -| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/events) | +| `event` | 
kuzzleio::KuzzleEvent
| An enum representing the listener [event](/sdk/cpp/1/essentials/events) | | `listener` | 
kuzzleio::EventListener\*
| Pointer to a c++11 lambda | ### event diff --git a/src/sdk/cpp/1/virtual-classes/protocol/emit-event/index.md b/src/sdk/cpp/1/virtual-classes/protocol/emit-event/index.md index 87d7329e0..16de12791 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/emit-event/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/emit-event/index.md @@ -23,7 +23,7 @@ virtual void emitEvent(kuzzleio::Event event) = 0; ### event -One of the following [event](/sdk/cpp/1/events): +One of the following [event](/sdk/cpp/1/essentials/events): ```cpp EVENT_CONNECTED, diff --git a/src/sdk/cpp/1/virtual-classes/protocol/listener-count/index.md b/src/sdk/cpp/1/virtual-classes/protocol/listener-count/index.md index bf45fa4d1..b1cadf1b9 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/listener-count/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/listener-count/index.md @@ -23,7 +23,7 @@ virtual int listenerCount(kuzzleio::Event event) = 0; ### event -One of the following [event](/sdk/cpp/1/events): +One of the following [event](/sdk/cpp/1/essentials/events): ```cpp EVENT_CONNECTED, diff --git a/src/sdk/cpp/1/virtual-classes/protocol/once/index.md b/src/sdk/cpp/1/virtual-classes/protocol/once/index.md index 09426021d..201e46401 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/once/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/once/index.md @@ -24,7 +24,7 @@ virtual void once(kuzzleio::Event event, kuzzleio::EventListener* listener) = 0; ### event -One of the following [event](/sdk/cpp/1/events): +One of the following [event](/sdk/cpp/1/essentials/events): ```cpp EVENT_CONNECTED, diff --git a/src/sdk/cpp/1/virtual-classes/protocol/remove-all-listeners/index.md b/src/sdk/cpp/1/virtual-classes/protocol/remove-all-listeners/index.md index f2cff53ff..89975b7ff 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/remove-all-listeners/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/remove-all-listeners/index.md @@ -24,7 +24,7 @@ virtual void removeAllListeners(kuzzleio::Event event) = 0; ### event -One of the following [event](/sdk/cpp/1/events): +One of the following [event](/sdk/cpp/1/essentials/events): ```cpp EVENT_CONNECTED, diff --git a/src/sdk/cpp/1/virtual-classes/protocol/remove-listener/index.md b/src/sdk/cpp/1/virtual-classes/protocol/remove-listener/index.md index 38da9daab..173d0ef0b 100644 --- a/src/sdk/cpp/1/virtual-classes/protocol/remove-listener/index.md +++ b/src/sdk/cpp/1/virtual-classes/protocol/remove-listener/index.md @@ -24,7 +24,7 @@ virtual void removeListener(kuzzleio::Event event, kuzzleio::EventListener* list ### event -One of the following [event](/sdk/cpp/1/events): +One of the following [event](/sdk/cpp/1/essentials/events): ```cpp EVENT_CONNECTED, diff --git a/src/sdk/go/1/controllers/auth/login/index.md b/src/sdk/go/1/controllers/auth/login/index.md index b70ccf0ae..161c39684 100644 --- a/src/sdk/go/1/controllers/auth/login/index.md +++ b/src/sdk/go/1/controllers/auth/login/index.md @@ -9,7 +9,7 @@ description: Authenticate a user Authenticates a user. -If this action is successful, all further requests emitted by this SDK instance will be in the name of the authenticated user, until either the authenticated token expires, the [logout](/sdk/go/1/controllers/auth/logout) action is called, or the [jwt](/sdk/go/1/core-structs/kuzzle/introduction/) property is manually unset. +If this action is successful, all further requests emitted by this SDK instance will be in the name of the authenticated user, until either the authenticated token expires, the [logout](/sdk/go/1/controllers/auth/logout) action is called, or the `jwt` property is manually unset. ## Arguments @@ -29,15 +29,15 @@ func (a *Auth) Login( #### strategy -The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. +The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn - The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/). + The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration/). ## Return diff --git a/src/sdk/go/1/controllers/collection/create/index.md b/src/sdk/go/1/controllers/collection/create/index.md index 188ba9885..48686f951 100644 --- a/src/sdk/go/1/controllers/collection/create/index.md +++ b/src/sdk/go/1/controllers/collection/create/index.md @@ -7,7 +7,7 @@ description: Create a new collection # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. You can also provide an optional data mapping that allow you to exploit the full capabilities of our persistent data storage layer, [ElasticSearch](https://www.elastic.co/products/elasticsearch) (check here the [mapping capabilities of ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/mapping.html)). @@ -47,7 +47,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### **options** diff --git a/src/sdk/go/1/controllers/collection/update-mapping/index.md b/src/sdk/go/1/controllers/collection/update-mapping/index.md index 2d9b3c613..de7926d27 100644 --- a/src/sdk/go/1/controllers/collection/update-mapping/index.md +++ b/src/sdk/go/1/controllers/collection/update-mapping/index.md @@ -45,7 +45,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### **options** diff --git a/src/sdk/go/1/controllers/collection/update-specifications/index.md b/src/sdk/go/1/controllers/collection/update-specifications/index.md index ff7c2f4bc..45d2384c9 100644 --- a/src/sdk/go/1/controllers/collection/update-specifications/index.md +++ b/src/sdk/go/1/controllers/collection/update-specifications/index.md @@ -30,7 +30,7 @@ UpdateSpecifications(index string, collection string, specifications json.RawMes A JSON representation of the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/datavalidation): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```json { @@ -51,7 +51,7 @@ Additional query options ## Return -Return a JSON representation of the specifications. +Return a JSON representation of the specifications. Return an error with a global description of errors. ## Usage diff --git a/src/sdk/go/1/controllers/collection/validate-specifications/index.md b/src/sdk/go/1/controllers/collection/validate-specifications/index.md index 9a3e1833a..56c387612 100644 --- a/src/sdk/go/1/controllers/collection/validate-specifications/index.md +++ b/src/sdk/go/1/controllers/collection/validate-specifications/index.md @@ -28,7 +28,7 @@ ValidateSpecifications(index string, collection string, specifications json.RawM A JSON representation of the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/datavalidation): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```json { diff --git a/src/sdk/go/1/core-structs/kuzzle-event-emitter/introduction/index.md b/src/sdk/go/1/core-structs/kuzzle-event-emitter/introduction/index.md index e8af3e19e..775020c67 100644 --- a/src/sdk/go/1/core-structs/kuzzle-event-emitter/introduction/index.md +++ b/src/sdk/go/1/core-structs/kuzzle-event-emitter/introduction/index.md @@ -10,4 +10,4 @@ order: 0 An interface standardizing the listening of events. -The [Kuzzle](/sdk-reference/go/1/kuzzle) class implements the `KuzzleEventEmitter` interface. +The [Kuzzle](/sdk/go/1/core-structs/kuzzle) class implements the `KuzzleEventEmitter` interface. diff --git a/src/sdk/go/1/core-structs/kuzzle-event-emitter/on/index.md b/src/sdk/go/1/core-structs/kuzzle-event-emitter/on/index.md index a78adde7a..7a1e47cdb 100644 --- a/src/sdk/go/1/core-structs/kuzzle-event-emitter/on/index.md +++ b/src/sdk/go/1/core-structs/kuzzle-event-emitter/on/index.md @@ -7,4 +7,4 @@ description: Alias for addListener # On -Alias for [AddListener](/sdk-reference/go/1/kuzzle-event-emitter/add-listener). +Alias for [AddListener](/sdk/go/1/core-structs/kuzzle-event-emitter/add-listener). diff --git a/src/sdk/go/1/core-structs/kuzzle/constructor/index.md b/src/sdk/go/1/core-structs/kuzzle/constructor/index.md index 915222bf3..88fdae279 100644 --- a/src/sdk/go/1/core-structs/kuzzle/constructor/index.md +++ b/src/sdk/go/1/core-structs/kuzzle/constructor/index.md @@ -8,10 +8,10 @@ order: 100 # Constructor -This is the main entry point to communicate with Kuzzle. +This is the main entry point to communicate with Kuzzle. Each instance represents a connection to Kuzzle with specific options. -This interface implements the [KuzzleEventEmitter](/sdk-reference/go/1/kuzzle-event-emitter) interface +This interface implements the [KuzzleEventEmitter](/sdk/go/1/core-structs/kuzzle-event-emitter) interface ## Signature @@ -27,7 +27,7 @@ NewKuzzle(protocol connection.Connection) (*Kuzzle, error) ### **protocol** -A [Protocol](/sdk/go/1/core-structs/protocols/) is a structure implementing the `connection.Connection` interface. +A [Protocol](/sdk/go/1/protocols/) is a structure implementing the `connection.Connection` interface. The available protocols are: - `websocket.Websocket` @@ -40,7 +40,7 @@ It takes the following arguments: | `host` | string | Kuzzle hostname to connect to | yes | | `options` | types.Options | Kuzzle connection configuration | yes | -The `options` parameter of the protocol constructor has the following properties. +The `options` parameter of the protocol constructor has the following properties. You can use standard getter/setter to use these properties. | Option | Type | Description | Default | Required | @@ -60,7 +60,7 @@ You can use standard getter/setter to use these properties. ## Getter & Setter -These properties of the Kuzzle struct can be writable. +These properties of the Kuzzle struct can be writable. For example, you can read the `volatile` property via `getVolatile()` and set it via `setVolatile()`. | Property name | Type | Description | Availability | @@ -94,12 +94,12 @@ For example, you can read the `volatile` property via `getVolatile()` and set it ## Return -A `Kuzzle` struct and an [error struct](/sdk/go/1/error-handling). +A `Kuzzle` struct and an [error struct](/sdk/go/1/error-handling). The `error` struct is nil if everything was ok. ## Usage -In a first step, you have to create a new `connection.Connection` and pass it to the constructor. +In a first step, you have to create a new `connection.Connection` and pass it to the constructor. By now the only connection available is `websocket.Websocket`. <<< ./snippets/constructor.go diff --git a/src/sdk/go/1/essentials/events/index.md b/src/sdk/go/1/essentials/events/index.md index 3f77f6708..a1658862d 100644 --- a/src/sdk/go/1/essentials/events/index.md +++ b/src/sdk/go/1/essentials/events/index.md @@ -8,9 +8,9 @@ order: 100 # Events -An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle](/sdk-reference/go/1/kuzzle) interface. +An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle](/sdk/go/1/core-structs/kuzzle) interface. -The API for interacting with events is described by our [KuzzleEventEmitter](/sdk-reference/go/1/kuzzle-event-emitter) interface documentation. +The API for interacting with events is described by our [KuzzleEventEmitter](/sdk/go/1/core-structs/kuzzle-event-emitter) interface documentation. # Emitted Events @@ -40,8 +40,8 @@ Triggered when a login attempt completes, either with a success or a failure res ## NetworkError -Triggered when the SDK has failed to connect to Kuzzle. -This event does not trigger the offline mode. +Triggered when the SDK has failed to connect to Kuzzle. +This event does not trigger the offline mode. **Channel signature:** `chan<- error` diff --git a/src/sdk/go/1/essentials/getting-started/index.md b/src/sdk/go/1/essentials/getting-started/index.md index 7bba01291..67c08a168 100644 --- a/src/sdk/go/1/essentials/getting-started/index.md +++ b/src/sdk/go/1/essentials/getting-started/index.md @@ -15,7 +15,7 @@ This page shows examples of scripts that **store** documents in Kuzzle, and of s Before proceeding, please make sure your system meets the following requirements: - **Go** version 1.9 or higher ([Go installation instructions](https://golang.org/doc/install)) -- A running Kuzzle server ([Kuzzle installation guide](/core/1/guide/guides/essentials/installing-kuzzle/)) +- A running Kuzzle server ([Kuzzle installation guide](/core/1/guides/essentials/installing-kuzzle/)) ::: ## Installation @@ -75,7 +75,7 @@ New document added to yellow-taxi collection! ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guide/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: @@ -113,5 +113,5 @@ Now that you're more familiar with the Go SDK, you can dive even deeper to learn - discover what this SDK has to offer by browsing other sections of this documentation - learn how to use [Koncorde](/core/1/koncorde) to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to perform [basic authentication](/core/1/guide/guides/essentials/user-authentication/#local-strategy) -- follow our guide to learn how to [manage users and how to set up fine-grained access control](/core/1/guide/guides/essentials/security/) +- follow our guide to learn how to perform [basic authentication](/core/1/guides/essentials/user-authentication/#local-strategy) +- follow our guide to learn how to [manage users and how to set up fine-grained access control](/core/1/guides/essentials/security/) diff --git a/src/sdk/java/1/controllers/auth/login/index.md b/src/sdk/java/1/controllers/auth/login/index.md index 2fd763ac4..0f58c1056 100644 --- a/src/sdk/java/1/controllers/auth/login/index.md +++ b/src/sdk/java/1/controllers/auth/login/index.md @@ -29,16 +29,16 @@ String login(String, String); #### strategy -The name of the authentication [strategy](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) used to log the user in. +The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentication/#authentication) used to log the user in. -Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guide/guides/kuzzle-depth/authentication/#authentication) may be required. +Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn - The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/). + The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration/). ## Return diff --git a/src/sdk/java/1/controllers/collection/create/index.md b/src/sdk/java/1/controllers/collection/create/index.md index 5eb2d9cf7..dab7f11b2 100644 --- a/src/sdk/java/1/controllers/collection/create/index.md +++ b/src/sdk/java/1/controllers/collection/create/index.md @@ -7,7 +7,7 @@ description: Create a new collection # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. You can also provide an optional data mapping that allow you to exploit the full capabilities of our persistent data storage layer, [ElasticSearch](https://www.elastic.co/products/elasticsearch) (check here the [mapping capabilities of ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/mapping.html)). @@ -49,7 +49,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### **options** diff --git a/src/sdk/java/1/controllers/collection/update-mapping/index.md b/src/sdk/java/1/controllers/collection/update-mapping/index.md index 3aaaeb139..99d12b128 100644 --- a/src/sdk/java/1/controllers/collection/update-mapping/index.md +++ b/src/sdk/java/1/controllers/collection/update-mapping/index.md @@ -46,7 +46,7 @@ The mapping must have a root field `properties` that contain the mapping definit } ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### **options** diff --git a/src/sdk/java/1/controllers/collection/update-specifications/index.md b/src/sdk/java/1/controllers/collection/update-specifications/index.md index 99320ffbc..06beca890 100644 --- a/src/sdk/java/1/controllers/collection/update-specifications/index.md +++ b/src/sdk/java/1/controllers/collection/update-specifications/index.md @@ -31,7 +31,7 @@ public String updateSpecifications(String index, String collection, String speci A JSON representation of the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/datavalidation): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```json { diff --git a/src/sdk/java/1/controllers/collection/validate-specifications/index.md b/src/sdk/java/1/controllers/collection/validate-specifications/index.md index 9e86555f5..39b00d7b6 100644 --- a/src/sdk/java/1/controllers/collection/validate-specifications/index.md +++ b/src/sdk/java/1/controllers/collection/validate-specifications/index.md @@ -31,7 +31,7 @@ io.kuzzle.sdk.ValidationResponse validateSpecifications((String index, String co A JSON representation of the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/datavalidation): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```json { diff --git a/src/sdk/java/1/essentials/getting-started/index.md b/src/sdk/java/1/essentials/getting-started/index.md index 5a0fc180a..56af93a79 100644 --- a/src/sdk/java/1/essentials/getting-started/index.md +++ b/src/sdk/java/1/essentials/getting-started/index.md @@ -15,7 +15,7 @@ This page shows examples of scripts that **store** documents in Kuzzle, and of s Before proceeding, please make sure your system meets the following requirements: - **Oracle JDK or OpenJDK** version 8 or higher ([OpenJDK installation instructions](https://openjdk.java.net/install/)) -- A running Kuzzle Server ([Kuzzle installation guide](/core/1/guide/guides/essentials/installing-kuzzle/)) +- A running Kuzzle Server ([Kuzzle installation guide](/core/1/guides/essentials/installing-kuzzle/)) ::: @@ -86,7 +86,7 @@ New document added to yellow-taxi collection! ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guide/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: @@ -129,5 +129,5 @@ Now that you're more familiar with the Java SDK, you can dive even deeper to lea - discover what this SDK has to offer by browsing other sections of this documentation - learn how to use [Koncorde](/core/1/koncorde) to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to perform [basic authentication](/core/1/guide/guides/essentials/user-authentication/#local-strategy) -- follow our guide to learn how to [manage users and how to set up fine-grained access control](/core/1/guide/guides/essentials/security/) +- follow our guide to learn how to perform [basic authentication](/core/1/guides/essentials/user-authentication/#local-strategy) +- follow our guide to learn how to [manage users and how to set up fine-grained access control](/core/1/guides/essentials/security/) diff --git a/src/sdk/js/5/core-classes/collection-mapping/constructor/index.md b/src/sdk/js/5/core-classes/collection-mapping/constructor/index.md index f2d7b0328..611fd4ecb 100644 --- a/src/sdk/js/5/core-classes/collection-mapping/constructor/index.md +++ b/src/sdk/js/5/core-classes/collection-mapping/constructor/index.md @@ -23,7 +23,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | Arguments | Type | Description | | ------------ | ----------------------------------- | --------------------------------- | -| `Collection` | [Collection](/sdk/js/5/collection/) | An instantiated Collection object | +| `Collection` | [Collection](/sdk/js/5/core-classes/collection/) | An instantiated Collection object | | `mapping` | JSON Object | Optional mapping | --- @@ -35,7 +35,7 @@ Once a field mapping has been set, it cannot be removed without reconstructing t | `headers` | JSON Object | Common headers for all sent documents. | get/set | | `mapping` | object | Easy-to-understand list of mappings per field | get/set | -**Note:** the `headers` property is inherited from the provided [Collection](/sdk/js/5/collection/) object and can be overrided +**Note:** the `headers` property is inherited from the provided [Collection](/sdk/js/5/core-classes/collection/) object and can be overrided ## Usage diff --git a/src/sdk/js/5/core-classes/collection/collection-mapping/index.md b/src/sdk/js/5/core-classes/collection/collection-mapping/index.md index 7cc1e32f0..b67ef427e 100644 --- a/src/sdk/js/5/core-classes/collection/collection-mapping/index.md +++ b/src/sdk/js/5/core-classes/collection/collection-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:collectionMapping # collectionMapping -Creates a new [CollectionMapping](/sdk/js/5/collection-mapping/) object, using its constructor. +Creates a new [CollectionMapping](/sdk/js/5/core-classes/collection-mapping/) object, using its constructor. --- @@ -21,7 +21,7 @@ Creates a new [CollectionMapping](/sdk/js/5/collection-mapping/) object, using i ## Return Value -Returns the newly created [CollectionMapping](/sdk/js/5/collection-mapping/) object. +Returns the newly created [CollectionMapping](/sdk/js/5/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/constructor/index.md b/src/sdk/js/5/core-classes/collection/constructor/index.md index 17ec3945c..ee06952a1 100644 --- a/src/sdk/js/5/core-classes/collection/constructor/index.md +++ b/src/sdk/js/5/core-classes/collection/constructor/index.md @@ -22,7 +22,7 @@ A collection is a set of data managed by Kuzzle. It acts like a data table for p | `collection` | string | The name of the collection you want to manipulate | | `index` | string | Name of the index containing the collection | -**Note:** We recommend you instantiate a Collection object by calling [Kuzzle.collection](/sdk/js/5/kuzzle/collection) rather than using the constructor directly +**Note:** We recommend you instantiate a Collection object by calling [Kuzzle.collection](/sdk/js/5/core-classes/kuzzle/collection) rather than using the constructor directly --- diff --git a/src/sdk/js/5/core-classes/collection/create-document/index.md b/src/sdk/js/5/core-classes/collection/create-document/index.md index 3497e2530..c095a75c9 100644 --- a/src/sdk/js/5/core-classes/collection/create-document/index.md +++ b/src/sdk/js/5/core-classes/collection/create-document/index.md @@ -7,7 +7,7 @@ description: Collection:createDocument # createDocument -Create a new document in Kuzzle and instantiate a [Document](/sdk/js/5/document/) object. +Create a new document in Kuzzle and instantiate a [Document](/sdk/js/5/core-classes/document/) object. --- @@ -15,7 +15,7 @@ Create a new document in Kuzzle and instantiate a [Document](/sdk/js/5/document/ | Arguments | Type | Description | | ---------- | ----------- | -------------------------------------- | -| `Document` | object | [Document](/sdk/js/5/document/) object | +| `Document` | object | [Document](/sdk/js/5/core-classes/document/) object | | `options` | JSON object | Optional parameters | | `callback` | function | Optional callback | @@ -51,7 +51,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns a [Document](/sdk/js/5/document/) object containing the newly created document. +Returns a [Document](/sdk/js/5/core-classes/document/) object containing the newly created document. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/create/index.md b/src/sdk/js/5/core-classes/collection/create/index.md index 4825c523c..31540b342 100644 --- a/src/sdk/js/5/core-classes/collection/create/index.md +++ b/src/sdk/js/5/core-classes/collection/create/index.md @@ -7,7 +7,7 @@ description: Collection:create # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. diff --git a/src/sdk/js/5/core-classes/collection/document/index.md b/src/sdk/js/5/core-classes/collection/document/index.md index 993a75d7f..542d6c44c 100644 --- a/src/sdk/js/5/core-classes/collection/document/index.md +++ b/src/sdk/js/5/core-classes/collection/document/index.md @@ -7,7 +7,7 @@ description: Collection:document # document -Creates a new [Document](/sdk/js/5/document/) object, using its constructor. +Creates a new [Document](/sdk/js/5/core-classes/document/) object, using its constructor. --- @@ -22,7 +22,7 @@ Creates a new [Document](/sdk/js/5/document/) object, using its constructor. ## Return Value -Returns the newly created [Document](/sdk/js/5/document) object. +Returns the newly created [Document](/sdk/js/5/core-classes/document) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/fetch-document/index.md b/src/sdk/js/5/core-classes/collection/fetch-document/index.md index 44345a98f..c63060213 100644 --- a/src/sdk/js/5/core-classes/collection/fetch-document/index.md +++ b/src/sdk/js/5/core-classes/collection/fetch-document/index.md @@ -7,7 +7,7 @@ description: Collection:fetchDocument # fetchDocument -Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/js/5/document/) object. +Retrieves a single stored document using its unique document ID, and returns it as a [Document](/sdk/js/5/core-classes/document/) object. --- @@ -31,7 +31,7 @@ Retrieves a single stored document using its unique document ID, and returns it ## Callback Response -Returns a [Document](/sdk/js/5/document/) object. +Returns a [Document](/sdk/js/5/core-classes/document/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/get-mapping/index.md b/src/sdk/js/5/core-classes/collection/get-mapping/index.md index 935b2827f..dacc65cc5 100644 --- a/src/sdk/js/5/core-classes/collection/get-mapping/index.md +++ b/src/sdk/js/5/core-classes/collection/get-mapping/index.md @@ -7,7 +7,7 @@ description: Collection:getMapping # getMapping -Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/js/5/collection-mapping/) object. +Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/js/5/core-classes/collection-mapping/) object. --- @@ -30,7 +30,7 @@ Retrieves the current mapping of this collection as a [CollectionMapping](/sdk/j ## Callback Response -Returns a [CollectionMapping](/sdk/js/5/collection-mapping/) object. +Returns a [CollectionMapping](/sdk/js/5/core-classes/collection-mapping/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/mcreate-document/index.md b/src/sdk/js/5/core-classes/collection/mcreate-document/index.md index f94c78e87..5a1a539d9 100644 --- a/src/sdk/js/5/core-classes/collection/mcreate-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mcreate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateDocument # mCreateDocument -Create the input [Documents](/sdk/js/5/document/). +Create the input [Documents](/sdk/js/5/core-classes/document/). --- @@ -15,7 +15,7 @@ Create the input [Documents](/sdk/js/5/document/). | Arguments | Type | Description | | ----------- | ----------- | -------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/js/5/document/) to create | +| `documents` | Document[] | Array of [Document](/sdk/js/5/core-classes/document/) to create | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md b/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md index 6c5b74081..4b23e9960 100644 --- a/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mcreate-or-replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mcreateOrReplaceDocument # mCreateOrReplaceDocument -Create or replace the input [Documents](/sdk/js/5/document/). +Create or replace the input [Documents](/sdk/js/5/core-classes/document/). --- @@ -15,7 +15,7 @@ Create or replace the input [Documents](/sdk/js/5/document/). | Arguments | Type | Description | | ----------- | ----------- | ------------------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/js/5/document/) to create or replace | +| `documents` | Document[] | Array of [Document](/sdk/js/5/core-classes/document/) to create or replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/js/5/core-classes/collection/mdelete-document/index.md b/src/sdk/js/5/core-classes/collection/mdelete-document/index.md index d0054e712..0700851c9 100644 --- a/src/sdk/js/5/core-classes/collection/mdelete-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mdelete-document/index.md @@ -7,7 +7,7 @@ description: Collection:mdeleteDocument # mDeleteDocument -Delete multiple [Documents](/sdk/js/5/document/) according to the input IDs. +Delete multiple [Documents](/sdk/js/5/core-classes/document/) according to the input IDs. --- diff --git a/src/sdk/js/5/core-classes/collection/mget-document/index.md b/src/sdk/js/5/core-classes/collection/mget-document/index.md index 64ffd6890..57baa2a9d 100644 --- a/src/sdk/js/5/core-classes/collection/mget-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mget-document/index.md @@ -7,7 +7,7 @@ description: Collection:mgetDocument # mGetDocument -Get multiple [Documents](/sdk/js/5/document/) according to the input document IDs. +Get multiple [Documents](/sdk/js/5/core-classes/document/) according to the input document IDs. --- diff --git a/src/sdk/js/5/core-classes/collection/mreplace-document/index.md b/src/sdk/js/5/core-classes/collection/mreplace-document/index.md index be188cbb9..ed5cb19fe 100644 --- a/src/sdk/js/5/core-classes/collection/mreplace-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mreplace-document/index.md @@ -7,7 +7,7 @@ description: Collection:mreplaceDocument # mReplaceDocument -Replace the provided [Documents](/sdk/js/5/document/). +Replace the provided [Documents](/sdk/js/5/core-classes/document/). --- @@ -15,7 +15,7 @@ Replace the provided [Documents](/sdk/js/5/document/). | Arguments | Type | Description | | ----------- | ----------- | --------------------------------------------------- | -| `documents` | Document[] | Array of [Document](/sdk/js/5/document/) to replace | +| `documents` | Document[] | Array of [Document](/sdk/js/5/core-classes/document/) to replace | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/js/5/core-classes/collection/mupdate-document/index.md b/src/sdk/js/5/core-classes/collection/mupdate-document/index.md index 302470e9c..f34f7c7f5 100644 --- a/src/sdk/js/5/core-classes/collection/mupdate-document/index.md +++ b/src/sdk/js/5/core-classes/collection/mupdate-document/index.md @@ -7,7 +7,7 @@ description: Collection:mupdateDocument # mUpdateDocument -Update the provided [Documents](/sdk/js/5/document/). +Update the provided [Documents](/sdk/js/5/core-classes/document/). --- @@ -15,7 +15,7 @@ Update the provided [Documents](/sdk/js/5/document/). | Arguments | Type | Description | | ----------- | ----------- | --------------------------------------------------- | -| `documents` | Document[] | Array of [Documents](/sdk/js/5/document/) to update | +| `documents` | Document[] | Array of [Documents](/sdk/js/5/core-classes/document/) to update | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/js/5/core-classes/collection/publish-message/index.md b/src/sdk/js/5/core-classes/collection/publish-message/index.md index 6e0cd7cf6..d490b23a7 100644 --- a/src/sdk/js/5/core-classes/collection/publish-message/index.md +++ b/src/sdk/js/5/core-classes/collection/publish-message/index.md @@ -15,7 +15,7 @@ Publish a real-time message. | Arguments | Type | Description | | ---------- | ----------- | -------------------------------------- | -| `Document` | object | [Document](/sdk/js/5/document/) object | +| `Document` | object | [Document](/sdk/js/5/core-classes/document/) object | | `options` | JSON Object | Optional parameters | | `callback` | function | Optional callback | diff --git a/src/sdk/js/5/core-classes/collection/replace-document/index.md b/src/sdk/js/5/core-classes/collection/replace-document/index.md index b15197417..18547e5d0 100644 --- a/src/sdk/js/5/core-classes/collection/replace-document/index.md +++ b/src/sdk/js/5/core-classes/collection/replace-document/index.md @@ -7,7 +7,7 @@ description: Collection:replaceDocument # replaceDocument -Replace an existing document and return the updated version as a [Document](/sdk/js/5/document/) object. +Replace an existing document and return the updated version as a [Document](/sdk/js/5/core-classes/document/) object. --- @@ -40,7 +40,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an updated [Document](/sdk/js/5/document/) object. +Returns an updated [Document](/sdk/js/5/core-classes/document/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/room/index.md b/src/sdk/js/5/core-classes/collection/room/index.md index e37260f40..892651950 100644 --- a/src/sdk/js/5/core-classes/collection/room/index.md +++ b/src/sdk/js/5/core-classes/collection/room/index.md @@ -7,7 +7,7 @@ description: Collection:room # room -Creates a new [Room](/sdk/js/5/room/) object, using its constructor. +Creates a new [Room](/sdk/js/5/core-classes/room/) object, using its constructor. --- @@ -19,13 +19,13 @@ Creates a new [Room](/sdk/js/5/room/) object, using its constructor. ## Options -Provided options are passed directly to the [Room](/sdk/js/5/room/) object constructor. +Provided options are passed directly to the [Room](/sdk/js/5/core-classes/room/) object constructor. --- ## Return Value -Returns the newly created [Room](/sdk/js/5/room/) object. +Returns the newly created [Room](/sdk/js/5/core-classes/room/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/collection/scroll/index.md b/src/sdk/js/5/core-classes/collection/scroll/index.md index c81c01de0..7bee3691b 100644 --- a/src/sdk/js/5/core-classes/collection/scroll/index.md +++ b/src/sdk/js/5/core-classes/collection/scroll/index.md @@ -7,7 +7,7 @@ description: Collection:scroll # scroll -Returns a [SearchResult](/sdk/js/5/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. +Returns a [SearchResult](/sdk/js/5/core-classes/search-result/) object containing the next page of the scroll session, and the `scrollId` to be used in the next `scroll` action. A scroll session is always initiated by a `search` action and including the `scroll` argument; more information below.
@@ -15,7 +15,7 @@ There is a small delay between the time a document is created and its availabili
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- @@ -41,7 +41,7 @@ There is a small delay between the time a document is created and its availabili ## Callback Response -Returns an instantiated [SearchResult](/sdk/js/5/search-result) object. +Returns an instantiated [SearchResult](/sdk/js/5/core-classes/search-result) object. --- diff --git a/src/sdk/js/5/core-classes/collection/search/index.md b/src/sdk/js/5/core-classes/collection/search/index.md index 72d214ff1..7326c94ef 100644 --- a/src/sdk/js/5/core-classes/collection/search/index.md +++ b/src/sdk/js/5/core-classes/collection/search/index.md @@ -19,9 +19,9 @@ When processing a large number of documents (i.e. more than 1000), using `search Pagination of results can be done by using the from and size but the cost becomes prohibitive when deep pagination is reached. In fact, Elasticsearch, Kuzzle's embedded database, limits results to 10,000 records by default. -Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/js/5/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/js/5/search-result/fetch-next). +Instead, the recommended way to process a large number of documents is to use [`Collection.scroll`](/sdk/js/5/core-classes/collection/scroll/) or, easier, [`SearchResult.fetchNext`](/sdk/js/5/core-classes/search-result/fetch-next). -See [`SearchResult.fetchNext`](/sdk/js/5/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. +See [`SearchResult.fetchNext`](/sdk/js/5/core-classes/search-result/fetch-next/#how-to-process-every-document-of-a-collection) for an example of how to process every document of a collection. --- @@ -45,14 +45,14 @@ See [`SearchResult.fetchNext`](/sdk/js/5/search-result/fetch-next/#how-to-proces | `size` | number | Provide the maximum number of results of the request (used to paginate results) | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- ## Callback Response -Returns an instance of [SearchResult](/sdk/js/5/search-result). +Returns an instance of [SearchResult](/sdk/js/5/core-classes/search-result). ## Usage diff --git a/src/sdk/js/5/core-classes/collection/subscribe/index.md b/src/sdk/js/5/core-classes/collection/subscribe/index.md index 395aecfee..a6ca04c71 100644 --- a/src/sdk/js/5/core-classes/collection/subscribe/index.md +++ b/src/sdk/js/5/core-classes/collection/subscribe/index.md @@ -34,7 +34,7 @@ The provided callback will be called everytime a [notification](/sdk/js/5/essent | `users` | string | Filter notifications fired upon a user entering the room (user: `in`), leaving the room (user: `out`), or both (user: `all`). Setting this variable to `none` prevents receiving these notifications | `none` | The `options` object is directly passed to the Room constructor. -See the [Room object](/sdk/js/5/room/) documentation for more information about these options and notifications. +See the [Room object](/sdk/js/5/core-classes/room/) documentation for more information about these options and notifications. --- diff --git a/src/sdk/js/5/core-classes/collection/update-document/index.md b/src/sdk/js/5/core-classes/collection/update-document/index.md index 68ed7f9d8..8892252d8 100644 --- a/src/sdk/js/5/core-classes/collection/update-document/index.md +++ b/src/sdk/js/5/core-classes/collection/update-document/index.md @@ -7,7 +7,7 @@ description: Collection:updateDocument # updateDocument -Update parts of a document, by replacing some fields or adding new ones. +Update parts of a document, by replacing some fields or adding new ones. Note that you cannot remove fields this way: missing fields will simply be left unchanged. --- @@ -42,7 +42,7 @@ Returns the `Collection` object to allow chaining. ## Callback Response -Returns an up-to-date [Document](/sdk/js/5/document/) object. +Returns an up-to-date [Document](/sdk/js/5/core-classes/document/) object. ## Usage diff --git a/src/sdk/js/5/core-classes/document/subscribe/index.md b/src/sdk/js/5/core-classes/document/subscribe/index.md index 48a9c4d9b..93b07d030 100644 --- a/src/sdk/js/5/core-classes/document/subscribe/index.md +++ b/src/sdk/js/5/core-classes/document/subscribe/index.md @@ -25,7 +25,7 @@ The provided callback will be called everytime a [notification](/sdk/js/5/essent ## Options -Options are directly passed to the [Room](/sdk/js/5/room/) object constructor. +Options are directly passed to the [Room](/sdk/js/5/core-classes/room/) object constructor. --- diff --git a/src/sdk/js/5/core-classes/kuzzle/collection/index.md b/src/sdk/js/5/core-classes/kuzzle/collection/index.md index 5fbc8ec1b..ae8febbf0 100644 --- a/src/sdk/js/5/core-classes/kuzzle/collection/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/collection/index.md @@ -7,7 +7,7 @@ description: Kuzzle:collection # collection -Instantiates a new [Collection](/sdk/js/5/collection) object. +Instantiates a new [Collection](/sdk/js/5/core-classes/collection) object. --- @@ -26,7 +26,7 @@ The `index` argument takes precedence over the default index. ## Return Value -Returns a [Collection](/sdk/js/5/collection) object. +Returns a [Collection](/sdk/js/5/core-classes/collection) object. ## Usage diff --git a/src/sdk/js/5/core-classes/kuzzle/create-index/index.md b/src/sdk/js/5/core-classes/kuzzle/create-index/index.md index e3427ec31..025c48f4b 100644 --- a/src/sdk/js/5/core-classes/kuzzle/create-index/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/create-index/index.md @@ -15,7 +15,7 @@ Create a new empty index, with no associated mapping. | Arguments | Type | Description | | ---------- | ----------- | --------------------------------------------------------------------------------------------------- | -| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/js/5/kuzzle/#properties) | +| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/js/5/core-classes/kuzzle/#properties) | | `options` | JSON object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/js/5/core-classes/kuzzle/disconnect/index.md b/src/sdk/js/5/core-classes/kuzzle/disconnect/index.md index ba26d1d98..57a6f0842 100644 --- a/src/sdk/js/5/core-classes/kuzzle/disconnect/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/disconnect/index.md @@ -7,8 +7,8 @@ description: Kuzzle:disconnect # disconnect -Closes the current connection, and frees all allocated resources. -Contrary to the `offline` state (when the network connection is unexpectedly lost), `disconnect()` invalidates the instance, which cannot be used until [connect()](/sdk/js/5/kuzzle/connect) is explicitly called. +Closes the current connection, and frees all allocated resources. +Contrary to the `offline` state (when the network connection is unexpectedly lost), `disconnect()` invalidates the instance, which cannot be used until [connect()](/sdk/js/5/core-classes/kuzzle/connect) is explicitly called. This action does not trigger a `disconnected` event since this event is triggered when an unexpected disconnection occur. ## Usage diff --git a/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md b/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md index 2ef986d13..602f3dc51 100644 --- a/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/get-auto-refresh/index.md @@ -29,7 +29,7 @@ The `getAutoRefresh` function returns the current `autoRefresh` status for the g | Arguments | Type | Description | | ---------- | ----------- | --------------------------------------------------------------------------------------------------- | -| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/js/5/kuzzle/#properties) | +| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/js/5/core-classes/kuzzle/#properties) | | `options` | JSON object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md b/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md index c7fc66c63..87cf1c5bf 100644 --- a/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/get-my-credentials/index.md @@ -7,7 +7,7 @@ description: Kuzzle:getMyCredentials # getMyCredentials -Get [credential information](/core/1/guide/guides/essentials/user-authentication/#user-credentials) for the current user. +Get [credential information](/core/1/guides/essentials/user-authentication/#user-credentials) for the current user. --- diff --git a/src/sdk/js/5/core-classes/kuzzle/login/index.md b/src/sdk/js/5/core-classes/kuzzle/login/index.md index 32a7652aa..24c8e31a5 100644 --- a/src/sdk/js/5/core-classes/kuzzle/login/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/login/index.md @@ -15,11 +15,11 @@ This is the case, for instance, with the `local` authentication strategy. If the request succeeds but there is no token, then it means that the chosen strategy is a two-steps authentication method, such as the OAUTH strategy. In that case, the `loginAttempt` event is **not** fired. To complete the login, the `setJwtToken` method must be called either with a token or with an appropriate Kuzzle response. -If the login attempt fails, the `loginAttempt` event is fired with the following response: +If the login attempt fails, the `loginAttempt` event is fired with the following response: `{ success: false, error: 'error message' }`
-This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more. +This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more.
--- diff --git a/src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md b/src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md index 1b056336d..004032f22 100644 --- a/src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/memory-storage/index.md @@ -7,4 +7,4 @@ description: Kuzzle:memoryStorage ## memoryStorage -A [MemoryStorage](/sdk/js/5/memory-storage) singleton. +A [MemoryStorage](/sdk/js/5/core-classes/memory-storage) singleton. diff --git a/src/sdk/js/5/core-classes/kuzzle/query/index.md b/src/sdk/js/5/core-classes/kuzzle/query/index.md index 33917c09f..1b4cfd226 100644 --- a/src/sdk/js/5/core-classes/kuzzle/query/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/query/index.md @@ -42,7 +42,7 @@ Refer to Kuzzle's API Reference here ## query -## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/api-reference/controller-document/search/)) +## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/controllers/document/search/)) ## Options diff --git a/src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md b/src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md index e7d435f9a..c786e737c 100644 --- a/src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/refresh-index/index.md @@ -8,7 +8,7 @@ description: Kuzzle:refreshIndex # refreshIndex When writing or deleting documents in Kuzzle, the update needs to be indexed before being reflected -in the search index. +in the search index. By default, this operation can take up to 1 second. Given an index, the `refresh` action forces a [`refresh`](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-refresh.html), @@ -29,7 +29,7 @@ on it, making the documents visible to search immediately. | Argument | Type | Description | | ---------- | ----------- | -------------------------------------------------------------------------------------------------------------- | -| `index` | string | _Optional_. The index to refresh. If not set, defaults to [kuzzle.defaultIndex](/sdk/js/5/kuzzle/#properties). | +| `index` | string | _Optional_. The index to refresh. If not set, defaults to [kuzzle.defaultIndex](/sdk/js/5/core-classes/kuzzle/#properties). | | `options` | JSON object | Optional parameters | | `callback` | function | _Optional_. Callback handling the response. | diff --git a/src/sdk/js/5/core-classes/kuzzle/security/index.md b/src/sdk/js/5/core-classes/kuzzle/security/index.md index 1da5e17aa..83d944dda 100644 --- a/src/sdk/js/5/core-classes/kuzzle/security/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/security/index.md @@ -7,4 +7,4 @@ description: Kuzzle:security # security -A [Security](/sdk/js/5/security) singleton. +A [Security](/sdk/js/5/core-classes/security) singleton. diff --git a/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md b/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md index 7ba120896..e7dc7c4c5 100644 --- a/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/set-auto-refresh/index.md @@ -29,7 +29,7 @@ Given an index, the `setAutoRefresh` function updates its `autoRefresh` status. | Argument | Type | Description | | ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `index` | string | _Optional_ The index to set the `autoRefresh` for. If not set, defaults to [kuzzle.defaultIndex](/sdk/js/5/kuzzle/#properties). | +| `index` | string | _Optional_ The index to set the `autoRefresh` for. If not set, defaults to [kuzzle.defaultIndex](/sdk/js/5/core-classes/kuzzle/#properties). | | `autoRefresh` | boolean | The value to set for the `autoRefresh` setting. | | `options` | JSON object | Optional parameters | | `callback` | function | _Optional_ Callback handling the response | diff --git a/src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md b/src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md index 99f4dee81..24748085e 100644 --- a/src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/start-queuing/index.md @@ -7,7 +7,7 @@ description: Kuzzle:startQueuing # startQueuing -Starts the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/js/5/kuzzle/#properties) option is set to `false`. +Starts the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/js/5/core-classes/kuzzle/#properties) option is set to `false`. --- diff --git a/src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md b/src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md index 2b1cdc2cb..87144629f 100644 --- a/src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/stop-queuing/index.md @@ -7,7 +7,7 @@ description: Kuzzle:stopQueuing # stopQueuing -Stops the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/js/5/kuzzle/#properties) option is set to `false`. +Stops the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/js/5/core-classes/kuzzle/#properties) option is set to `false`. --- diff --git a/src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md b/src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md index 3ca8bd993..da5d4ed9b 100644 --- a/src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md +++ b/src/sdk/js/5/core-classes/kuzzle/who-am-i/index.md @@ -21,7 +21,7 @@ Returns informations about the user who is currently loggedin. ## Callback Response -Returns an instantiated [User](/sdk/js/5/user) object. +Returns an instantiated [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/memory-storage/constructor/index.md b/src/sdk/js/5/core-classes/memory-storage/constructor/index.md index b01f3f487..25829924d 100644 --- a/src/sdk/js/5/core-classes/memory-storage/constructor/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/constructor/index.md @@ -17,7 +17,7 @@ It uses Redis internally, and most of its underlying functions are exposed by Ku | Arguments | Type | Description | | --------- | ------ | ----------------------------------------------------- | -| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/js/5/kuzzle) SDK object | +| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/js/5/core-classes/kuzzle) SDK object | ## Usage diff --git a/src/sdk/js/5/core-classes/memory-storage/geodist/index.md b/src/sdk/js/5/core-classes/memory-storage/geodist/index.md index 3b4420f39..66fa1674c 100644 --- a/src/sdk/js/5/core-classes/memory-storage/geodist/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/geodist/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geodist # geodist -Returns the distance between two geospatial members of a key (see [geoadd](/sdk/js/5/memory-storage/geoadd)). +Returns the distance between two geospatial members of a key (see [geoadd](/sdk/js/5/core-classes/memory-storage/geoadd)). The returned distance is expressed in meters by default. [[_Redis documentation_]](https://redis.io/commands/geodist) diff --git a/src/sdk/js/5/core-classes/memory-storage/geohash/index.md b/src/sdk/js/5/core-classes/memory-storage/geohash/index.md index 3fb758bb4..b8c934f64 100644 --- a/src/sdk/js/5/core-classes/memory-storage/geohash/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/geohash/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geohash # geohash -Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/js/5/memory-storage/geoadd)). +Returns a valid [geohash](https://en.wikipedia.org/wiki/Geohash) for the provided key's members (see [geoadd](/sdk/js/5/core-classes/memory-storage/geoadd)). [[_Redis documentation_]](https://redis.io/commands/geohash) diff --git a/src/sdk/js/5/core-classes/memory-storage/geopos/index.md b/src/sdk/js/5/core-classes/memory-storage/geopos/index.md index 588a6158e..fc7c7b489 100644 --- a/src/sdk/js/5/core-classes/memory-storage/geopos/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/geopos/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:geopos # geopos -Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/js/5/memory-storage/geoadd)). +Returns the positions (longitude, latitude) of the provided key's members (see [geoadd](/sdk/js/5/core-classes/memory-storage/geoadd)). [[_Redis documentation_]](https://redis.io/commands/geopos) diff --git a/src/sdk/js/5/core-classes/memory-storage/georadius/index.md b/src/sdk/js/5/core-classes/memory-storage/georadius/index.md index 9c3c2cc83..8f24a2389 100644 --- a/src/sdk/js/5/core-classes/memory-storage/georadius/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/georadius/index.md @@ -31,7 +31,7 @@ description: MemoryStorage:georadius ] ``` -Returns the members (added with [geoadd](/sdk/js/5/memory-storage/geoadd)) of a given key inside the provided geospatial radius. +Returns the members (added with [geoadd](/sdk/js/5/core-classes/memory-storage/geoadd)) of a given key inside the provided geospatial radius. [[_Redis documentation_]](https://redis.io/commands/georadius) diff --git a/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md index 7b71a1c56..829fa499c 100644 --- a/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/georadiusbymember/index.md @@ -25,7 +25,7 @@ description: MemoryStorage:georadiusbymember ] ``` -Returns the members (added with [geoadd](/sdk/js/5/memory-storage/geoadd)) of a given key inside the provided geospatial radius, centered around one of a key's member. +Returns the members (added with [geoadd](/sdk/js/5/core-classes/memory-storage/geoadd)) of a given key inside the provided geospatial radius, centered around one of a key's member. [[_Redis documentation_]](https://redis.io/commands/georadiusbymember) --- diff --git a/src/sdk/js/5/core-classes/memory-storage/hscan/index.md b/src/sdk/js/5/core-classes/memory-storage/hscan/index.md index 703d68ce7..a22c45412 100644 --- a/src/sdk/js/5/core-classes/memory-storage/hscan/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/hscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:hscan # hscan -Identical to [scan](/sdk/js/5/memory-storage/scan), except that `hscan` iterates over the fields contained in a hash. +Identical to [scan](/sdk/js/5/core-classes/memory-storage/scan), except that `hscan` iterates over the fields contained in a hash. [[_Redis documentation_]](https://redis.io/commands/hscan) diff --git a/src/sdk/js/5/core-classes/memory-storage/pfcount/index.md b/src/sdk/js/5/core-classes/memory-storage/pfcount/index.md index 972573a51..1d0e36b2c 100644 --- a/src/sdk/js/5/core-classes/memory-storage/pfcount/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/pfcount/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:pfcount # pfcount -Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/js/5/memory-storage/pfadd)). +Returns the probabilistic cardinality of a [HyperLogLog](https://en.wikipedia.org/wiki/HyperLogLog) data structure, or of the merged HyperLogLog structures if more than 1 is provided (see [pfadd](/sdk/js/5/core-classes/memory-storage/pfadd)). [[_Redis documentation_]](https://redis.io/commands/pfcount) diff --git a/src/sdk/js/5/core-classes/memory-storage/sort/index.md b/src/sdk/js/5/core-classes/memory-storage/sort/index.md index d0f805fd4..9a5c9c7f4 100644 --- a/src/sdk/js/5/core-classes/memory-storage/sort/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/sort/index.md @@ -11,7 +11,7 @@ Sorts and returns elements contained in a list, a set of unique values or a sort By default, sorting is numeric and elements are compared by their value interpreted as double precision floating point number.
-While Kuzzle's API supports the "store" option for this command, Kuzzle SDK methods do not. To sort and store in the same process, use the query method +While Kuzzle's API supports the "store" option for this command, Kuzzle SDK methods do not. To sort and store in the same process, use the query method
[[_Redis documentation_]](https://redis.io/commands/sort) diff --git a/src/sdk/js/5/core-classes/memory-storage/sscan/index.md b/src/sdk/js/5/core-classes/memory-storage/sscan/index.md index 3c57f0e17..e10263a64 100644 --- a/src/sdk/js/5/core-classes/memory-storage/sscan/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/sscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:sscan # sscan -Identical to [scan](/sdk/js/5/memory-storage/scan), except that `sscan` iterates the members held by a set of unique values. +Identical to [scan](/sdk/js/5/core-classes/memory-storage/scan), except that `sscan` iterates the members held by a set of unique values. [[_Redis documentation_]](https://redis.io/commands/sscan) diff --git a/src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md index e7351f5f4..70babe86c 100644 --- a/src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/zrevrange/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrange # zrevrange -Identical to [zrange](/sdk/js/5/memory-storage/zrange), except that the sorted set is traversed in descending order. +Identical to [zrange](/sdk/js/5/core-classes/memory-storage/zrange), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrange) diff --git a/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md index 38115ac9b..2c6b5f3ec 100644 --- a/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/zrevrangebylex/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebylex # zrevrangebylex -Identical to [zrangebylex](/sdk/js/5/memory-storage/zrangebylex) except that the sorted set is traversed in descending order. +Identical to [zrangebylex](/sdk/js/5/core-classes/memory-storage/zrangebylex) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebylex) diff --git a/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md b/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md index 8265d03bd..c65f767c6 100644 --- a/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/zrevrangebyscore/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zrevrangebyscore # zrevrangebyscore -Identical to [zrangebyscore](/sdk/js/5/memory-storage/zrangebyscore) except that the sorted set is traversed in descending order. +Identical to [zrangebyscore](/sdk/js/5/core-classes/memory-storage/zrangebyscore) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) diff --git a/src/sdk/js/5/core-classes/memory-storage/zscan/index.md b/src/sdk/js/5/core-classes/memory-storage/zscan/index.md index 736ae5c26..5155f1212 100644 --- a/src/sdk/js/5/core-classes/memory-storage/zscan/index.md +++ b/src/sdk/js/5/core-classes/memory-storage/zscan/index.md @@ -7,7 +7,7 @@ description: MemoryStorage:zscan # zscan -Identical to [scan](/sdk/js/5/memory-storage/scan), except that `zscan` iterates the members held by a sorted set. +Identical to [scan](/sdk/js/5/core-classes/memory-storage/scan), except that `zscan` iterates the members held by a sorted set. [[_Redis documentation_]](https://redis.io/commands/zscan) diff --git a/src/sdk/js/5/core-classes/profile/add-policy/index.md b/src/sdk/js/5/core-classes/profile/add-policy/index.md index 5f9ed81e3..5f5a8072e 100644 --- a/src/sdk/js/5/core-classes/profile/add-policy/index.md +++ b/src/sdk/js/5/core-classes/profile/add-policy/index.md @@ -10,7 +10,7 @@ description: Profile:addPolicy Adds a role to the security profile.
-Updating a security profile will have no impact until the save method is called +Updating a security profile will have no impact until the save method is called
--- diff --git a/src/sdk/js/5/core-classes/profile/constructor/index.md b/src/sdk/js/5/core-classes/profile/constructor/index.md index 2416cc795..0d402491f 100644 --- a/src/sdk/js/5/core-classes/profile/constructor/index.md +++ b/src/sdk/js/5/core-classes/profile/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructors -Instantiates a new `Profile` object, representing a security [profile](/core/1/guide/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/js/5/role) objects. +Instantiates a new `Profile` object, representing a security [profile](/core/1/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/js/5/core-classes/role) objects. --- @@ -16,7 +16,7 @@ Instantiates a new `Profile` object, representing a security [profile](/core/1/g | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------- | -| `Security` | Security | An instantiated [Security](/sdk/js/5/security) object | +| `Security` | Security | An instantiated [Security](/sdk/js/5/core-classes/security) object | | `id` | string | Unique profile identifier | | `content` | JSON Object | Profile content | | `meta` | JSON Object | Profile metadata | diff --git a/src/sdk/js/5/core-classes/role/constructor/index.md b/src/sdk/js/5/core-classes/role/constructor/index.md index 7695059a8..4a9122931 100644 --- a/src/sdk/js/5/core-classes/role/constructor/index.md +++ b/src/sdk/js/5/core-classes/role/constructor/index.md @@ -16,7 +16,7 @@ Instantiates a new `Role` object, which defines a set of right policies. | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------- | -| `Security` | Security | An instantiated [Security](/sdk/js/5/security) object | +| `Security` | Security | An instantiated [Security](/sdk/js/5/core-classes/security) object | | `id` | string | Unique role identifier | | `content` | JSON Object | Role content | | `meta` | JSON Object | Role metadata | diff --git a/src/sdk/js/5/core-classes/role/set-content/index.md b/src/sdk/js/5/core-classes/role/set-content/index.md index c01d4a2bd..b4d3db07d 100644 --- a/src/sdk/js/5/core-classes/role/set-content/index.md +++ b/src/sdk/js/5/core-classes/role/set-content/index.md @@ -10,7 +10,7 @@ description: Role:setContent Replaces the content of the `Role` object.
-Updating a role content will have no impact until the save method is called +Updating a role content will have no impact until the save method is called
--- diff --git a/src/sdk/js/5/core-classes/role/update/index.md b/src/sdk/js/5/core-classes/role/update/index.md index 027399429..c330497f2 100644 --- a/src/sdk/js/5/core-classes/role/update/index.md +++ b/src/sdk/js/5/core-classes/role/update/index.md @@ -15,11 +15,11 @@ Updates the role object in Kuzzle. In other words, you always need to provide the complete role definition in the updateContent object.

- This method has the same effect as calling setContent followed by the save method. + This method has the same effect as calling setContent followed by the save method.

-To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions). +To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions). --- diff --git a/src/sdk/js/5/core-classes/search-result/constructor/index.md b/src/sdk/js/5/core-classes/search-result/constructor/index.md index 2fd043293..e62662d70 100644 --- a/src/sdk/js/5/core-classes/search-result/constructor/index.md +++ b/src/sdk/js/5/core-classes/search-result/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructor -This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/js/5/collection/search) or a [scroll](/sdk/js/5/collection/scroll) request. +This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a [search](/sdk/js/5/core-classes/collection/search) or a [scroll](/sdk/js/5/core-classes/collection/scroll) request. --- diff --git a/src/sdk/js/5/core-classes/security/constructor/index.md b/src/sdk/js/5/core-classes/security/constructor/index.md index c09092329..e455d5e6d 100644 --- a/src/sdk/js/5/core-classes/security/constructor/index.md +++ b/src/sdk/js/5/core-classes/security/constructor/index.md @@ -10,7 +10,7 @@ order: 1 The Security component lets you handle user permissions in Kuzzle. -Please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions) for more information. +Please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions) for more information. --- @@ -18,7 +18,7 @@ Please refer to our [permissions guide](/core/1/guide/guides/essentials/security | Arguments | Type | Description | | --------- | ------ | ------------------------------------------------- | -| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/js/5/kuzzle) object | +| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/js/5/core-classes/kuzzle) object | ## Usage diff --git a/src/sdk/js/5/core-classes/security/create-profile/index.md b/src/sdk/js/5/core-classes/security/create-profile/index.md index 45d59b85f..633db2ed5 100644 --- a/src/sdk/js/5/core-classes/security/create-profile/index.md +++ b/src/sdk/js/5/core-classes/security/create-profile/index.md @@ -39,7 +39,7 @@ That means that a profile that was just created might not be returned by the @@ -39,7 +39,7 @@ That means that a user that was just created may not be returned by the se ## Callback response -Resolves to a [User](/sdk/js/5/user) object. +Resolves to a [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/create-role/index.md b/src/sdk/js/5/core-classes/security/create-role/index.md index 441639d68..676962a94 100644 --- a/src/sdk/js/5/core-classes/security/create-role/index.md +++ b/src/sdk/js/5/core-classes/security/create-role/index.md @@ -38,7 +38,7 @@ That means that a role that was just created may not be returned by the se ## Callback Response -Returns a [Role](/sdk/js/5/role) object. +Returns a [Role](/sdk/js/5/core-classes/role) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/create-user/index.md b/src/sdk/js/5/core-classes/security/create-user/index.md index 361ee151d..afdbb46e8 100644 --- a/src/sdk/js/5/core-classes/security/create-user/index.md +++ b/src/sdk/js/5/core-classes/security/create-user/index.md @@ -20,7 +20,7 @@ That means that a user that was just created may not be returned by the se | Arguments | Type | Description | | ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Unique user identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `id` | string | [Unique user identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `user` | JSON Object | A plain JSON object representing the user (see below) | | `options` | string | (Optional) Optional arguments | | `callback` | function | Callback handling the response | @@ -29,10 +29,10 @@ That means that a user that was just created may not be returned by the se The `user` object to provide must have the following properties: - `content` (JSON object): user global properties - - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guide/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user + - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user - Any other property will be copied as additional global user information - `credentials` (JSON object): a description of how the new user can identify themselves on Kuzzle - - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/essentials/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. + - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/guides/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. - If this object is left empty, the user will be created in Kuzzle but the will not be able to login. --- @@ -47,7 +47,7 @@ The `user` object to provide must have the following properties: ## Callback Response -Returns a [User](/sdk/js/5/user) object. +Returns a [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/fetch-profile/index.md b/src/sdk/js/5/core-classes/security/fetch-profile/index.md index 12d53d7a3..10b4fda6c 100644 --- a/src/sdk/js/5/core-classes/security/fetch-profile/index.md +++ b/src/sdk/js/5/core-classes/security/fetch-profile/index.md @@ -31,7 +31,7 @@ Fetches a single stored profile using its unique ID. ## Callback Response -Returns a security [Profile](/sdk/js/5/profile) object. +Returns a security [Profile](/sdk/js/5/core-classes/profile) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/fetch-role/index.md b/src/sdk/js/5/core-classes/security/fetch-role/index.md index 880162283..20f9f08ba 100644 --- a/src/sdk/js/5/core-classes/security/fetch-role/index.md +++ b/src/sdk/js/5/core-classes/security/fetch-role/index.md @@ -31,7 +31,7 @@ Fetches a single stored role using its unique ID. ## Callback Response -Returns a [Role](/sdk/js/5/role) object. +Returns a [Role](/sdk/js/5/core-classes/role) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/fetch-user/index.md b/src/sdk/js/5/core-classes/security/fetch-user/index.md index 4091c923f..41d59fdba 100644 --- a/src/sdk/js/5/core-classes/security/fetch-user/index.md +++ b/src/sdk/js/5/core-classes/security/fetch-user/index.md @@ -31,7 +31,7 @@ Fetches a single stored user using its unique ID. ## Callback Response -Returns a [User](/sdk/js/5/user) object. +Returns a [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/get-user-rights/index.md b/src/sdk/js/5/core-classes/security/get-user-rights/index.md index f0a4c6397..3c8ad7764 100644 --- a/src/sdk/js/5/core-classes/security/get-user-rights/index.md +++ b/src/sdk/js/5/core-classes/security/get-user-rights/index.md @@ -36,7 +36,7 @@ Given a Kuzzle user id (`kuid`), retrieves the list of permissions granted to th | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------------------------------------------------------------------- | -| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `options` | JSON Object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/js/5/core-classes/security/is-action-allowed/index.md b/src/sdk/js/5/core-classes/security/is-action-allowed/index.md index 9cbdc76fd..4ba17d903 100644 --- a/src/sdk/js/5/core-classes/security/is-action-allowed/index.md +++ b/src/sdk/js/5/core-classes/security/is-action-allowed/index.md @@ -16,7 +16,7 @@ Specifies if an action is allowed, denied or conditional based on the rights pro An action is defined as a pair of action and controller (mandatory), plus an index and a collection(optional).
-You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`. +You can get the rights from Kuzzle by using `Security.getUserRights` and `Kuzzle.getMyRights`.
--- diff --git a/src/sdk/js/5/core-classes/security/profile/index.md b/src/sdk/js/5/core-classes/security/profile/index.md index 1af86fac9..cdf331731 100644 --- a/src/sdk/js/5/core-classes/security/profile/index.md +++ b/src/sdk/js/5/core-classes/security/profile/index.md @@ -7,7 +7,7 @@ description: Security:profile # profile -Instantiate a new security [Profile](/sdk/js/5/profile) object. +Instantiate a new security [Profile](/sdk/js/5/core-classes/profile) object. --- @@ -22,7 +22,7 @@ Instantiate a new security [Profile](/sdk/js/5/profile) object. ## Return Value -Returns the new security [Profile](/sdk/js/5/profile) object. +Returns the new security [Profile](/sdk/js/5/core-classes/profile) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/replace-user/index.md b/src/sdk/js/5/core-classes/security/replace-user/index.md index 7d038fcbb..acc6a38dc 100644 --- a/src/sdk/js/5/core-classes/security/replace-user/index.md +++ b/src/sdk/js/5/core-classes/security/replace-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns a [User](/sdk/js/5/user) object. +Returns a [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/role/index.md b/src/sdk/js/5/core-classes/security/role/index.md index 45a1b87ea..2f4f08715 100644 --- a/src/sdk/js/5/core-classes/security/role/index.md +++ b/src/sdk/js/5/core-classes/security/role/index.md @@ -7,7 +7,7 @@ description: Security:role # role -Instantiate a new [Role](/sdk/js/5/role) object. +Instantiate a new [Role](/sdk/js/5/core-classes/role) object. --- @@ -22,7 +22,7 @@ Instantiate a new [Role](/sdk/js/5/role) object. ## Return Value -Returns the new [Role](/sdk/js/5/role) object. +Returns the new [Role](/sdk/js/5/core-classes/role) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/search-users/index.md b/src/sdk/js/5/core-classes/security/search-users/index.md index 94a7ab611..baad9bad8 100644 --- a/src/sdk/js/5/core-classes/security/search-users/index.md +++ b/src/sdk/js/5/core-classes/security/search-users/index.md @@ -31,7 +31,7 @@ Return users matching the given filter. | `size` | number |  Number of hits to return per result page | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- diff --git a/src/sdk/js/5/core-classes/security/update-profile/index.md b/src/sdk/js/5/core-classes/security/update-profile/index.md index de1f5a29e..81591ce56 100644 --- a/src/sdk/js/5/core-classes/security/update-profile/index.md +++ b/src/sdk/js/5/core-classes/security/update-profile/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Return an updated [Profile](/sdk/js/5/profile) object. +Return an updated [Profile](/sdk/js/5/core-classes/profile) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/update-role/index.md b/src/sdk/js/5/core-classes/security/update-role/index.md index 35f0e9f63..db58fb15e 100644 --- a/src/sdk/js/5/core-classes/security/update-role/index.md +++ b/src/sdk/js/5/core-classes/security/update-role/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [Role](/sdk/js/5/role) object. +Returns an updated [Role](/sdk/js/5/core-classes/role) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/update-user/index.md b/src/sdk/js/5/core-classes/security/update-user/index.md index e11b37093..87f691dbb 100644 --- a/src/sdk/js/5/core-classes/security/update-user/index.md +++ b/src/sdk/js/5/core-classes/security/update-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [User](/sdk/js/5/user) object. +Returns an updated [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/security/user/index.md b/src/sdk/js/5/core-classes/security/user/index.md index c0b642dcc..b11e78b08 100644 --- a/src/sdk/js/5/core-classes/security/user/index.md +++ b/src/sdk/js/5/core-classes/security/user/index.md @@ -7,7 +7,7 @@ description: Security:user # user -Instantiates a new [User](/sdk/js/5/user) object. +Instantiates a new [User](/sdk/js/5/core-classes/user) object. --- @@ -22,7 +22,7 @@ Instantiates a new [User](/sdk/js/5/user) object. ## Return value -Returns the new [User](/sdk/js/5/user) object. +Returns the new [User](/sdk/js/5/core-classes/user) object. ## Usage diff --git a/src/sdk/js/5/core-classes/user/add-profile/index.md b/src/sdk/js/5/core-classes/user/add-profile/index.md index 005c147d7..27d5d28d8 100644 --- a/src/sdk/js/5/core-classes/user/add-profile/index.md +++ b/src/sdk/js/5/core-classes/user/add-profile/index.md @@ -10,7 +10,7 @@ description: User:addProfile Replaces the security profile associated with the user.
-Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called
--- @@ -27,7 +27,7 @@ Updating a user will have no impact until the -Updating a user will have no impact until the create or replace method is called +Updating a user will have no impact until the create or replace method is called --- diff --git a/src/sdk/js/5/core-classes/user/set-credentials/index.md b/src/sdk/js/5/core-classes/user/set-credentials/index.md index be18109b6..c3a5ccf95 100644 --- a/src/sdk/js/5/core-classes/user/set-credentials/index.md +++ b/src/sdk/js/5/core-classes/user/set-credentials/index.md @@ -10,7 +10,7 @@ description: User:setCredentials Sets the user's credentials.
- Updating user credentials will have no impact until the create method is called.
+ Updating user credentials will have no impact until the create method is called.
The credentials to send depend on the authentication plugin and the strategy you want to create credentials for.
--- diff --git a/src/sdk/js/5/core-classes/user/set-profiles/index.md b/src/sdk/js/5/core-classes/user/set-profiles/index.md index 76a646a73..fad58dd12 100644 --- a/src/sdk/js/5/core-classes/user/set-profiles/index.md +++ b/src/sdk/js/5/core-classes/user/set-profiles/index.md @@ -26,7 +26,7 @@ Updating a user will have no impact until the create or repla | Arguments | Type | Description | | ---------- | ------------------------ | ------------------------------------------------------------- | -| `profiles` | array of Profile objects | An array of instantiated [Profile](/sdk/js/5/profile) objects | +| `profiles` | array of Profile objects | An array of instantiated [Profile](/sdk/js/5/core-classes/profile) objects | --- diff --git a/src/sdk/js/5/essentials/events/index.md b/src/sdk/js/5/essentials/events/index.md index 52cbf72f1..9f90667a3 100644 --- a/src/sdk/js/5/essentials/events/index.md +++ b/src/sdk/js/5/essentials/events/index.md @@ -7,7 +7,7 @@ order: 200 # Events -The [Kuzzle instance](/sdk/js/5/kuzzle/) periodically emits named events that provide useful updates about the state of the Kuzzle client. To subscribe to these events, use the [addListener](/sdk/js/5/kuzzle/add-listener) function and specify the event name and the callback function that will be executed when the event is emitted. To unsubscribe to an event, use the [removeListener](/sdk/js/5/kuzzle/remove-listener) function, specifying the name of the event to remove. +The [Kuzzle instance](/sdk/js/5/core-classes/kuzzle/) periodically emits named events that provide useful updates about the state of the Kuzzle client. To subscribe to these events, use the [addListener](/sdk/js/5/core-classes/kuzzle/add-listener) function and specify the event name and the callback function that will be executed when the event is emitted. To unsubscribe to an event, use the [removeListener](/sdk/js/5/core-classes/kuzzle/remove-listener) function, specifying the name of the event to remove. --- diff --git a/src/sdk/js/5/essentials/offline-tools/index.md b/src/sdk/js/5/essentials/offline-tools/index.md index 3fc39b16b..d43066a1e 100644 --- a/src/sdk/js/5/essentials/offline-tools/index.md +++ b/src/sdk/js/5/essentials/offline-tools/index.md @@ -18,13 +18,13 @@ There are two ways to handle a network disconnect: - Automatically reconnect to Kuzzle when possible, and enter _offline mode_ in the meantime. This is the default behavior. - Stop all further communication with Kuzzle and invalidate the current instance and all its children. The application will have to manually reconnect once the network is available. To do so, simply set the `autoReconnect` option to `false` when creating the SDK instance. -_Offline mode_ refers to the time between a `disconnected` and a `reconnected` event (see [Events](/sdk/js/5/events)). +_Offline mode_ refers to the time between a `disconnected` and a `reconnected` event (see [Events](/sdk/js/5/essentials/events)). --- ## Subscriptions -A subscription opens a permanent pipe between the client and Kuzzle. Whenever a real-time message or a modified document matches a subscription filter, a notification is sent by Kuzzle to the client (for instance, see the [Collection.subscribe](/sdk/js/5/collection/subscribe) method). +A subscription opens a permanent pipe between the client and Kuzzle. Whenever a real-time message or a modified document matches a subscription filter, a notification is sent by Kuzzle to the client (for instance, see the [Collection.subscribe](/sdk/js/5/core-classes/collection/subscribe) method). While in offline mode, the Kuzzle SDK client maintains all subscriptions configurations and, by default, when Kuzzle SDK client reconnects, all subscriptions are renewed. This behavior can be changed by setting the `autoResubscribe` to `false`, in which case, each subscription will have to be renewed manually using the `Room.renew` method. @@ -35,8 +35,8 @@ While in offline mode, the Kuzzle SDK client maintains all subscriptions configu While in offline mode, API requests can be queued, and then executed once the network connection has been reestablished. By default, there is no request queuing. -- Queue all requests automatically when going offline by setting the `autoQueue` option to `true` (see [Kuzzle SDK constructor](/sdk/js/5/kuzzle)) -- Start and stop queuing manually, by using the [startQueuing](/sdk/js/5/kuzzle/start-queuing) and [stopQueuing](/sdk/js/5/kuzzle/stop-queuing) methods +- Queue all requests automatically when going offline by setting the `autoQueue` option to `true` (see [Kuzzle SDK constructor](/sdk/js/5/core-classes/kuzzle)) +- Start and stop queuing manually, by using the [startQueuing](/sdk/js/5/core-classes/kuzzle/start-queuing) and [stopQueuing](/sdk/js/5/core-classes/kuzzle/stop-queuing) methods The queue itself can be configured using the `queueTTL` and `queueMaxSize` options. @@ -46,7 +46,7 @@ The queue itself can be configured using the `queueTTL` and `queueMaxSize` optio By default, when queuing is first activated, all requests are queued. -However, you can choose to omit certain request by using the [`queueFilter`](/sdk/js/5/kuzzle#properties) property. This property can be set to a function that accepts the request as an input value and returns a boolean result which indicates whether or not the request should be queud. +However, you can choose to omit certain request by using the [`queueFilter`](/sdk/js/5/core-classes/kuzzle#properties) property. This property can be set to a function that accepts the request as an input value and returns a boolean result which indicates whether or not the request should be queud. Additionally, almost all request methods accept a `queuable` option, which when set to `false`, will cause the request to be discarded if the Kuzzle SDK is disconnected. This option overrides the `queueFilter` property. @@ -70,7 +70,7 @@ Any request made while the client is processing the queue will be delayed until ## Taking Control of the Offline Queue -You can be notified about what's going on in the offline queue, by using the [`offlineQueuePush`](/sdk/js/5/events) and the [`offlineQueuePop`](/sdk/js/5/events) events. +You can be notified about what's going on in the offline queue, by using the [`offlineQueuePush`](/sdk/js/5/essentials/events) and the [`offlineQueuePop`](/sdk/js/5/essentials/events) events. The `offlineQueuePush` event is fired whenever a request is queued. It will emit an object containing a `query` property, describing the queued request, and an optional `cb` property containing the corresponding callback, if any. @@ -88,7 +88,7 @@ Finally, if the provided methods don't give you enough control over the offline ## Automatic Offline-Mode -You can set the `offlineMode` option to `auto` when instantiating the [Kuzzle SDK instance](/sdk/js/5/kuzzle). This sets the offline mode configuration to the following presets: +You can set the `offlineMode` option to `auto` when instantiating the [Kuzzle SDK instance](/sdk/js/5/core-classes/kuzzle). This sets the offline mode configuration to the following presets: - `autoReconnect` = `true` - `autoQueue` = `true` diff --git a/src/sdk/js/5/essentials/realtime-notifications/index.md b/src/sdk/js/5/essentials/realtime-notifications/index.md index 678d3b4b9..88c80c90f 100644 --- a/src/sdk/js/5/essentials/realtime-notifications/index.md +++ b/src/sdk/js/5/essentials/realtime-notifications/index.md @@ -7,7 +7,7 @@ order: 300 # Realtime Notifications -With Kuzzle, you don't [subscribe](/sdk/js/5/collection/subscribe) to a room or a topic but, instead, you subscribe to documents. +With Kuzzle, you don't [subscribe](/sdk/js/5/core-classes/collection/subscribe) to a room or a topic but, instead, you subscribe to documents. This means, that when you want to subscribe you must provide a set of filter definitions, using [Koncorde](/core/1/koncorde), that tell Kuzzle what documents should trigger a notification. Then, any time a document matches the defined filters, Kuzzle will send a notification to the subscriber. You can also provide an empty set of filters, which will tell Kuzzle that you want to listen to any change occurring on a collection, emulating the behavior of a traditional topic. @@ -35,7 +35,7 @@ You may subscribe multiple times to the same room, with identical or different s | Notification field | Type | Description | Possible values | | ------------------ | ------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------- | -| `document` | [Document](/sdk/js/5/document/) | Content of the document or real-time message that generated the notification | | +| `document` | [Document](/sdk/js/5/core-classes/document/) | Content of the document or real-time message that generated the notification | | | `scope` | string | Indicates if the document enters or exits the subscription scope | `in`, `out` | | `state` | string | Shows if the document is about to be changed, or if the change is done | `pending`, `done` | | `type` | string | Notification type | `document` | diff --git a/src/sdk/js/6/controllers/auth/get-current-user/index.md b/src/sdk/js/6/controllers/auth/get-current-user/index.md index 74c7d3cf0..43179d1d5 100644 --- a/src/sdk/js/6/controllers/auth/get-current-user/index.md +++ b/src/sdk/js/6/controllers/auth/get-current-user/index.md @@ -31,7 +31,7 @@ Additional query options ## Resolves -A [User](/sdk/js/6/user) representing the current user logged with the SDK. +A [User](/sdk/js/6/core-classes/user) representing the current user logged with the SDK. ## Usage diff --git a/src/sdk/js/6/controllers/auth/login/index.md b/src/sdk/js/6/controllers/auth/login/index.md index 5d92dc8a8..811ec976b 100644 --- a/src/sdk/js/6/controllers/auth/login/index.md +++ b/src/sdk/js/6/controllers/auth/login/index.md @@ -29,7 +29,7 @@ login(strategy, [credentials], [expiresIn]); ### strategy -The name of the [authentication strategy](/core/1/guide/guides/kuzzle-depth/authentication/) used to log the user in. +The name of the [authentication strategy](/core/1/guides/kuzzle-depth/authentication/) used to log the user in. Depending on the chosen authentication strategy, additional credential arguments may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). @@ -38,7 +38,7 @@ Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/str ### expiresIn - The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/). + The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration/). ## Resolves diff --git a/src/sdk/js/6/controllers/auth/refresh-token/index.md b/src/sdk/js/6/controllers/auth/refresh-token/index.md index 77173be9c..165ab64ad 100644 --- a/src/sdk/js/6/controllers/auth/refresh-token/index.md +++ b/src/sdk/js/6/controllers/auth/refresh-token/index.md @@ -13,7 +13,7 @@ Refreshes a valid, non-expired authentication token. If this action is successful, then the [jwt](/sdk/js/6/core-classes/kuzzle/properties) property of this class instance is set to the new authentication token. -All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/core/sdk/js/6/auth/logout) action is called, or the `jwt` property is manually set to another value. +All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/sdk/js/6/controllers/auth/logout) action is called, or the `jwt` property is manually set to another value. ## Arguments @@ -40,7 +40,7 @@ Additional query options ### expiresIn -The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guide/guides/essentials/configuration/). +The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration/). ## Resolves @@ -48,7 +48,7 @@ The `refreshToken` action resolves to a token object with the following properti | Property | Type | Description | |--------------|---------|-------------| -| `_id` | 
string
| User unique identifier ([kuid](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid)) | +| `_id` | 
string
| User unique identifier ([kuid](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid)) | | `expiresAt` | 
number
| Expiration timestamp in Epoch-millis format (UTC) | | `jwt` | 
string
| Authentication token | | `ttl` | 
number
| Time to live of the authentication token, in milliseconds | diff --git a/src/sdk/js/6/controllers/auth/update-self/index.md b/src/sdk/js/6/controllers/auth/update-self/index.md index 0d8c014cf..73635d7f9 100644 --- a/src/sdk/js/6/controllers/auth/update-self/index.md +++ b/src/sdk/js/6/controllers/auth/update-self/index.md @@ -9,7 +9,7 @@ description: Updates the current user object in Kuzzle. Updates the currently logged in user content. -This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/1/api/api-reference/controller-security/update-user/) must be used instead. +This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/1/api/controllers/security/update-user/) must be used instead.
@@ -34,7 +34,7 @@ Additional query options ## Resolves -A [User](/sdk/js/6/user) representing the current user logged with the SDK. +A [User](/sdk/js/6/core-classes/user) representing the current user logged with the SDK. ## Usage diff --git a/src/sdk/js/6/controllers/collection/create/index.md b/src/sdk/js/6/controllers/collection/create/index.md index 811291aaf..8fa8213ab 100644 --- a/src/sdk/js/6/controllers/collection/create/index.md +++ b/src/sdk/js/6/controllers/collection/create/index.md @@ -7,7 +7,7 @@ description: Create a new collection # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided index. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided index. You can also provide an optional data mapping that allow you to exploit the full capabilities of our persistent data storage layer, [ElasticSearch](https://www.elastic.co/products/elasticsearch) (check here the [mapping capabilities of ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/mapping.html)). @@ -48,7 +48,7 @@ const mapping = { }; ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### options diff --git a/src/sdk/js/6/controllers/collection/search-specifications/index.md b/src/sdk/js/6/controllers/collection/search-specifications/index.md index d93f4d349..4d0849789 100644 --- a/src/sdk/js/6/controllers/collection/search-specifications/index.md +++ b/src/sdk/js/6/controllers/collection/search-specifications/index.md @@ -63,7 +63,7 @@ const body = { ## Resolves -Resolve to a [SpecificationsSearchResult](/sdk/js/6/search-result). +Resolve to a [SpecificationsSearchResult](/sdk/js/6/core-classes/search-result). ## Usage diff --git a/src/sdk/js/6/controllers/collection/update-mapping/index.md b/src/sdk/js/6/controllers/collection/update-mapping/index.md index 17d91adcf..89ddd66e9 100644 --- a/src/sdk/js/6/controllers/collection/update-mapping/index.md +++ b/src/sdk/js/6/controllers/collection/update-mapping/index.md @@ -9,9 +9,9 @@ description: Update the collection mapping -You can define the collection [dynamic mapping policy](/core/1/guide/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. +You can define the collection [dynamic mapping policy](/core/1/guides/essentials/database-mappings/#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. -You can define [collection additional metadata](/core/1/guide/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field. +You can define [collection additional metadata](/core/1/guides/essentials/database-mappings/#collection-metadata) within the `_meta` root field.
@@ -47,7 +47,7 @@ const mapping = { }; ``` -More informations about database mappings [here](/core/1/guide/guides/essentials/database-mappings). +More informations about database mappings [here](/core/1/guides/essentials/database-mappings). ### options diff --git a/src/sdk/js/6/controllers/collection/update-specifications/index.md b/src/sdk/js/6/controllers/collection/update-specifications/index.md index 54595e73b..978f78b44 100644 --- a/src/sdk/js/6/controllers/collection/update-specifications/index.md +++ b/src/sdk/js/6/controllers/collection/update-specifications/index.md @@ -30,7 +30,7 @@ updateSpecifications(index, collection, specifications, [options]); An object representing the specifications. -This object must follow the [Specification Structure](/core/1/guide/guides/essentials/data-validation/): +This object must follow the [Specification Structure](/core/1/guides/essentials/data-validation/): ```js { diff --git a/src/sdk/js/6/controllers/collection/validate-specifications/index.md b/src/sdk/js/6/controllers/collection/validate-specifications/index.md index 4c24b5606..a252f8388 100644 --- a/src/sdk/js/6/controllers/collection/validate-specifications/index.md +++ b/src/sdk/js/6/controllers/collection/validate-specifications/index.md @@ -30,7 +30,7 @@ validateSpecifications(index, collection, specifications, [options]); An object representing the specifications. -This object must follow the [Specification Structure](/core/1/guide/datavalidation): +This object must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation): ```js { diff --git a/src/sdk/js/6/controllers/document/search/index.md b/src/sdk/js/6/controllers/document/search/index.md index ed851c5da..2b5b7c505 100644 --- a/src/sdk/js/6/controllers/document/search/index.md +++ b/src/sdk/js/6/controllers/document/search/index.md @@ -54,7 +54,7 @@ An empty body matches all documents in the queried collection. ## Resolves -Resolves to a [SearchResult](/sdk/js/6/search-result) object. +Resolves to a [SearchResult](/sdk/js/6/core-classes/search-result) object. ## Usage diff --git a/src/sdk/js/6/controllers/ms/zrevrangebylex/index.md b/src/sdk/js/6/controllers/ms/zrevrangebylex/index.md index 3ded3eb72..413ac7f97 100644 --- a/src/sdk/js/6/controllers/ms/zrevrangebylex/index.md +++ b/src/sdk/js/6/controllers/ms/zrevrangebylex/index.md @@ -6,7 +6,7 @@ title: zrevrangebylex # zrevrangebylex -Identical to [zrangebylex](/core/1/api/api-reference/controller-memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. +Identical to [zrangebylex](/core/1/api/controllers/memory-storage/zrangebylex/) except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebylex) diff --git a/src/sdk/js/6/controllers/ms/zrevrangebyscore/index.md b/src/sdk/js/6/controllers/ms/zrevrangebyscore/index.md index 28cf60125..cf6d3313a 100644 --- a/src/sdk/js/6/controllers/ms/zrevrangebyscore/index.md +++ b/src/sdk/js/6/controllers/ms/zrevrangebyscore/index.md @@ -6,7 +6,7 @@ title: zrevrangebyscore # zrevrangebyscore -Identical to [zrangebyscore](/core/1/api/api-reference/controller-memory-storage/zrangebyscore/), except that the sorted set is traversed in descending order. +Identical to [zrangebyscore](/core/1/api/controllers/memory-storage/zrangebyscore/), except that the sorted set is traversed in descending order. [[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) diff --git a/src/sdk/js/6/core-classes/kuzzle-event-emitter/introduction/index.md b/src/sdk/js/6/core-classes/kuzzle-event-emitter/introduction/index.md index 288c6c219..7e3981199 100644 --- a/src/sdk/js/6/core-classes/kuzzle-event-emitter/introduction/index.md +++ b/src/sdk/js/6/core-classes/kuzzle-event-emitter/introduction/index.md @@ -12,7 +12,7 @@ A portable implementation of the Node.js `EventEmitter` interface. There are several classes extending `KuzzleEventEmitter` in the SDK: -- [Kuzzle](/sdk/js/6/kuzzle) -- [WebSocket](/sdk/js/6/websocket) -- [Http](/sdk/js/6/http) -- [SocketIO](/sdk/js/6/socketio) +- [Kuzzle](/sdk/js/6/core-classes/kuzzle) +- [WebSocket](/sdk/js/6/protocols/websocket) +- [Http](/sdk/js/6/protocols/http) +- [SocketIO](/sdk/js/6/protocols/socketio) diff --git a/src/sdk/js/6/core-classes/kuzzle-event-emitter/on/index.md b/src/sdk/js/6/core-classes/kuzzle-event-emitter/on/index.md index 828d20535..2d76aa56c 100644 --- a/src/sdk/js/6/core-classes/kuzzle-event-emitter/on/index.md +++ b/src/sdk/js/6/core-classes/kuzzle-event-emitter/on/index.md @@ -7,4 +7,4 @@ description: Alias for addListener # on -Alias for [addListener](/sdk/js/6/core-classes/kuzzle-event-emitteradd-listener/). +Alias for [addListener](https://nodejs.org/api/events.html#events_emitter_addlistener_eventname_listener). diff --git a/src/sdk/js/6/core-classes/kuzzle-event-emitter/once/index.md b/src/sdk/js/6/core-classes/kuzzle-event-emitter/once/index.md index 79f84e55d..ca3e6b4b3 100644 --- a/src/sdk/js/6/core-classes/kuzzle-event-emitter/once/index.md +++ b/src/sdk/js/6/core-classes/kuzzle-event-emitter/once/index.md @@ -7,4 +7,4 @@ description: Alias for addOnceListener # once -Alias for [addOnceListener](/sdk/js/6/core-classes/kuzzle-event-emitteradd-once-listener/). +Alias for [addOnceListener](/sdk/js/6/core-classes/kuzzle-event-emitter/add-once-listener/). diff --git a/src/sdk/js/6/core-classes/kuzzle/add-listener/index.md b/src/sdk/js/6/core-classes/kuzzle/add-listener/index.md index 9c14a22a7..8a833bab1 100644 --- a/src/sdk/js/6/core-classes/kuzzle/add-listener/index.md +++ b/src/sdk/js/6/core-classes/kuzzle/add-listener/index.md @@ -20,7 +20,7 @@ addListener(event, callback); | Argument | Type | Description | | ---------- | ------------------- | ------------------------------------------------------------------------------------------ | -| `event` | 
string
| One of the event described in the [Events](/sdk/js/6/events) section of this documentation | +| `event` | 
string
| One of the event described in the [Events](/sdk/js/6/essentials/events) section of this documentation | | `callback` | 
function
| The function to call every time the event is triggered | ## Return diff --git a/src/sdk/js/6/core-classes/kuzzle/constructor/index.md b/src/sdk/js/6/core-classes/kuzzle/constructor/index.md index 1b23d15c0..abdaa88d1 100644 --- a/src/sdk/js/6/core-classes/kuzzle/constructor/index.md +++ b/src/sdk/js/6/core-classes/kuzzle/constructor/index.md @@ -29,9 +29,9 @@ Kuzzle(protocol, [options]); The protocol used to connect to the Kuzzle instance. It can be one of the following available protocols: -- [WebSocket](/sdk/js/6/websocket) -- [Http](/sdk/js/6/http) -- [SocketIO](/sdk/js/6/socketio) +- [WebSocket](/sdk/js/6/protocols/websocket) +- [Http](/sdk/js/6/protocols/http) +- [SocketIO](/sdk/js/6/protocols/socketio) ### options diff --git a/src/sdk/js/6/core-classes/kuzzle/introduction/index.md b/src/sdk/js/6/core-classes/kuzzle/introduction/index.md index e928cbf1d..eeb4b1549 100644 --- a/src/sdk/js/6/core-classes/kuzzle/introduction/index.md +++ b/src/sdk/js/6/core-classes/kuzzle/introduction/index.md @@ -8,7 +8,7 @@ order: 0 # Kuzzle -Inherits from: [KuzzleEventEmitter](/sdk/js/6/kuzzle-event-emitter). +Inherits from: [KuzzleEventEmitter](/sdk/js/6/core-classes/kuzzle-event-emitter). The Kuzzle class is the main class of the SDK. Once instantiated, it represents a connection to your Kuzzle server. @@ -16,7 +16,7 @@ Once instantiated, it represents a connection to your Kuzzle server. It gives access to the different features of the SDKs: - access to the available controllers -- [SDK events](/sdk/cpp/1/events) handling +- [SDK events](/sdk/cpp/1/essentials/events) handling - resilience to connection loss - network request queue management @@ -26,9 +26,9 @@ Each instance of the class communicates with the Kuzzle server through a class r The following protocols are available in the SDK JS 6: -- [WebSocket](/sdk/js/6/websocket) -- [Http](/sdk/js/6/http) -- [SocketIO](/sdk/js/6/socketio) +- [WebSocket](/sdk/js/6/protocols/websocket) +- [Http](/sdk/js/6/protocols/http) +- [SocketIO](/sdk/js/6/protocols/socketio) ## Volatile data diff --git a/src/sdk/js/6/core-classes/profile/getRoles/index.md b/src/sdk/js/6/core-classes/profile/getRoles/index.md index a091c0a32..b0457e1ba 100644 --- a/src/sdk/js/6/core-classes/profile/getRoles/index.md +++ b/src/sdk/js/6/core-classes/profile/getRoles/index.md @@ -17,7 +17,7 @@ getRoles(); ## Resolve -Resolves to an array of [Role](/sdk/js/6/role). +Resolves to an array of [Role](/sdk/js/6/core-classes/role/). ## Usage diff --git a/src/sdk/js/6/core-classes/profile/introduction/index.md b/src/sdk/js/6/core-classes/profile/introduction/index.md index 247276df1..f4b662c72 100644 --- a/src/sdk/js/6/core-classes/profile/introduction/index.md +++ b/src/sdk/js/6/core-classes/profile/introduction/index.md @@ -10,4 +10,4 @@ order: 0 This class represents a Kuzzle Profile. -Refer to the [Security guide](/core/1/guide/guides/essentials/security/#defining-profiles-default) for more information about profiles. +Refer to the [Security guide](/core/1/guides/essentials/security/#defining-profiles-default) for more information about profiles. diff --git a/src/sdk/js/6/core-classes/role/introduction/index.md b/src/sdk/js/6/core-classes/role/introduction/index.md index 4881d0f4c..52c62ab03 100644 --- a/src/sdk/js/6/core-classes/role/introduction/index.md +++ b/src/sdk/js/6/core-classes/role/introduction/index.md @@ -10,4 +10,4 @@ order: 0 This class represents a Kuzzle Role. -Refer to the [Security guide](/core/1/guide/guides/essentials/security/#defining-roles-default) for more information about roles. \ No newline at end of file +Refer to the [Security guide](/core/1/guides/essentials/security/#defining-roles-default) for more information about roles. \ No newline at end of file diff --git a/src/sdk/js/6/core-classes/search-result/introduction/index.md b/src/sdk/js/6/core-classes/search-result/introduction/index.md index 3f3d14bcf..5690ee10d 100644 --- a/src/sdk/js/6/core-classes/search-result/introduction/index.md +++ b/src/sdk/js/6/core-classes/search-result/introduction/index.md @@ -12,4 +12,4 @@ The class is used to retrieve the subsequent paginated results of a search query The following methods returns a `SearchResult`: - [document:search](/sdk/js/6/controllers/document/search) -- [collection:searchSpecifications](/sdk/js/6/collection/search-specifications) +- [collection:searchSpecifications](/sdk/js/6/controllers/collection/search-specifications) diff --git a/src/sdk/js/6/core-classes/user/getProfiles/index.md b/src/sdk/js/6/core-classes/user/getProfiles/index.md index cb837c20c..87a9895ee 100644 --- a/src/sdk/js/6/core-classes/user/getProfiles/index.md +++ b/src/sdk/js/6/core-classes/user/getProfiles/index.md @@ -17,7 +17,7 @@ getProfiles(); ## Resolve -Resolves to an array of [Profile](/sdk/js/6/profile). +Resolves to an array of [Profile](/sdk/js/6/core-classes/profile). ## Usage diff --git a/src/sdk/js/6/core-classes/user/introduction/index.md b/src/sdk/js/6/core-classes/user/introduction/index.md index bed34b427..5bc9f6142 100644 --- a/src/sdk/js/6/core-classes/user/introduction/index.md +++ b/src/sdk/js/6/core-classes/user/introduction/index.md @@ -10,7 +10,7 @@ order: 0 This class represents a Kuzzle User. -Refer to the [Security guide](/core/1/guide/guides/essentials/security/) for more information about users. +Refer to the [Security guide](/core/1/guides/essentials/security/) for more information about users. The following methods return a `User` object: diff --git a/src/sdk/js/6/core-classes/user/properties/index.md b/src/sdk/js/6/core-classes/user/properties/index.md index 353c817b2..f1995aa86 100644 --- a/src/sdk/js/6/core-classes/user/properties/index.md +++ b/src/sdk/js/6/core-classes/user/properties/index.md @@ -21,4 +21,4 @@ The `content` property is an object containing, alongside custom defined values, | Property | Type | Description | |--- |--- |--- | | `profileIds` | 
string[]
| Profiles IDs for this user | -| `_kuzzle_info` | 
object
| [Kuzzle metadata](/core/1/guide/guides/essentials/document-metadata/) | +| `_kuzzle_info` | 
object
| [Kuzzle metadata](/core/1/guides/essentials/document-metadata/) | diff --git a/src/sdk/js/6/essentials/error-handling/index.md b/src/sdk/js/6/essentials/error-handling/index.md index 7f3e5a713..31249dc23 100644 --- a/src/sdk/js/6/essentials/error-handling/index.md +++ b/src/sdk/js/6/essentials/error-handling/index.md @@ -10,7 +10,7 @@ order: 100 All SDK methods return a promise, that can be rejected with a `KuzzleError` value in case of failure. -[KuzzleError](/sdk/js/6/core-classes/kuzzle-errorintroduction/) objects inherit the standard `Error` object, and add the following properties to it: +[KuzzleError](/sdk/js/6/core-classes/kuzzle-error/introduction/) objects inherit the standard `Error` object, and add the following properties to it: | Property | Type | Description | | -------- | ----------------- | ------------------------------------------------------------------------------------------ | diff --git a/src/sdk/js/6/essentials/events/index.md b/src/sdk/js/6/essentials/events/index.md index 62548d82d..de31b9dda 100644 --- a/src/sdk/js/6/essentials/events/index.md +++ b/src/sdk/js/6/essentials/events/index.md @@ -8,9 +8,9 @@ order: 200 # Events -An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle](/sdk/js/6/kuzzle) SDK object. +An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle](/sdk/js/6/core-classes/kuzzle) SDK object. -The API for interacting with events is described by our [KuzzleEventEmitter](/sdk-reference/js/6/kuzzle-event-emitter) class documentation. +The API for interacting with events is described by our [KuzzleEventEmitter](/sdk/js/6/core-classes/kuzzle-event-emitter) class documentation. **Note:** listeners are called in the order of their insertion. diff --git a/src/sdk/js/6/essentials/extend-sdk/index.md b/src/sdk/js/6/essentials/extend-sdk/index.md index 1b381fe12..e6292a1cc 100644 --- a/src/sdk/js/6/essentials/extend-sdk/index.md +++ b/src/sdk/js/6/essentials/extend-sdk/index.md @@ -10,21 +10,21 @@ order: 410 -It is possible to extend the SDK's API by adding new controllers. +It is possible to extend the SDK's API by adding new controllers. -These controllers correspond to [custom controllers created in a plugin](/plugins/1/essentials/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. +These controllers correspond to [custom controllers created in a plugin](/core/1/plugins/essentials/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. ## Define a custom SDK controller -A custom SDK controller is a class inheriting from the [BaseController](/sdk-reference/js/6/base-controller) class and defining methods matching Kuzzle API actions. +A custom SDK controller is a class inheriting from the [BaseController](/sdk/js/6/core-classes/base-controller) class and defining methods matching Kuzzle API actions. -This base class is exposed alongside the other classes of the SDK module. +This base class is exposed alongside the other classes of the SDK module. -After defining your new controller based on `BaseController`, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/kuzzle/use-controller) method. +After defining your new controller based on `BaseController`, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/core-classes/kuzzle/use-controller) method. ## Constructor -The constructor of a custom SDK controller will be called by passing the SDK instance to it. It must call the parent constructor with this instance of the SDK and its name as defined in the API. +The constructor of a custom SDK controller will be called by passing the SDK instance to it. It must call the parent constructor with this instance of the SDK and its name as defined in the API. For instance, if there is a plugin named `nyc-open-data-plugin`, extending Kuzzle's API with the following controller: @@ -36,7 +36,7 @@ this.controllers = { } ``` -Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/plugins/1/essentials/controllers/#querying-plugins-controllers) documentation): +Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/1/plugins/essentials/controllers/#querying-plugins-controllers) documentation): ```javascript const { BaseController } = require('kuzzle-sdk'); @@ -48,13 +48,13 @@ class TaxiController extends BaseController { } ``` -The controller name will then be injected into the requests sent with the [BaseController.query](/sdk-reference/js/6/base-controller/query) method. +The controller name will then be injected into the requests sent with the [BaseController.query](/sdk/js/6/core-classes/base-controller/query) method. ## Define custom SDK controller actions -Each action of your custom SDK controller is a method of the class. +Each action of your custom SDK controller is a method of the class. -These methods have to use the [BaseController.query](/sdk-reference/js/6/base-controller/query) method to invoke an API action. +These methods have to use the [BaseController.query](/sdk/js/6/core-classes/base-controller/query) method to invoke an API action. Extending the previous example, we now have: @@ -82,13 +82,13 @@ class TaxiController extends BaseController { ## Add a custom SDK controller to the SDK -Once you have defined your custom SDK controller, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/kuzzle/use-controller) method. +Once you have defined your custom SDK controller, you can add it to the SDK with the [Kuzzle.useController](/sdk-reference/js/6/core-classes/kuzzle/use-controller) method. -You can then use the actions of your plugins in the same way as the rest of the Kuzzle API by taking advantage of authentication, offline mode management, etc. +You can then use the actions of your plugins in the same way as the rest of the Kuzzle API by taking advantage of authentication, offline mode management, etc. ```javascript -const +const TaxiController = require('./taxiController'), { Kuzzle, WebSocket } = require('kuzzle-sdk'); diff --git a/src/sdk/js/6/essentials/getting-started/node-js/index.md b/src/sdk/js/6/essentials/getting-started/node-js/index.md index 2ca8dae3c..5ee94efa5 100644 --- a/src/sdk/js/6/essentials/getting-started/node-js/index.md +++ b/src/sdk/js/6/essentials/getting-started/node-js/index.md @@ -8,12 +8,12 @@ order: 100 # Getting Started with Kuzzle and Node.js -This tutorial explains you how to use **Kuzzle** with **Node.js** and the **Javascript SDK**. +This tutorial explains you how to use **Kuzzle** with **Node.js** and the **Javascript SDK**. It will walk you through creating scripts that can **store** documents in Kuzzle and subscribe to **notifications** about document creations. You are going to write an application that **stores** documents in Kuzzle Server and subscribe to **real time notifications** for each created document. -To follow this tutorial, you must have a Kuzzle Server up and running. Follow these instructions if this is not already the case: [Running Kuzzle](/core/1/guide/guides/getting-started/running-kuzzle/). +To follow this tutorial, you must have a Kuzzle Server up and running. Follow these instructions if this is not already the case: [Running Kuzzle](/core/1/guides/getting-started/running-kuzzle/). ## Explore the SDK @@ -35,7 +35,7 @@ npm install kuzzle-sdk If you are performing a clean install you might get some `UNMET PEER DEPENDENCY` warnings, these are safe to ignore as they refer to optional dependencies. -Then, create an `init.js` file and start by adding the code below. +Then, create an `init.js` file and start by adding the code below. This loads the SDK and connects it to a Kuzzle instance using the WebSocket protocol. <<< ./snippets/load-sdk.js @@ -105,7 +105,7 @@ node create.js ```
-You have now successfully stored your first document into Kuzzle. Click here to see how you can use the +You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
@@ -135,7 +135,7 @@ Now in another terminal, launch the `create.js` file from the previous section. node create.js ``` -This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/1/api/essentials/notifications/#documents-changes-messages-default) sent to the `subscribe.js` program. +This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/1/api/essentials/notifications/#documents-changes-messages-default) sent to the `subscribe.js` program. Check the `subscribe.js` terminal: a new message is printed everytime a document is created using the `create.js` code. ```bash @@ -153,4 +153,4 @@ Now that you're more familiar with Kuzzle, dive even deeper to learn how to leve - discover what this SDK has to offer by browsing other sections of this documentation - learn how to use Koncorde to create incredibly fine-grained and blazing-fast subscriptions - learn how to perform a basic authentication -- follow our guide to learn how to manage users, and how to set up fine-grained access control +- follow our guide to learn how to manage users, and how to set up fine-grained access control diff --git a/src/sdk/js/6/essentials/getting-started/raw-web/index.md b/src/sdk/js/6/essentials/getting-started/raw-web/index.md index c7d0c74a5..521b631c9 100644 --- a/src/sdk/js/6/essentials/getting-started/raw-web/index.md +++ b/src/sdk/js/6/essentials/getting-started/raw-web/index.md @@ -9,7 +9,7 @@ description: Getting started with Kuzzle in the browser This tutorial explains how to use **Kuzzle** with the **Javascript SDK** in a **browser**. -To follow this tutorial, you must have a Kuzzle Server up and running (you'll need to know the hostname of the machine running it). If this is not already the case, take a look at [how to run Kuzzle](/core/1/guide/guides/getting-started/running-kuzzle/). +To follow this tutorial, you must have a Kuzzle Server up and running (you'll need to know the hostname of the machine running it). If this is not already the case, take a look at [how to run Kuzzle](/core/1/guides/getting-started/running-kuzzle/). Before proceeding, make sure your system has **Node.js** version 8 or higher (instructions here) installed. @@ -119,7 +119,7 @@ New document successfully created! ```
-You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved. +You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
@@ -163,4 +163,4 @@ Now that you're more familiar with Kuzzle, dive even deeper to learn how to leve - discover what this SDK has to offer by browsing other sections of this documentation - learn how to use Koncorde to create incredibly fine-grained and blazing-fast subscriptions - learn how to perform a basic authentication -- follow our guide to learn how to manage users, and how to set up fine-grained access control +- follow our guide to learn how to manage users, and how to set up fine-grained access control diff --git a/src/sdk/js/6/essentials/getting-started/webpack/index.md b/src/sdk/js/6/essentials/getting-started/webpack/index.md index fefe62f78..4ceef6951 100644 --- a/src/sdk/js/6/essentials/getting-started/webpack/index.md +++ b/src/sdk/js/6/essentials/getting-started/webpack/index.md @@ -12,7 +12,7 @@ We will walk you through creating scripts that can **store** documents in Kuzzle ## Running Kuzzle -Before going through this tutorial, you should have a Kuzzle server running. Please refer to the [Running Kuzzle Tutorial](https://docs.kuzzle.io/core/1/guide/guides/getting-started/running-kuzzle/) if you don't have one yet. +Before going through this tutorial, you should have a Kuzzle server running. Please refer to the [Running Kuzzle Tutorial](https://docs.kuzzle.io/core/1/guides/getting-started/running-kuzzle/) if you don't have one yet. ## Fun with the SDK @@ -173,8 +173,8 @@ New document successfully created!
You have now successfully stored your first document into Kuzzle. Click - here to see how you can use the - Kuzzle Admin Console to browse your collection and + here to see how you can use the + Kuzzle Admin Console to browse your collection and confirm that your document was saved.
@@ -229,5 +229,5 @@ Now that you're more familiar with Kuzzle, dive even deeper to learn how to leve - take a look at the SDK Reference - learn how to use Koncorde to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to implement basic authentication -- follow our guide to learn how to implement manage users and setup fine-grained access control +- follow our guide to learn how to implement basic authentication +- follow our guide to learn how to implement manage users and setup fine-grained access control diff --git a/src/sdk/js/6/protocols/http/introduction/index.md b/src/sdk/js/6/protocols/http/introduction/index.md index a2d7fa900..d31d3768f 100644 --- a/src/sdk/js/6/protocols/http/introduction/index.md +++ b/src/sdk/js/6/protocols/http/introduction/index.md @@ -15,6 +15,6 @@ The Http protocol can be used by an instance of the SDK to communicate with your This protocol does not allow to use the real-time notifications.

- You have to use WebSocket or SocketIO protocol instead. + You have to use WebSocket or SocketIO protocol instead.

diff --git a/src/sdk/js/6/protocols/socketio/introduction/index.md b/src/sdk/js/6/protocols/socketio/introduction/index.md index 180254632..c769fd9c7 100644 --- a/src/sdk/js/6/protocols/socketio/introduction/index.md +++ b/src/sdk/js/6/protocols/socketio/introduction/index.md @@ -13,6 +13,6 @@ This protocol allows you to use all the features of Kuzzle, including [real-time

- The SocketIO protocol is used for websocket compatibility with older browsers. It is preferable to use the WebSocket protocol when possible. + The SocketIO protocol is used for websocket compatibility with older browsers. It is preferable to use the WebSocket protocol when possible.

\ No newline at end of file diff --git a/src/sdk/js/6/protocols/websocket/introduction/index.md b/src/sdk/js/6/protocols/websocket/introduction/index.md index 0790e00a3..1757128cc 100644 --- a/src/sdk/js/6/protocols/websocket/introduction/index.md +++ b/src/sdk/js/6/protocols/websocket/introduction/index.md @@ -8,7 +8,7 @@ order: 0 # WebSocket -Inherits from: [KuzzleEventEmitter](/sdk/js/6/kuzzle-event-emitter) +Inherits from: [KuzzleEventEmitter](/sdk/js/6/core-classes/kuzzle-event-emitter) The WebSocket protocol can be used by an instance of the SDK to communicate with your Kuzzle server. diff --git a/src/sdk/php/3/core-classes/collection/create/index.md b/src/sdk/php/3/core-classes/collection/create/index.md index 994788b74..900993ccf 100644 --- a/src/sdk/php/3/core-classes/collection/create/index.md +++ b/src/sdk/php/3/core-classes/collection/create/index.md @@ -7,7 +7,7 @@ description: Collection:create # create -Creates a new [collection](/core/1/guide/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. +Creates a new [collection](/core/1/guides/essentials/persisted/) in Kuzzle via the persistence engine, in the provided `index`. diff --git a/src/sdk/php/3/core-classes/collection/document/index.md b/src/sdk/php/3/core-classes/collection/document/index.md index 56f0a3cd9..6f77df45f 100644 --- a/src/sdk/php/3/core-classes/collection/document/index.md +++ b/src/sdk/php/3/core-classes/collection/document/index.md @@ -22,7 +22,7 @@ Creates a new [Document](/sdk/php/3/core-classes/document/) object, using its co ## Return Value -Returns the newly created [Document](/sdk/php/3/document) object. +Returns the newly created [Document](/sdk/php/3/core-classes/document) object. ## Usage diff --git a/src/sdk/php/3/core-classes/collection/scroll/index.md b/src/sdk/php/3/core-classes/collection/scroll/index.md index 48d74395d..6d29a86b8 100644 --- a/src/sdk/php/3/core-classes/collection/scroll/index.md +++ b/src/sdk/php/3/core-classes/collection/scroll/index.md @@ -15,7 +15,7 @@ There is a small delay between the time a document is created and its availabili
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- @@ -41,7 +41,7 @@ There is a small delay between the time a document is created and its availabili ## Callback Response -Returns an instantiated [SearchResult](/sdk/php/3/search-result) object. +Returns an instantiated [SearchResult](/sdk/php/3/core-classes/search-result) object. --- diff --git a/src/sdk/php/3/core-classes/collection/search/index.md b/src/sdk/php/3/core-classes/collection/search/index.md index 1ba678b89..2c3c4f54b 100644 --- a/src/sdk/php/3/core-classes/collection/search/index.md +++ b/src/sdk/php/3/core-classes/collection/search/index.md @@ -45,14 +45,14 @@ See [`SearchResult.fetchNext`](/sdk/php/3/core-classes/search-result/fetch-next/ | `size` | number | Provide the maximum number of results of the request (used to paginate results) | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- ## Callback Response -Returns an instance of [SearchResult](/sdk/php/3/search-result). +Returns an instance of [SearchResult](/sdk/php/3/core-classes/search-result). ## Usage diff --git a/src/sdk/php/3/core-classes/kuzzle/collection/index.md b/src/sdk/php/3/core-classes/kuzzle/collection/index.md index ea2a3b5fe..918438fe7 100644 --- a/src/sdk/php/3/core-classes/kuzzle/collection/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/collection/index.md @@ -7,7 +7,7 @@ description: Kuzzle:collection # collection -Instantiates a new [Collection](/sdk/php/3/collection) object. +Instantiates a new [Collection](/sdk/php/3/core-classes/collection) object. --- @@ -26,7 +26,7 @@ The `index` argument takes precedence over the default index. ## Return Value -Returns a [Collection](/sdk/php/3/collection) object. +Returns a [Collection](/sdk/php/3/core-classes/collection) object. ## Usage diff --git a/src/sdk/php/3/core-classes/kuzzle/create-index/index.md b/src/sdk/php/3/core-classes/kuzzle/create-index/index.md index 2b7102a64..eaec98e91 100644 --- a/src/sdk/php/3/core-classes/kuzzle/create-index/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/create-index/index.md @@ -15,7 +15,7 @@ Create a new empty index, with no associated mapping. | Arguments | Type | Description | | ---------- | ----------- | ---------------------------------------------------------------------------------------------------- | -| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/php/3/kuzzle/#properties) | +| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/php/3/core-classes/kuzzle/#properties) | | `options` | JSON object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md b/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md index 19db8b383..bcc606e93 100644 --- a/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/get-auto-refresh/index.md @@ -29,7 +29,7 @@ The `getAutoRefresh` function returns the current `autoRefresh` status for the g | Arguments | Type | Description | | ---------- | ----------- | ---------------------------------------------------------------------------------------------------- | -| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/php/3/kuzzle/#properties) | +| `index` | string | Optional index to query. If no set, defaults to [Kuzzle.defaultIndex](/sdk/php/3/core-classes/kuzzle/#properties) | | `options` | JSON object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md b/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md index 33bbfc0b5..3cd98ab6d 100644 --- a/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/get-my-credentials/index.md @@ -7,7 +7,7 @@ description: Kuzzle:getMyCredentials # getMyCredentials -Get [credential information](/core/1/guide/guides/essentials/user-authentication/#user-credentials) for the current user. +Get [credential information](/core/1/guides/essentials/user-authentication/#user-credentials) for the current user. --- diff --git a/src/sdk/php/3/core-classes/kuzzle/login/index.md b/src/sdk/php/3/core-classes/kuzzle/login/index.md index 214a23d6c..e49633f79 100644 --- a/src/sdk/php/3/core-classes/kuzzle/login/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/login/index.md @@ -15,11 +15,11 @@ This is the case, for instance, with the `local` authentication strategy. If the request succeeds but there is no token, then it means that the chosen strategy is a two-steps authentication method, such as the OAUTH strategy. In that case, the `loginAttempt` event is **not** fired. To complete the login, the `setJwtToken` method must be called either with a token or with an appropriate Kuzzle response. -If the login attempt fails, the `loginAttempt` event is fired with the following response: +If the login attempt fails, the `loginAttempt` event is fired with the following response: `{ success: false, error: 'error message' }`
-This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more. +This method is non-queuable, meaning that during offline mode, it will be discarded and the callback will be called with an error. Learn more.
--- diff --git a/src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md b/src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md index c744affe7..f0fb26277 100644 --- a/src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/memory-storage/index.md @@ -7,4 +7,4 @@ description: Kuzzle:memoryStorage ## memoryStorage -A [MemoryStorage](/sdk/php/3/memory-storage) singleton. +A [MemoryStorage](/sdk/php/3/core-classes/memory-storage) singleton. diff --git a/src/sdk/php/3/core-classes/kuzzle/query/index.md b/src/sdk/php/3/core-classes/kuzzle/query/index.md index 5b5e5f1ce..06b7e8e3c 100644 --- a/src/sdk/php/3/core-classes/kuzzle/query/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/query/index.md @@ -42,7 +42,7 @@ Refer to Kuzzle's API Reference here ## query -## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/api-reference/controller-document/search/)) +## `query` is a JSON object containing arguments specific to the query, such as a `body` property, a JWT hash, a document `_id`, or generic query options (such as `from` or `size` for [search queries](/core/1/api/controllers/document/search/)) ## Options diff --git a/src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md b/src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md index 467997bf0..71a028497 100644 --- a/src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/refresh-index/index.md @@ -8,7 +8,7 @@ description: Kuzzle:refreshIndex # refreshIndex When writing or deleting documents in Kuzzle, the update needs to be indexed before being reflected -in the search index. +in the search index. By default, this operation can take up to 1 second. Given an index, the `refresh` action forces a [`refresh`](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-refresh.html), @@ -29,7 +29,7 @@ on it, making the documents visible to search immediately. | Argument | Type | Description | | ---------- | ----------- | --------------------------------------------------------------------------------------------------------------- | -| `index` | string | _Optional_. The index to refresh. If not set, defaults to [kuzzle.defaultIndex](/sdk/php/3/kuzzle/#properties). | +| `index` | string | _Optional_. The index to refresh. If not set, defaults to [kuzzle.defaultIndex](/sdk/php/3/core-classes/kuzzle/#properties). | | `options` | JSON object | Optional parameters | | `callback` | function | _Optional_. Callback handling the response. | diff --git a/src/sdk/php/3/core-classes/kuzzle/security/index.md b/src/sdk/php/3/core-classes/kuzzle/security/index.md index 519dc24a5..20d65a6f0 100644 --- a/src/sdk/php/3/core-classes/kuzzle/security/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/security/index.md @@ -7,4 +7,4 @@ description: Kuzzle:security # security -A [Security](/sdk/php/3/security) singleton. +A [Security](/sdk/php/3/core-classes/security) singleton. diff --git a/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md b/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md index 52153bcda..5a4d30272 100644 --- a/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/set-auto-refresh/index.md @@ -29,7 +29,7 @@ Given an index, the `setAutoRefresh` function updates its `autoRefresh` status. | Argument | Type | Description | | ------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `index` | string | _Optional_ The index to set the `autoRefresh` for. If not set, defaults to [kuzzle.defaultIndex](/sdk/php/3/kuzzle/#properties). | +| `index` | string | _Optional_ The index to set the `autoRefresh` for. If not set, defaults to [kuzzle.defaultIndex](/sdk/php/3/core-classes/kuzzle/#properties). | | `autoRefresh` | boolean | The value to set for the `autoRefresh` setting. | | `options` | JSON object | Optional parameters | | `callback` | function | _Optional_ Callback handling the response | diff --git a/src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md b/src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md index a7368d428..c850399ee 100644 --- a/src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/start-queuing/index.md @@ -7,7 +7,7 @@ description: Kuzzle:startQueuing # startQueuing -Starts the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/php/3/kuzzle/#properties) option is set to `false`. +Starts the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/php/3/core-classes/kuzzle/#properties) option is set to `false`. --- diff --git a/src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md b/src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md index 52d771a36..dde401169 100644 --- a/src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/stop-queuing/index.md @@ -7,7 +7,7 @@ description: Kuzzle:stopQueuing # stopQueuing -Stops the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/php/3/kuzzle/#properties) option is set to `false`. +Stops the requests queuing. Works only in offline mode, and if the [autoQueue](/sdk/php/3/core-classes/kuzzle/#properties) option is set to `false`. --- diff --git a/src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md b/src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md index 0fc2df782..be6b1b00f 100644 --- a/src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md +++ b/src/sdk/php/3/core-classes/kuzzle/who-am-i/index.md @@ -21,7 +21,7 @@ Returns informations about the user who is currently loggedin. ## Callback Response -Returns an instantiated [User](/sdk/php/3/user) object. +Returns an instantiated [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/memory-storage/constructor/index.md b/src/sdk/php/3/core-classes/memory-storage/constructor/index.md index 661ab4ba5..76c5fab88 100644 --- a/src/sdk/php/3/core-classes/memory-storage/constructor/index.md +++ b/src/sdk/php/3/core-classes/memory-storage/constructor/index.md @@ -17,7 +17,7 @@ It uses Redis internally, and most of its underlying functions are exposed by Ku | Arguments | Type | Description | | --------- | ------ | ------------------------------------------------------ | -| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/php/3/kuzzle) SDK object | +| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/php/3/core-classes/kuzzle) SDK object | ## Usage diff --git a/src/sdk/php/3/core-classes/profile/constructor/index.md b/src/sdk/php/3/core-classes/profile/constructor/index.md index 67f899ce5..05a2def35 100644 --- a/src/sdk/php/3/core-classes/profile/constructor/index.md +++ b/src/sdk/php/3/core-classes/profile/constructor/index.md @@ -8,7 +8,7 @@ order: 1 # Constructors -Instantiates a new `Profile` object, representing a security [profile](/core/1/guide/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/php/3/role) objects. +Instantiates a new `Profile` object, representing a security [profile](/core/1/guides/essentials/security/#users-profiles-and-roles), which is a set of one or many [Role](/sdk/php/3/core-classes/role) objects. --- @@ -16,7 +16,7 @@ Instantiates a new `Profile` object, representing a security [profile](/core/1/g | Arguments | Type | Description | | ---------- | ----------- | ------------------------------------------------------ | -| `Security` | Security | An instantiated [Security](/sdk/php/3/security) object | +| `Security` | Security | An instantiated [Security](/sdk/php/3/core-classes/security) object | | `id` | string | Unique profile identifier | | `content` | JSON Object | Profile content | | `meta` | JSON Object | Profile metadata | diff --git a/src/sdk/php/3/core-classes/role/constructor/index.md b/src/sdk/php/3/core-classes/role/constructor/index.md index bab68d7a6..f687bdacf 100644 --- a/src/sdk/php/3/core-classes/role/constructor/index.md +++ b/src/sdk/php/3/core-classes/role/constructor/index.md @@ -16,7 +16,7 @@ Instantiates a new `Role` object, which defines a set of right policies. | Arguments | Type | Description | | ---------- | ----------- | ------------------------------------------------------ | -| `Security` | Security | An instantiated [Security](/sdk/php/3/security) object | +| `Security` | Security | An instantiated [Security](/sdk/php/3/core-classes/security) object | | `id` | string | Unique role identifier | | `content` | JSON Object | Role content | | `meta` | JSON Object | Role metadata | diff --git a/src/sdk/php/3/core-classes/role/update/index.md b/src/sdk/php/3/core-classes/role/update/index.md index 456f73110..13ce12f67 100644 --- a/src/sdk/php/3/core-classes/role/update/index.md +++ b/src/sdk/php/3/core-classes/role/update/index.md @@ -19,7 +19,7 @@ Updates the role object in Kuzzle.

-To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions). +To get more information about Kuzzle permissions, please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions). --- diff --git a/src/sdk/php/3/core-classes/security/constructor/index.md b/src/sdk/php/3/core-classes/security/constructor/index.md index 516ae007b..90b794bbb 100644 --- a/src/sdk/php/3/core-classes/security/constructor/index.md +++ b/src/sdk/php/3/core-classes/security/constructor/index.md @@ -10,7 +10,7 @@ order: 1 The Security component lets you handle user permissions in Kuzzle. -Please refer to our [permissions guide](/core/1/guide/guides/essentials/security/#user-permissions) for more information. +Please refer to our [permissions guide](/core/1/guides/essentials/security/#user-permissions) for more information. --- @@ -18,7 +18,7 @@ Please refer to our [permissions guide](/core/1/guide/guides/essentials/security | Arguments | Type | Description | | --------- | ------ | -------------------------------------------------- | -| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/php/3/kuzzle) object | +| `Kuzzle` | object | An instantiated [Kuzzle](/sdk/php/3/core-classes/kuzzle) object | ## Usage diff --git a/src/sdk/php/3/core-classes/security/create-profile/index.md b/src/sdk/php/3/core-classes/security/create-profile/index.md index a96e014bf..529ddae51 100644 --- a/src/sdk/php/3/core-classes/security/create-profile/index.md +++ b/src/sdk/php/3/core-classes/security/create-profile/index.md @@ -39,7 +39,7 @@ That means that a profile that was just created might not be returned by the @@ -39,7 +39,7 @@ That means that a user that was just created may not be returned by the se ## Callback response -Resolves to a [User](/sdk/php/3/user) object. +Resolves to a [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/create-role/index.md b/src/sdk/php/3/core-classes/security/create-role/index.md index e4a798c34..bef2e75bf 100644 --- a/src/sdk/php/3/core-classes/security/create-role/index.md +++ b/src/sdk/php/3/core-classes/security/create-role/index.md @@ -38,7 +38,7 @@ That means that a role that was just created may not be returned by the se ## Callback Response -Returns a [Role](/sdk/php/3/role) object. +Returns a [Role](/sdk/php/3/core-classes/role) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/create-user/index.md b/src/sdk/php/3/core-classes/security/create-user/index.md index ca64a0c27..d8653b9ad 100644 --- a/src/sdk/php/3/core-classes/security/create-user/index.md +++ b/src/sdk/php/3/core-classes/security/create-user/index.md @@ -20,7 +20,7 @@ That means that a user that was just created may not be returned by the se | Arguments | Type | Description | | ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Unique user identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `id` | string | [Unique user identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `user` | JSON Object | A plain JSON object representing the user (see below) | | `options` | string | (Optional) Optional arguments | | `callback` | function | Callback handling the response | @@ -29,10 +29,10 @@ That means that a user that was just created may not be returned by the se The `user` object to provide must have the following properties: - `content` (JSON object): user global properties - - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guide/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user + - This object must contain a `profileIds` properties, an array of strings listing the security [profiles](/core/1/guides/essentials/security/#users-profiles-and-roles) to be attached to the new user - Any other property will be copied as additional global user information - `credentials` (JSON object): a description of how the new user can identify themselves on Kuzzle - - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/essentials/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. + - Any number of credentials can be added, each one being an object with name equal to the [authentication strategy](/core/1/plugins/guides/strategies/#exposing-authentication-strategies) used to authenticate the user, and with the login data as content. - If this object is left empty, the user will be created in Kuzzle but the will not be able to login. --- @@ -47,7 +47,7 @@ The `user` object to provide must have the following properties: ## Callback Response -Returns a [User](/sdk/php/3/user) object. +Returns a [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/fetch-profile/index.md b/src/sdk/php/3/core-classes/security/fetch-profile/index.md index 71a5af81f..498dc74a7 100644 --- a/src/sdk/php/3/core-classes/security/fetch-profile/index.md +++ b/src/sdk/php/3/core-classes/security/fetch-profile/index.md @@ -31,7 +31,7 @@ Fetches a single stored profile using its unique ID. ## Callback Response -Returns a security [Profile](/sdk/php/3/profile) object. +Returns a security [Profile](/sdk/php/3/core-classes/profile) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/fetch-role/index.md b/src/sdk/php/3/core-classes/security/fetch-role/index.md index e35a6bfcb..6920d725b 100644 --- a/src/sdk/php/3/core-classes/security/fetch-role/index.md +++ b/src/sdk/php/3/core-classes/security/fetch-role/index.md @@ -31,7 +31,7 @@ Fetches a single stored role using its unique ID. ## Callback Response -Returns a [Role](/sdk/php/3/role) object. +Returns a [Role](/sdk/php/3/core-classes/role) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/fetch-user/index.md b/src/sdk/php/3/core-classes/security/fetch-user/index.md index 26f9a97df..f0f4a8b40 100644 --- a/src/sdk/php/3/core-classes/security/fetch-user/index.md +++ b/src/sdk/php/3/core-classes/security/fetch-user/index.md @@ -31,7 +31,7 @@ Fetches a single stored user using its unique ID. ## Callback Response -Returns a [User](/sdk/php/3/user) object. +Returns a [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/get-user-rights/index.md b/src/sdk/php/3/core-classes/security/get-user-rights/index.md index 7cdc643d1..b7a28c610 100644 --- a/src/sdk/php/3/core-classes/security/get-user-rights/index.md +++ b/src/sdk/php/3/core-classes/security/get-user-rights/index.md @@ -36,7 +36,7 @@ Given a Kuzzle user id (`kuid`), retrieves the list of permissions granted to th | Arguments | Type | Description | | ---------- | ----------- | ----------------------------------------------------------------------------------------------------------------- | -| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guide/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | +| `kuid` | String | [Kuzzle User Unique Identifier](/core/1/guides/essentials/user-authentication/#kuzzle-user-identifier-kuid) | | `options` | JSON Object | Optional parameters | | `callback` | function | Callback handling the response | diff --git a/src/sdk/php/3/core-classes/security/profile/index.md b/src/sdk/php/3/core-classes/security/profile/index.md index 75bfbfb2a..94fc2e8d3 100644 --- a/src/sdk/php/3/core-classes/security/profile/index.md +++ b/src/sdk/php/3/core-classes/security/profile/index.md @@ -7,7 +7,7 @@ description: Security:profile # profile -Instantiate a new security [Profile](/sdk/php/3/profile) object. +Instantiate a new security [Profile](/sdk/php/3/core-classes/profile) object. --- @@ -22,7 +22,7 @@ Instantiate a new security [Profile](/sdk/php/3/profile) object. ## Return Value -Returns the new security [Profile](/sdk/php/3/profile) object. +Returns the new security [Profile](/sdk/php/3/core-classes/profile) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/replace-user/index.md b/src/sdk/php/3/core-classes/security/replace-user/index.md index 13cd66f25..31fd64786 100644 --- a/src/sdk/php/3/core-classes/security/replace-user/index.md +++ b/src/sdk/php/3/core-classes/security/replace-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns a [User](/sdk/php/3/user) object. +Returns a [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/role/index.md b/src/sdk/php/3/core-classes/security/role/index.md index b27c810f4..1dffd8b2f 100644 --- a/src/sdk/php/3/core-classes/security/role/index.md +++ b/src/sdk/php/3/core-classes/security/role/index.md @@ -7,7 +7,7 @@ description: Security:role # role -Instantiate a new [Role](/sdk/php/3/role) object. +Instantiate a new [Role](/sdk/php/3/core-classes/role) object. --- @@ -22,7 +22,7 @@ Instantiate a new [Role](/sdk/php/3/role) object. ## Return Value -Returns the new [Role](/sdk/php/3/role) object. +Returns the new [Role](/sdk/php/3/core-classes/role) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/search-users/index.md b/src/sdk/php/3/core-classes/security/search-users/index.md index 85cee9a38..d159ba5e7 100644 --- a/src/sdk/php/3/core-classes/security/search-users/index.md +++ b/src/sdk/php/3/core-classes/security/search-users/index.md @@ -31,7 +31,7 @@ Return users matching the given filter. | `size` | number |  Number of hits to return per result page | `10` |
- To get more information about scroll sessions, please refer to the API reference documentation. + To get more information about scroll sessions, please refer to the API reference documentation.
--- diff --git a/src/sdk/php/3/core-classes/security/update-profile/index.md b/src/sdk/php/3/core-classes/security/update-profile/index.md index 18f45ad08..9cbf9686d 100644 --- a/src/sdk/php/3/core-classes/security/update-profile/index.md +++ b/src/sdk/php/3/core-classes/security/update-profile/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Return an updated [Profile](/sdk/php/3/profile) object. +Return an updated [Profile](/sdk/php/3/core-classes/profile) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/update-role/index.md b/src/sdk/php/3/core-classes/security/update-role/index.md index 6310bd30b..6c71aee29 100644 --- a/src/sdk/php/3/core-classes/security/update-role/index.md +++ b/src/sdk/php/3/core-classes/security/update-role/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [Role](/sdk/php/3/role) object. +Returns an updated [Role](/sdk/php/3/core-classes/role) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/update-user/index.md b/src/sdk/php/3/core-classes/security/update-user/index.md index 9f3a4bb37..c6c27e973 100644 --- a/src/sdk/php/3/core-classes/security/update-user/index.md +++ b/src/sdk/php/3/core-classes/security/update-user/index.md @@ -39,7 +39,7 @@ Returns the `Security` object to allow chaining. ## Callback Response -Returns an updated [User](/sdk/php/3/user) object. +Returns an updated [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/security/user/index.md b/src/sdk/php/3/core-classes/security/user/index.md index f3464f2c9..4e3903707 100644 --- a/src/sdk/php/3/core-classes/security/user/index.md +++ b/src/sdk/php/3/core-classes/security/user/index.md @@ -7,7 +7,7 @@ description: Security:user # user -Instantiates a new [User](/sdk/php/3/user) object. +Instantiates a new [User](/sdk/php/3/core-classes/user) object. --- @@ -22,7 +22,7 @@ Instantiates a new [User](/sdk/php/3/user) object. ## Return value -Returns the new [User](/sdk/php/3/user) object. +Returns the new [User](/sdk/php/3/core-classes/user) object. ## Usage diff --git a/src/sdk/php/3/core-classes/user/add-profile/index.md b/src/sdk/php/3/core-classes/user/add-profile/index.md index 511a55a26..b52605f26 100644 --- a/src/sdk/php/3/core-classes/user/add-profile/index.md +++ b/src/sdk/php/3/core-classes/user/add-profile/index.md @@ -27,7 +27,7 @@ Updating a user will have no impact until the Using Permission Closures, you can add functions directly into role definitions \ No newline at end of file diff --git a/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md b/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md index b80db44eb..a3255524c 100644 --- a/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md +++ b/src/core/1/guides/kuzzle-depth/request-life-cycle/index.md @@ -10,9 +10,9 @@ In this section we are going to focus on how requests are processed by Kuzzle. W Kuzzle has two main modes of communication: -- **Synchronous**: Clients send requests to the Kuzzle server, which processes the data using the [Document Controller](/core/1/api/controller-document) and then sends a response back to the client. +- **Synchronous**: Clients send requests to the Kuzzle server, which processes the data using the [Document Controller](/core/1/api/controllers/document) and then sends a response back to the client. -- **Asynchronous**: Clients subscribe to the Kuzzle server via the [Real-time/Subscribe](/core/1/api/controllers/realtime/publish/) API action and receive data asynchronously as a result of a [Real-time/Publish](/core/1/api/controllers/realtime/publish/) API action or a [Document Controller](/core/1/api/controller-document) event. +- **Asynchronous**: Clients subscribe to the Kuzzle server via the [Real-time/Subscribe](/core/1/api/controllers/realtime/publish/) API action and receive data asynchronously as a result of a [Real-time/Publish](/core/1/api/controllers/realtime/publish/) API action or a [Document Controller](/core/1/api/controllers/document) event. These modes of communication are generally independant from the transport protocol. For example, a synchronous request can be made via HTTP or Websockets. diff --git a/src/core/1/guides/kuzzle-depth/roles-definitions/index.md b/src/core/1/guides/kuzzle-depth/roles-definitions/index.md index 03a7e4850..4b8314eca 100644 --- a/src/core/1/guides/kuzzle-depth/roles-definitions/index.md +++ b/src/core/1/guides/kuzzle-depth/roles-definitions/index.md @@ -249,4 +249,4 @@ args.myDocuments = [ The content of `action.search` is passed directly to Elasticsearch. -Please refer to our [Elasticsearch Cookbook](/core/1/guide/cookbooks/elasticsearch/) for more help on how to build your search query. +Please refer to our [Elasticsearch Cookbook](/core/1/guides/cookbooks/elasticsearch/) for more help on how to build your search query. diff --git a/src/core/1/plugins/plugin-context/constructors/repository/index.md b/src/core/1/plugins/plugin-context/constructors/repository/index.md index de7c5eeea..7122a868e 100644 --- a/src/core/1/plugins/plugin-context/constructors/repository/index.md +++ b/src/core/1/plugins/plugin-context/constructors/repository/index.md @@ -346,7 +346,7 @@ search(query, [options]); | Arguments | Type | Description | | --------- | ----------------- | ------------------------------------------------------------------------------------------------------ | -| `query` | 
object
| Search query, using Elasticsearch [query format](/core/1/guide/cookbooks/elasticsearch/basic-queries/) | +| `query` | 
object
| Search query, using Elasticsearch [query format](/core/1/guides/cookbooks/elasticsearch/basic-queries/) | | `options` | 
object
| Optional arguments | #### options diff --git a/src/sdk/cpp/1/controllers/auth/check-token/index.md b/src/sdk/cpp/1/controllers/auth/check-token/index.md index 84b7a995a..58c2de80b 100644 --- a/src/sdk/cpp/1/controllers/auth/check-token/index.md +++ b/src/sdk/cpp/1/controllers/auth/check-token/index.md @@ -33,7 +33,7 @@ A pointer to a token_validity struct which has: ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/credentials-exist/index.md b/src/sdk/cpp/1/controllers/auth/credentials-exist/index.md index 72d165b86..2f5f354fc 100644 --- a/src/sdk/cpp/1/controllers/auth/credentials-exist/index.md +++ b/src/sdk/cpp/1/controllers/auth/credentials-exist/index.md @@ -38,7 +38,7 @@ A boolean indicating if credentials exists for the strategy. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/delete-my-credentials/index.md b/src/sdk/cpp/1/controllers/auth/delete-my-credentials/index.md index d37b1212f..c646fa052 100644 --- a/src/sdk/cpp/1/controllers/auth/delete-my-credentials/index.md +++ b/src/sdk/cpp/1/controllers/auth/delete-my-credentials/index.md @@ -36,7 +36,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/get-current-user/index.md b/src/sdk/cpp/1/controllers/auth/get-current-user/index.md index 6d8732f86..b2ce27cc5 100644 --- a/src/sdk/cpp/1/controllers/auth/get-current-user/index.md +++ b/src/sdk/cpp/1/controllers/auth/get-current-user/index.md @@ -21,7 +21,7 @@ A [kuzzleio::User](/sdk/cpp/1/core-classes/user/) object. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/get-my-credentials/index.md b/src/sdk/cpp/1/controllers/auth/get-my-credentials/index.md index 1a19a1746..7b6f7ab56 100644 --- a/src/sdk/cpp/1/controllers/auth/get-my-credentials/index.md +++ b/src/sdk/cpp/1/controllers/auth/get-my-credentials/index.md @@ -40,7 +40,7 @@ Returns a JSON string representing the credentials for the provided authenticati ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/get-my-rights/index.md b/src/sdk/cpp/1/controllers/auth/get-my-rights/index.md index 31131cf3e..09e142718 100644 --- a/src/sdk/cpp/1/controllers/auth/get-my-rights/index.md +++ b/src/sdk/cpp/1/controllers/auth/get-my-rights/index.md @@ -38,7 +38,7 @@ A vector of pointer to [kuzzleio::UserRight](/sdk/cpp/1/core-classes/user-right/ ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/get-strategies/index.md b/src/sdk/cpp/1/controllers/auth/get-strategies/index.md index b1c1fb77d..8ff947c96 100644 --- a/src/sdk/cpp/1/controllers/auth/get-strategies/index.md +++ b/src/sdk/cpp/1/controllers/auth/get-strategies/index.md @@ -37,7 +37,7 @@ A vector of string representing the available authentication strategies. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/auth/login/index.md b/src/sdk/cpp/1/controllers/auth/login/index.md index 39ed5cd54..943944159 100644 --- a/src/sdk/cpp/1/controllers/auth/login/index.md +++ b/src/sdk/cpp/1/controllers/auth/login/index.md @@ -37,7 +37,7 @@ The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentica Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example on this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn diff --git a/src/sdk/cpp/1/controllers/auth/update-my-credentials/index.md b/src/sdk/cpp/1/controllers/auth/update-my-credentials/index.md index ce3f128e2..982d0cc78 100644 --- a/src/sdk/cpp/1/controllers/auth/update-my-credentials/index.md +++ b/src/sdk/cpp/1/controllers/auth/update-my-credentials/index.md @@ -40,7 +40,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Return diff --git a/src/sdk/cpp/1/controllers/auth/update-self/index.md b/src/sdk/cpp/1/controllers/auth/update-self/index.md index 5c5d94e5a..d9b48ac16 100644 --- a/src/sdk/cpp/1/controllers/auth/update-self/index.md +++ b/src/sdk/cpp/1/controllers/auth/update-self/index.md @@ -38,7 +38,7 @@ A [kuzzleio::User](/sdk/cpp/1/core-classes/user/) object. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/collection/create/index.md b/src/sdk/cpp/1/controllers/collection/create/index.md index 434ecc347..92ef961d1 100644 --- a/src/sdk/cpp/1/controllers/collection/create/index.md +++ b/src/sdk/cpp/1/controllers/collection/create/index.md @@ -75,7 +75,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/collection/exists/index.md b/src/sdk/cpp/1/controllers/collection/exists/index.md index 2b2c2d549..cb10392d0 100644 --- a/src/sdk/cpp/1/controllers/collection/exists/index.md +++ b/src/sdk/cpp/1/controllers/collection/exists/index.md @@ -42,7 +42,7 @@ A boolean indicating if the collection exists or not. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/collection/search-specifications/index.md b/src/sdk/cpp/1/controllers/collection/search-specifications/index.md index f126453f6..5b6dd08dc 100644 --- a/src/sdk/cpp/1/controllers/collection/search-specifications/index.md +++ b/src/sdk/cpp/1/controllers/collection/search-specifications/index.md @@ -58,7 +58,7 @@ Returns a [kuzzleio::SearchResult](/sdk/cpp/1/search-result). ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/collection/update-specifications/index.md b/src/sdk/cpp/1/controllers/collection/update-specifications/index.md index 205cb56be..0ae6ceccf 100644 --- a/src/sdk/cpp/1/controllers/collection/update-specifications/index.md +++ b/src/sdk/cpp/1/controllers/collection/update-specifications/index.md @@ -39,7 +39,7 @@ std::string updateSpecifications( A JSON string representing the specifications. -The JSON must follow the [Specification Structure](/core/1/guide/cookbooks/datavalidation/schema/): +The JSON must follow the [Specification Structure](/core/1/guides/cookbooks/datavalidation/schema/): ```json { diff --git a/src/sdk/cpp/1/controllers/document/count/index.md b/src/sdk/cpp/1/controllers/document/count/index.md index 1c689df69..3042328cd 100644 --- a/src/sdk/cpp/1/controllers/document/count/index.md +++ b/src/sdk/cpp/1/controllers/document/count/index.md @@ -58,7 +58,7 @@ Returns the number of matched documents. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/create/index.md b/src/sdk/cpp/1/controllers/document/create/index.md index f7e002793..13fbfbdc9 100644 --- a/src/sdk/cpp/1/controllers/document/create/index.md +++ b/src/sdk/cpp/1/controllers/document/create/index.md @@ -62,7 +62,7 @@ A JSON string representing an object containing the document creation result. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/createOrReplace/index.md b/src/sdk/cpp/1/controllers/document/createOrReplace/index.md index a9262d146..0245eaa49 100644 --- a/src/sdk/cpp/1/controllers/document/createOrReplace/index.md +++ b/src/sdk/cpp/1/controllers/document/createOrReplace/index.md @@ -60,7 +60,7 @@ A JSON string representing an object containing the document creation result. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/delete/index.md b/src/sdk/cpp/1/controllers/document/delete/index.md index 5d0761d13..1aa721968 100644 --- a/src/sdk/cpp/1/controllers/document/delete/index.md +++ b/src/sdk/cpp/1/controllers/document/delete/index.md @@ -50,7 +50,7 @@ The ID of the deleted document. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/deleteByQuery/index.md b/src/sdk/cpp/1/controllers/document/deleteByQuery/index.md index 3823008d7..a14a50163 100644 --- a/src/sdk/cpp/1/controllers/document/deleteByQuery/index.md +++ b/src/sdk/cpp/1/controllers/document/deleteByQuery/index.md @@ -50,7 +50,7 @@ A vector containing the ids of deleted documents. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/get/index.md b/src/sdk/cpp/1/controllers/document/get/index.md index 5d2dbee1b..089bb4452 100644 --- a/src/sdk/cpp/1/controllers/document/get/index.md +++ b/src/sdk/cpp/1/controllers/document/get/index.md @@ -51,7 +51,7 @@ A JSON string representing the document content. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mCreate/index.md b/src/sdk/cpp/1/controllers/document/mCreate/index.md index 522b5e7e4..931137156 100644 --- a/src/sdk/cpp/1/controllers/document/mCreate/index.md +++ b/src/sdk/cpp/1/controllers/document/mCreate/index.md @@ -50,7 +50,7 @@ A JSON string containing an array representing the created documents. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mCreateOrReplace/index.md b/src/sdk/cpp/1/controllers/document/mCreateOrReplace/index.md index 91568d260..fa8418aad 100644 --- a/src/sdk/cpp/1/controllers/document/mCreateOrReplace/index.md +++ b/src/sdk/cpp/1/controllers/document/mCreateOrReplace/index.md @@ -50,7 +50,7 @@ Returns an JSON string containing the created documents. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mDelete/index.md b/src/sdk/cpp/1/controllers/document/mDelete/index.md index 6554b0ebb..942fb407d 100644 --- a/src/sdk/cpp/1/controllers/document/mDelete/index.md +++ b/src/sdk/cpp/1/controllers/document/mDelete/index.md @@ -52,7 +52,7 @@ A vector containing the deleted documents IDs. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mGet/index.md b/src/sdk/cpp/1/controllers/document/mGet/index.md index 7019bd38e..c73699465 100644 --- a/src/sdk/cpp/1/controllers/document/mGet/index.md +++ b/src/sdk/cpp/1/controllers/document/mGet/index.md @@ -54,7 +54,7 @@ A JSON string representing an array of objects containing the following properti ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mReplace/index.md b/src/sdk/cpp/1/controllers/document/mReplace/index.md index 0420d977e..fd3fb535d 100644 --- a/src/sdk/cpp/1/controllers/document/mReplace/index.md +++ b/src/sdk/cpp/1/controllers/document/mReplace/index.md @@ -55,7 +55,7 @@ A JSON string representing an object containing the following properties: ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/mUpdate/index.md b/src/sdk/cpp/1/controllers/document/mUpdate/index.md index e24893e5f..eab1cec5b 100644 --- a/src/sdk/cpp/1/controllers/document/mUpdate/index.md +++ b/src/sdk/cpp/1/controllers/document/mUpdate/index.md @@ -60,7 +60,7 @@ A JSON string representing an object containing the following properties: ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/replace/index.md b/src/sdk/cpp/1/controllers/document/replace/index.md index dffdaba70..4ec57bf6a 100644 --- a/src/sdk/cpp/1/controllers/document/replace/index.md +++ b/src/sdk/cpp/1/controllers/document/replace/index.md @@ -58,7 +58,7 @@ A JSON string representing an object containing the document creation result. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/search/index.md b/src/sdk/cpp/1/controllers/document/search/index.md index 5396aaf17..2db2fe28a 100644 --- a/src/sdk/cpp/1/controllers/document/search/index.md +++ b/src/sdk/cpp/1/controllers/document/search/index.md @@ -69,7 +69,7 @@ Returns a [kuzzleio::SearchResult](/sdk/cpp/1/search-result) instance. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/update/index.md b/src/sdk/cpp/1/controllers/document/update/index.md index 9714a6fe4..099febec4 100644 --- a/src/sdk/cpp/1/controllers/document/update/index.md +++ b/src/sdk/cpp/1/controllers/document/update/index.md @@ -61,7 +61,7 @@ A JSON string representing an object containing the document creation result. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/document/validate/index.md b/src/sdk/cpp/1/controllers/document/validate/index.md index a0a9ccbe3..930d9b376 100644 --- a/src/sdk/cpp/1/controllers/document/validate/index.md +++ b/src/sdk/cpp/1/controllers/document/validate/index.md @@ -51,7 +51,7 @@ A boolean set to true if the document is valid and false otherwise. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle errors](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/create/index.md b/src/sdk/cpp/1/controllers/index/create/index.md index 0a02bfc50..9c78eb762 100644 --- a/src/sdk/cpp/1/controllers/index/create/index.md +++ b/src/sdk/cpp/1/controllers/index/create/index.md @@ -34,7 +34,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/delete/index.md b/src/sdk/cpp/1/controllers/index/delete/index.md index aa88d8310..4629b82bd 100644 --- a/src/sdk/cpp/1/controllers/index/delete/index.md +++ b/src/sdk/cpp/1/controllers/index/delete/index.md @@ -34,7 +34,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/exists/index.md b/src/sdk/cpp/1/controllers/index/exists/index.md index ec4ad5034..6faf6f41c 100644 --- a/src/sdk/cpp/1/controllers/index/exists/index.md +++ b/src/sdk/cpp/1/controllers/index/exists/index.md @@ -38,7 +38,7 @@ A boolean indicating whether the index exists or not. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/get-auto-refresh/index.md b/src/sdk/cpp/1/controllers/index/get-auto-refresh/index.md index 66c04b3ac..5a9e6bfd0 100644 --- a/src/sdk/cpp/1/controllers/index/get-auto-refresh/index.md +++ b/src/sdk/cpp/1/controllers/index/get-auto-refresh/index.md @@ -48,7 +48,7 @@ A boolean indicating the status of the **autoRefresh** flag. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/list/index.md b/src/sdk/cpp/1/controllers/index/list/index.md index a89ba7450..ac3a8f6a2 100644 --- a/src/sdk/cpp/1/controllers/index/list/index.md +++ b/src/sdk/cpp/1/controllers/index/list/index.md @@ -37,7 +37,7 @@ A vector of string containing the list of indexes present in Kuzzle ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/m-delete/index.md b/src/sdk/cpp/1/controllers/index/m-delete/index.md index 697461521..756bdf712 100644 --- a/src/sdk/cpp/1/controllers/index/m-delete/index.md +++ b/src/sdk/cpp/1/controllers/index/m-delete/index.md @@ -40,7 +40,7 @@ A vector of string containing the list of deleted indexes. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/refresh-internal/index.md b/src/sdk/cpp/1/controllers/index/refresh-internal/index.md index 9b16b2911..c3b315b44 100644 --- a/src/sdk/cpp/1/controllers/index/refresh-internal/index.md +++ b/src/sdk/cpp/1/controllers/index/refresh-internal/index.md @@ -44,7 +44,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/refresh/index.md b/src/sdk/cpp/1/controllers/index/refresh/index.md index 7d1a78556..a794cbe31 100644 --- a/src/sdk/cpp/1/controllers/index/refresh/index.md +++ b/src/sdk/cpp/1/controllers/index/refresh/index.md @@ -42,7 +42,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/index/set-auto-refresh/index.md b/src/sdk/cpp/1/controllers/index/set-auto-refresh/index.md index ad7ebe89e..476a96d82 100644 --- a/src/sdk/cpp/1/controllers/index/set-auto-refresh/index.md +++ b/src/sdk/cpp/1/controllers/index/set-auto-refresh/index.md @@ -48,7 +48,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/realtime/count/index.md b/src/sdk/cpp/1/controllers/realtime/count/index.md index 14946f3d3..11f0d8c52 100644 --- a/src/sdk/cpp/1/controllers/realtime/count/index.md +++ b/src/sdk/cpp/1/controllers/realtime/count/index.md @@ -38,7 +38,7 @@ Returns the number of active connections using the same provided subscription ro ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/realtime/publish/index.md b/src/sdk/cpp/1/controllers/realtime/publish/index.md index fa2445f04..0a5f73e4d 100644 --- a/src/sdk/cpp/1/controllers/realtime/publish/index.md +++ b/src/sdk/cpp/1/controllers/realtime/publish/index.md @@ -48,7 +48,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/realtime/subscribe/index.md b/src/sdk/cpp/1/controllers/realtime/subscribe/index.md index 09699ec4a..77b151808 100644 --- a/src/sdk/cpp/1/controllers/realtime/subscribe/index.md +++ b/src/sdk/cpp/1/controllers/realtime/subscribe/index.md @@ -39,7 +39,7 @@ std::string subscribe( ### listener Listener function that will be called each time a new notifications is received. -The listener will receive a [const kuzzleio::notification_result\*](/sdk/cpp/1/realtime-notifications) as only argument. +The listener will receive a [const kuzzleio::notification_result\*](/sdk/cpp/1/essentials/realtime-notifications) as only argument. ### options @@ -58,7 +58,7 @@ The room ID. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/realtime/unsubscribe/index.md b/src/sdk/cpp/1/controllers/realtime/unsubscribe/index.md index cfa62e822..5f32cc3f6 100644 --- a/src/sdk/cpp/1/controllers/realtime/unsubscribe/index.md +++ b/src/sdk/cpp/1/controllers/realtime/unsubscribe/index.md @@ -34,7 +34,7 @@ Additional query options ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/admin-exists/index.md b/src/sdk/cpp/1/controllers/server/admin-exists/index.md index ce03c12b0..a49271307 100644 --- a/src/sdk/cpp/1/controllers/server/admin-exists/index.md +++ b/src/sdk/cpp/1/controllers/server/admin-exists/index.md @@ -37,7 +37,7 @@ A boolean indicating whether an admin user exists or not. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/get-all-stats/index.md b/src/sdk/cpp/1/controllers/server/get-all-stats/index.md index 9b1d84031..12f38349d 100644 --- a/src/sdk/cpp/1/controllers/server/get-all-stats/index.md +++ b/src/sdk/cpp/1/controllers/server/get-all-stats/index.md @@ -45,7 +45,7 @@ A JSON string representing the internal statistics ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/get-config/index.md b/src/sdk/cpp/1/controllers/server/get-config/index.md index 4d30f9361..b22d18cd1 100644 --- a/src/sdk/cpp/1/controllers/server/get-config/index.md +++ b/src/sdk/cpp/1/controllers/server/get-config/index.md @@ -41,7 +41,7 @@ A JSON string representing current server configuration. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/get-last-stats/index.md b/src/sdk/cpp/1/controllers/server/get-last-stats/index.md index b4000fe23..d756c1a38 100644 --- a/src/sdk/cpp/1/controllers/server/get-last-stats/index.md +++ b/src/sdk/cpp/1/controllers/server/get-last-stats/index.md @@ -45,7 +45,7 @@ A JSON string representing the most recent statistics snapshot. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/get-stats/index.md b/src/sdk/cpp/1/controllers/server/get-stats/index.md index 1de977bc1..ad061da1f 100644 --- a/src/sdk/cpp/1/controllers/server/get-stats/index.md +++ b/src/sdk/cpp/1/controllers/server/get-stats/index.md @@ -47,7 +47,7 @@ A JSON string representing the statistics for the given period of time. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/info/index.md b/src/sdk/cpp/1/controllers/server/info/index.md index d41e6e7fb..a520a83ca 100644 --- a/src/sdk/cpp/1/controllers/server/info/index.md +++ b/src/sdk/cpp/1/controllers/server/info/index.md @@ -37,7 +37,7 @@ A JSON string representing the server information. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/controllers/server/now/index.md b/src/sdk/cpp/1/controllers/server/now/index.md index ee74b7e91..91fd996f0 100644 --- a/src/sdk/cpp/1/controllers/server/now/index.md +++ b/src/sdk/cpp/1/controllers/server/now/index.md @@ -37,7 +37,7 @@ An Epoch-millis timestamp. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/core-classes/kuzzle/connect/index.md b/src/sdk/cpp/1/core-classes/kuzzle/connect/index.md index 62f33a5b1..593066bab 100644 --- a/src/sdk/cpp/1/core-classes/kuzzle/connect/index.md +++ b/src/sdk/cpp/1/core-classes/kuzzle/connect/index.md @@ -7,7 +7,7 @@ description: Connects the SDK to Kuzzle # connect -Connects to Kuzzle using the `Protocol` argument provided in the constructor options. +Connects to Kuzzle using the `Protocol` argument provided in the constructor options. Subsequent call have no effect if the SDK is already connected. ## Signature @@ -18,7 +18,7 @@ void connect(); ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/core-classes/kuzzle/query/index.md b/src/sdk/cpp/1/core-classes/kuzzle/query/index.md index 2bffefca3..e5021522d 100644 --- a/src/sdk/cpp/1/core-classes/kuzzle/query/index.md +++ b/src/sdk/cpp/1/core-classes/kuzzle/query/index.md @@ -67,7 +67,7 @@ The following properties are the most common. ## Exceptions -Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/error-handling). +Throws a `kuzzleio::KuzzleException` if there is an error. See how to [handle error](/sdk/cpp/1/essentials/error-handling). ## Usage diff --git a/src/sdk/cpp/1/essentials/events/index.md b/src/sdk/cpp/1/essentials/events/index.md index 101c6995e..90b428b65 100644 --- a/src/sdk/cpp/1/essentials/events/index.md +++ b/src/sdk/cpp/1/essentials/events/index.md @@ -8,7 +8,7 @@ order: 100 # Events -An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle SDK object](/sdk/cpp/1/kuzzle). +An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle SDK object](/sdk/cpp/1/core-classes/kuzzle). Subscription to these events is possible by specifying callbacks that will be executed when a specific event is issued by the SDK instance. @@ -55,7 +55,7 @@ A JSON string representing an object with the following properties: ## KUZZLE_EVENT_NETWORK_ERROR -Triggered when the SDK has failed to connect to Kuzzle. +Triggered when the SDK has failed to connect to Kuzzle. This event does not trigger the offline mode. **Callback arguments** diff --git a/src/sdk/cpp/1/protocols/websocket/introduction/index.md b/src/sdk/cpp/1/protocols/websocket/introduction/index.md index 91e48e44b..f767bc4de 100644 --- a/src/sdk/cpp/1/protocols/websocket/introduction/index.md +++ b/src/sdk/cpp/1/protocols/websocket/introduction/index.md @@ -8,8 +8,8 @@ order: 0 # WebSocket -The WebSocket protocol can be used by an instance of the SDK to communicate with your Kuzzle server. -This protocol allows you to use all the features of Kuzzle, including [real-time notifications](/sdk/cpp/1/realtime-notifications). +The WebSocket protocol can be used by an instance of the SDK to communicate with your Kuzzle server. +This protocol allows you to use all the features of Kuzzle, including [real-time notifications](/sdk/cpp/1/essentials/realtime-notifications). ## Public class definition diff --git a/src/sdk/go/1/controllers/auth/login/index.md b/src/sdk/go/1/controllers/auth/login/index.md index 161c39684..3671604db 100644 --- a/src/sdk/go/1/controllers/auth/login/index.md +++ b/src/sdk/go/1/controllers/auth/login/index.md @@ -34,7 +34,7 @@ The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentica Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration/). diff --git a/src/sdk/go/1/controllers/realtime/subscribe/index.md b/src/sdk/go/1/controllers/realtime/subscribe/index.md index 8c1796d15..38a3ea6ae 100644 --- a/src/sdk/go/1/controllers/realtime/subscribe/index.md +++ b/src/sdk/go/1/controllers/realtime/subscribe/index.md @@ -33,7 +33,7 @@ func (r *Realtime) Subscribe( ### listener -A channel for [types.NotificationResult](/sdk/go/1/realtime-notifications) objects. +A channel for [types.NotificationResult](/sdk/go/1/essentials/realtime-notifications) objects. The channel will receive an object each time a new notifications is received. ### options diff --git a/src/sdk/go/1/controllers/server/admin-exists/index.md b/src/sdk/go/1/controllers/server/admin-exists/index.md index a2abbd9ae..6de0af5c5 100644 --- a/src/sdk/go/1/controllers/server/admin-exists/index.md +++ b/src/sdk/go/1/controllers/server/admin-exists/index.md @@ -31,7 +31,7 @@ Additional query options ## Return -Returns a `bool` set to `true` if an admin exists and `false` if it does not, or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns a `bool` set to `true` if an admin exists and `false` if it does not, or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/controllers/server/get-all-stats/index.md b/src/sdk/go/1/controllers/server/get-all-stats/index.md index a3973dbee..c3346b9a7 100644 --- a/src/sdk/go/1/controllers/server/get-all-stats/index.md +++ b/src/sdk/go/1/controllers/server/get-all-stats/index.md @@ -39,7 +39,7 @@ Additional query options ## Return -Returns all stored internal statistic snapshots as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns all stored internal statistic snapshots as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/controllers/server/get-config/index.md b/src/sdk/go/1/controllers/server/get-config/index.md index d75cf6fcc..71a935299 100644 --- a/src/sdk/go/1/controllers/server/get-config/index.md +++ b/src/sdk/go/1/controllers/server/get-config/index.md @@ -35,7 +35,7 @@ Additional query options ## Return -Returns server configuration as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns server configuration as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/controllers/server/get-last-stats/index.md b/src/sdk/go/1/controllers/server/get-last-stats/index.md index 55ec56655..f1a825497 100644 --- a/src/sdk/go/1/controllers/server/get-last-stats/index.md +++ b/src/sdk/go/1/controllers/server/get-last-stats/index.md @@ -39,7 +39,7 @@ Additional query options ## Return -Returns the most recent statistics snapshot as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns the most recent statistics snapshot as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Return diff --git a/src/sdk/go/1/controllers/server/get-stats/index.md b/src/sdk/go/1/controllers/server/get-stats/index.md index ddb4ea233..9f998cecc 100644 --- a/src/sdk/go/1/controllers/server/get-stats/index.md +++ b/src/sdk/go/1/controllers/server/get-stats/index.md @@ -45,7 +45,7 @@ Additional query options ## Return -Returns snapshots within the provided timestamp range as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns snapshots within the provided timestamp range as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/controllers/server/info/index.md b/src/sdk/go/1/controllers/server/info/index.md index 53364f8b9..54be0c53a 100644 --- a/src/sdk/go/1/controllers/server/info/index.md +++ b/src/sdk/go/1/controllers/server/info/index.md @@ -31,7 +31,7 @@ Additional query options ## Return -Returns server informations as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns server informations as a `json.RawMessage` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/controllers/server/now/index.md b/src/sdk/go/1/controllers/server/now/index.md index f62afddc5..f1566fa5b 100644 --- a/src/sdk/go/1/controllers/server/now/index.md +++ b/src/sdk/go/1/controllers/server/now/index.md @@ -31,7 +31,7 @@ Additional query options ## Return -Returns current server timestamp as `int64` or a `KuzzleError`. See how to [handle error](/sdk/go/1/error-handling). +Returns current server timestamp as `int64` or a `KuzzleError`. See how to [handle error](/sdk/go/1/essentials/error-handling). ## Usage diff --git a/src/sdk/go/1/core-structs/kuzzle/connect/index.md b/src/sdk/go/1/core-structs/kuzzle/connect/index.md index c626abc52..dac508667 100644 --- a/src/sdk/go/1/core-structs/kuzzle/connect/index.md +++ b/src/sdk/go/1/core-structs/kuzzle/connect/index.md @@ -7,7 +7,7 @@ description: Connects the SDK to Kuzzle # connect -Connects to Kuzzle using the `host` argument provided to the `connection.Connection` (see [Kuzzle constructor](/sdk/go/1/core-structs/kuzzle/constructor/#usage-go)). +Connects to Kuzzle using the `host` argument provided to the `connection.Connection` (see [Kuzzle constructor](/sdk/go/1/core-structs/kuzzle/constructor/#usage-go)). Subsequent call have no effect if the SDK is already connected. ## Signature @@ -18,7 +18,7 @@ Connect() error ## Return -Return a [Kuzzle error](/sdk/go/1/error-handling) if the SDK can not connect to Kuzzle. +Return a [Kuzzle error](/sdk/go/1/essentials/error-handling) if the SDK can not connect to Kuzzle. ## Usage diff --git a/src/sdk/go/1/core-structs/kuzzle/constructor/index.md b/src/sdk/go/1/core-structs/kuzzle/constructor/index.md index 88fdae279..c71277132 100644 --- a/src/sdk/go/1/core-structs/kuzzle/constructor/index.md +++ b/src/sdk/go/1/core-structs/kuzzle/constructor/index.md @@ -94,7 +94,7 @@ For example, you can read the `volatile` property via `getVolatile()` and set it ## Return -A `Kuzzle` struct and an [error struct](/sdk/go/1/error-handling). +A `Kuzzle` struct and an [error struct](/sdk/go/1/essentials/error-handling). The `error` struct is nil if everything was ok. ## Usage diff --git a/src/sdk/go/1/core-structs/kuzzle/disconnect/index.md b/src/sdk/go/1/core-structs/kuzzle/disconnect/index.md index ffea63767..45492720a 100644 --- a/src/sdk/go/1/core-structs/kuzzle/disconnect/index.md +++ b/src/sdk/go/1/core-structs/kuzzle/disconnect/index.md @@ -7,8 +7,8 @@ description: Disconnect the SDK # disconnect -Closes the current connection to Kuzzle. -The SDK is now in `offline` state. +Closes the current connection to Kuzzle. +The SDK is now in `offline` state. A call to `disconnect()` will not trigger a `disconnected` event. This event is only triggered on unexpected disconnection. ## Signature @@ -19,7 +19,7 @@ Disconnect() error ## Return -Return a [Kuzzle error](/sdk/go/1/error-handling) if the connection can't be closed. +Return a [Kuzzle error](/sdk/go/1/essentials/error-handling) if the connection can't be closed. ## Usage diff --git a/src/sdk/java/1/controllers/auth/login/index.md b/src/sdk/java/1/controllers/auth/login/index.md index 0f58c1056..ea2712bde 100644 --- a/src/sdk/java/1/controllers/auth/login/index.md +++ b/src/sdk/java/1/controllers/auth/login/index.md @@ -34,7 +34,7 @@ The name of the authentication [strategy](/core/1/guides/kuzzle-depth/authentica Depending on the chosen authentication `strategy`, additional [credential arguments](/core/1/guides/kuzzle-depth/authentication/#authentication) may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn diff --git a/src/sdk/java/1/essentials/events/index.md b/src/sdk/java/1/essentials/events/index.md index d76d891d8..4b9696714 100644 --- a/src/sdk/java/1/essentials/events/index.md +++ b/src/sdk/java/1/essentials/events/index.md @@ -8,7 +8,7 @@ order: 100 # Events -An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle SDK object](/sdk/java/1/kuzzle). +An event system allows to be notified when the SDK status changes. These events are issued by the [Kuzzle SDK object](/sdk/java/1/core-classes/kuzzle). Subscription to these events is possible by specifying callbacks that will be executed when a specific event is issued by the SDK instance. @@ -55,7 +55,7 @@ A String representing a JSON object containing the following properties: ## networkError -Triggered when the SDK has failed to connect to Kuzzle. +Triggered when the SDK has failed to connect to Kuzzle. This event does not trigger the offline mode. **Callback arguments** diff --git a/src/sdk/js/6/controllers/auth/login/index.md b/src/sdk/js/6/controllers/auth/login/index.md index 811ec976b..1b9aa174a 100644 --- a/src/sdk/js/6/controllers/auth/login/index.md +++ b/src/sdk/js/6/controllers/auth/login/index.md @@ -34,7 +34,7 @@ The name of the [authentication strategy](/core/1/guides/kuzzle-depth/authentica Depending on the chosen authentication strategy, additional credential arguments may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/1/plugins/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/overview/) documentation to get the list of additional arguments to provide. ### expiresIn diff --git a/src/sdk/js/6/essentials/extend-sdk/index.md b/src/sdk/js/6/essentials/extend-sdk/index.md index e6292a1cc..20149bdc9 100644 --- a/src/sdk/js/6/essentials/extend-sdk/index.md +++ b/src/sdk/js/6/essentials/extend-sdk/index.md @@ -12,7 +12,7 @@ order: 410 It is possible to extend the SDK's API by adding new controllers. -These controllers correspond to [custom controllers created in a plugin](/core/1/plugins/essentials/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. +These controllers correspond to [custom controllers created in a plugin](/core/1/plugins/guides/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. ## Define a custom SDK controller @@ -36,7 +36,7 @@ this.controllers = { } ``` -Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/1/plugins/essentials/controllers/#querying-plugins-controllers) documentation): +Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/1/plugins/guides/controllers/#querying-plugins-controllers) documentation): ```javascript const { BaseController } = require('kuzzle-sdk'); diff --git a/src/sdk/js/6/essentials/offline-tools/index.md b/src/sdk/js/6/essentials/offline-tools/index.md index 8ca7bbf0e..a77c60213 100644 --- a/src/sdk/js/6/essentials/offline-tools/index.md +++ b/src/sdk/js/6/essentials/offline-tools/index.md @@ -13,9 +13,9 @@ during its lifespan. ## Contructor options and properties -These properties can be set in the `options` object when [instantiating a new SDK](/core/1/sdk/js/6/core-classes/kuzzle/constructor/#arguments). +These properties can be set in the `options` object when [instantiating a new SDK](/sdk/js/6/core-classes/kuzzle/constructor/#arguments). -Some of them are also [writable properties](/core/1/sdk/js/6/core-classes/kuzzle/properties) available after SDK instantiation. +Some of them are also [writable properties](/sdk/js/6/core-classes/kuzzle/properties) available after SDK instantiation. ### autoQueue @@ -77,22 +77,22 @@ Default value: *Depends on the Protocol* ## Methods -### [flushQueue()](/core/1/sdk/js/6/core-classes/kuzzle/flush-queue) +### [flushQueue()](/sdk/js/6/core-classes/kuzzle/flush-queue) Empties the `offlineQueue` without sending the requests to Kuzzle. -### [playQueue()](/core/1/sdk/js/6/core-classes/kuzzle/play-queue) +### [playQueue()](/sdk/js/6/core-classes/kuzzle/play-queue) Sends to Kuzzle all the requests in the `offlineQueue`. Works only if the SDK is not in a `offline` state, and if the `autoReplay` option is set to false. -### [startQueuing()](/core/1/sdk/js/6/core-classes/kuzzle/start-queuing/) +### [startQueuing()](/sdk/js/6/core-classes/kuzzle/start-queuing/) Starts queuing requests when in `offline` state. Requests will be put in the `offlineQueue` array instead of being discarded, until `stopQueuing` is called. Works only in `offline` state when the `autoQueue` option is set to `false`. Call `playQueue` to send to Kuzzle the requests in the queue, once the SDK state passes to `online`. Call `flushQueue` to empty the queue without sending the requests. -### [stopQueuing()](/core/1/sdk/js/6/core-classes/kuzzle/stop-queuing) +### [stopQueuing()](/sdk/js/6/core-classes/kuzzle/stop-queuing) Stop queuing the requests. Requests will no more be put in the `offlineQueue`, they will be discarded. Works only in the `offline` state, and if the `autoQueue` option is set to `false`. From 76cd27f6753d417fd18fbe4f2b7ef5e7eb16c5fc Mon Sep 17 00:00:00 2001 From: Adrien Maret Date: Mon, 3 Jun 2019 11:54:27 +0200 Subject: [PATCH 05/10] Update src/core/1/guides/essentials/installing-console/index.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Sébastien Cottinet --- src/core/1/guides/essentials/installing-console/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core/1/guides/essentials/installing-console/index.md b/src/core/1/guides/essentials/installing-console/index.md index 61ffea1c5..c0ac29ae5 100644 --- a/src/core/1/guides/essentials/installing-console/index.md +++ b/src/core/1/guides/essentials/installing-console/index.md @@ -19,7 +19,7 @@ Having trouble? Get in touch with us on Date: Mon, 3 Jun 2019 11:54:41 +0200 Subject: [PATCH 06/10] Update src/core/1/guides/essentials/installing-console/index.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Sébastien Cottinet --- src/core/1/guides/essentials/installing-console/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core/1/guides/essentials/installing-console/index.md b/src/core/1/guides/essentials/installing-console/index.md index c0ac29ae5..98820d3ff 100644 --- a/src/core/1/guides/essentials/installing-console/index.md +++ b/src/core/1/guides/essentials/installing-console/index.md @@ -21,7 +21,7 @@ Having trouble? Get in touch with us on Date: Mon, 3 Jun 2019 12:01:33 +0200 Subject: [PATCH 07/10] Apply @scottinet comments --- .../{installing-console => admin-console}/index.md | 6 +++--- .../kuzbo-connecting.png | Bin .../kuzbo-firstadmin.png | Bin .../1/guides/essentials/document-metadata/index.md | 2 ++ .../1/guides/essentials/installing-kuzzle/index.md | 4 ++-- src/core/1/guides/essentials/security/index.md | 4 ++-- .../guides/essentials/user-authentication/index.md | 2 +- .../1/guides/getting-started/first-steps/index.md | 2 +- .../guides/getting-started/running-kuzzle/index.md | 2 +- src/sdk/cpp/1/essentials/getting-started/index.md | 2 +- src/sdk/go/1/essentials/getting-started/index.md | 2 +- src/sdk/java/1/essentials/getting-started/index.md | 2 +- .../6/essentials/getting-started/node-js/index.md | 2 +- .../6/essentials/getting-started/raw-web/index.md | 2 +- .../6/essentials/getting-started/webpack/index.md | 2 +- 15 files changed, 18 insertions(+), 16 deletions(-) rename src/core/1/guides/essentials/{installing-console => admin-console}/index.md (78%) rename src/core/1/guides/essentials/{installing-console => admin-console}/kuzbo-connecting.png (100%) rename src/core/1/guides/essentials/{installing-console => admin-console}/kuzbo-firstadmin.png (100%) diff --git a/src/core/1/guides/essentials/installing-console/index.md b/src/core/1/guides/essentials/admin-console/index.md similarity index 78% rename from src/core/1/guides/essentials/installing-console/index.md rename to src/core/1/guides/essentials/admin-console/index.md index 61ffea1c5..b34657443 100644 --- a/src/core/1/guides/essentials/installing-console/index.md +++ b/src/core/1/guides/essentials/admin-console/index.md @@ -11,7 +11,7 @@ The Kuzzle Admin Console is a web application that lets you manage Kuzzle, inclu If you don't want to install Kuzzle Admin Console yourself you can use our publicly hosted Kuzzle Admin Console. Otherwise, grab the source code [here](https://github.com/kuzzleio/kuzzle-admin-console/releases) and install it on your own environment. -In both cases the configuration is the same and you'll be able to select which [Kuzzle](/core/1/guides/essentials/installing-console/#connect-to-kuzzle) installation you want to manage. +In both cases the configuration is the same and you'll be able to select which [Kuzzle](/core/1/guides/essentials/admin-console/#connect-to-kuzzle) installation you want to manage.
Having trouble? Get in touch with us on Gitter! We're happy to help. @@ -19,9 +19,9 @@ Having trouble? Get in touch with us on + Metadata can be viewed in the document's `_meta` field and contains the following properties: diff --git a/src/core/1/guides/essentials/installing-kuzzle/index.md b/src/core/1/guides/essentials/installing-kuzzle/index.md index 77169757b..f5be45547 100644 --- a/src/core/1/guides/essentials/installing-kuzzle/index.md +++ b/src/core/1/guides/essentials/installing-kuzzle/index.md @@ -126,7 +126,7 @@ Associated password is your unique instance ID. You can get it from the EC2 AWS In this section we will perform a manual installation of Kuzzle on a Linux distribution. We choose Linux because all Kuzzle components work natively on it. ::: info -By default, Kuzzle expects all the components to be running on localhost but you can [change](/core/1/guides/essentials/configuration/)'ll be able to select which Kuzzle installation that you want to manage. this behavior. +By default, Kuzzle expects all the components to be running on localhost but you can [change](/core/1/guides/essentials/configuration/)'ll be able to select which Kuzzle installation that you want to manage. this behavior. ::: We will run Kuzzle using [pm2](http://pm2.keymetrics.io/), a process management tool used to monitor Node.js applications. @@ -276,7 +276,7 @@ pm2 "" kuzzlebackend ``` ::: success -Now that Kuzzle is up and running you can [install](/core/1/guides/essentials/installing-console/) the Kuzzle Admin Console. +Now that Kuzzle is up and running you can [install](/core/1/guides/essentials/admin-console/) the Kuzzle Admin Console. ::: ### Troubleshooting diff --git a/src/core/1/guides/essentials/security/index.md b/src/core/1/guides/essentials/security/index.md index 207e82f26..cc7f19e13 100644 --- a/src/core/1/guides/essentials/security/index.md +++ b/src/core/1/guides/essentials/security/index.md @@ -15,7 +15,7 @@ Kuzzle provides a full set of functionalities to configure fine-grained permissi When Kuzzle is first installed there is no administrator account and anonymous users (i.e. unauthenticated users) have administrative privileges. -To secure your Kuzzle installation you will need to create an administrator account by either using the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/#create-an-admin-account) or using the [CLI](/core/1/guides/essentials/cli/#createfirstadmin) tool. +To secure your Kuzzle installation you will need to create an administrator account by either using the [Kuzzle Admin Console](/core/1/guides/essentials/admin-console/#create-an-admin-account) or using the [CLI](/core/1/guides/essentials/cli/#createfirstadmin) tool. Once the administrator account is created, you can remove anonymous access rights and properly secure your installation. You can then use the Kuzzle Admin Console or Kuzzle API to create new users and assign them permissions. @@ -47,7 +47,7 @@ A `profile` is linked to a set of `roles`, and each `role` defines a set of perm ![Users, Profiles and Roles](profiles-roles.png) -All `roles` and `profiles` can be edited in the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/). +All `roles` and `profiles` can be edited in the [Kuzzle Admin Console](/core/1/guides/essentials/admin-console/). --- diff --git a/src/core/1/guides/essentials/user-authentication/index.md b/src/core/1/guides/essentials/user-authentication/index.md index 30aaa0ff5..fed559bce 100644 --- a/src/core/1/guides/essentials/user-authentication/index.md +++ b/src/core/1/guides/essentials/user-authentication/index.md @@ -11,7 +11,7 @@ order: 750 Once we have created security [roles and profiles](/core/1/guides/essentials/security/), we can go on to create the users that will access the Kuzzle. -Users can be created by either using the [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/) or the [API](/core/1/api/controllers/security/create-user/). +Users can be created by either using the [Kuzzle Admin Console](/core/1/guides/essentials/admin-console/) or the [API](/core/1/api/controllers/security/create-user/). When creating a user, you will need to assign them one or more [profiles](/core/1/guides/essentials/security/#defining-profiles). diff --git a/src/core/1/guides/getting-started/first-steps/index.md b/src/core/1/guides/getting-started/first-steps/index.md index e6604b560..754f7e4bf 100644 --- a/src/core/1/guides/getting-started/first-steps/index.md +++ b/src/core/1/guides/getting-started/first-steps/index.md @@ -96,7 +96,7 @@ document created ```
-You have now successfully stored your first document into Kuzzle. Click core/1/guides/essentials/installing-console/">here to see how you can use the +You have now successfully stored your first document into Kuzzle. Click core/1/guides/essentials/admin-console/">here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
diff --git a/src/core/1/guides/getting-started/running-kuzzle/index.md b/src/core/1/guides/getting-started/running-kuzzle/index.md index 787a5213d..cc35d64b8 100644 --- a/src/core/1/guides/getting-started/running-kuzzle/index.md +++ b/src/core/1/guides/getting-started/running-kuzzle/index.md @@ -69,6 +69,6 @@ If you want to run Kuzzle automatically at startup there are a few scripts in `$ Now that Kuzzle is up and running, you can start playing around with it: - install and learn a [Kuzzle SDK](/sdk/) to power-up one of your projects -- install [Kuzzle Admin Console](/core/1/guides/essentials/installing-console/), a handy way to manage data and security in your Kuzzle installation +- install [Kuzzle Admin Console](/core/1/guides/essentials/admin-console/), a handy way to manage data and security in your Kuzzle installation - explore the [Kuzzle API](/core/1/api) documentation - install Kuzzle [without Docker](/core/1/guides/essentials/installing-kuzzle/#manual-installation) diff --git a/src/sdk/cpp/1/essentials/getting-started/index.md b/src/sdk/cpp/1/essentials/getting-started/index.md index 146353055..7215a77fd 100644 --- a/src/sdk/cpp/1/essentials/getting-started/index.md +++ b/src/sdk/cpp/1/essentials/getting-started/index.md @@ -107,7 +107,7 @@ Document created successfuly ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/admin-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: diff --git a/src/sdk/go/1/essentials/getting-started/index.md b/src/sdk/go/1/essentials/getting-started/index.md index 67c08a168..68128890e 100644 --- a/src/sdk/go/1/essentials/getting-started/index.md +++ b/src/sdk/go/1/essentials/getting-started/index.md @@ -75,7 +75,7 @@ New document added to yellow-taxi collection! ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/admin-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: diff --git a/src/sdk/java/1/essentials/getting-started/index.md b/src/sdk/java/1/essentials/getting-started/index.md index 56af93a79..edb1f0585 100644 --- a/src/sdk/java/1/essentials/getting-started/index.md +++ b/src/sdk/java/1/essentials/getting-started/index.md @@ -86,7 +86,7 @@ New document added to yellow-taxi collection! ``` You can perform other actions such as [delete](/sdk/go/1/controllers/document/delete/), -[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/installing-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). +[replace](/sdk/go/1/controllers/document/replace/) or [search](/sdk/go/1/controllers/document/search/) documents. There are also other ways to interact with Kuzzle like our [Admin Console](/core/1/guides/essentials/admin-console/), the [Kuzzle HTTP API](/core/1/api/essentials/connecting-to-kuzzle/) or by using your [own protocol](/core/1/protocols/essentials/getting-started/). Now you know how to: diff --git a/src/sdk/js/6/essentials/getting-started/node-js/index.md b/src/sdk/js/6/essentials/getting-started/node-js/index.md index 5ee94efa5..4ea34c080 100644 --- a/src/sdk/js/6/essentials/getting-started/node-js/index.md +++ b/src/sdk/js/6/essentials/getting-started/node-js/index.md @@ -105,7 +105,7 @@ node create.js ```
-You have now successfully stored your first document into Kuzzle. Click here to see how you can use the +You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
diff --git a/src/sdk/js/6/essentials/getting-started/raw-web/index.md b/src/sdk/js/6/essentials/getting-started/raw-web/index.md index 521b631c9..597368540 100644 --- a/src/sdk/js/6/essentials/getting-started/raw-web/index.md +++ b/src/sdk/js/6/essentials/getting-started/raw-web/index.md @@ -119,7 +119,7 @@ New document successfully created! ```
-You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved. +You have now successfully stored your first document into Kuzzle. Click here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
diff --git a/src/sdk/js/6/essentials/getting-started/webpack/index.md b/src/sdk/js/6/essentials/getting-started/webpack/index.md index 4ceef6951..64ed3eadf 100644 --- a/src/sdk/js/6/essentials/getting-started/webpack/index.md +++ b/src/sdk/js/6/essentials/getting-started/webpack/index.md @@ -173,7 +173,7 @@ New document successfully created!
You have now successfully stored your first document into Kuzzle. Click - here to see how you can use the + here to see how you can use the Kuzzle Admin Console to browse your collection and confirm that your document was saved.
From 1745a9232470666aea1b6763ebe0a6a7ab3a2c54 Mon Sep 17 00:00:00 2001 From: Aschen Date: Mon, 3 Jun 2019 13:13:01 +0200 Subject: [PATCH 08/10] Fix link in menu --- src/.vuepress/theme/Tabs.vue | 20 +++++++++---------- .../essentials/available-plugins/index.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/.vuepress/theme/Tabs.vue b/src/.vuepress/theme/Tabs.vue index 4e5fee908..241cf59a2 100644 --- a/src/.vuepress/theme/Tabs.vue +++ b/src/.vuepress/theme/Tabs.vue @@ -5,20 +5,12 @@