Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove since 1.0.0 tag #287

Merged
merged 4 commits into from
May 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/check-token/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: checkToken

# checkToken

{{{since "1.0.0"}}}

Checks the validity of an authentication token.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/create-my-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: createMyCredentials

# createMyCredentials

{{{since "1.0.0"}}}

Creates new credentials for the current user.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/credentials-exists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: credentialsExist

# credentialsExist

{{{since "1.0.0"}}}

Checks that the current authenticated user has credentials for the specified authentication strategy.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/delete-my-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: deleteMyCredentials

# deleteMyCredentials

{{{since "1.0.0"}}}

Deletes credentials associated to the current user.

If the credentials that generated the current JWT are removed, the user will remain logged in until they log out or their session expire. After that, they will no longer be able to log in with the deleted credentials.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/get-current-user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getCurrentUser

# getCurrentUser

{{{since "1.0.0"}}}

Returns information about the currently logged in user.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/get-my-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getMyCredentials

# getMyCredentials

{{{since "1.0.0"}}}

Returns credential information for the currently logged in user.

The data returned will depend on the specified authentication strategy, and they should not include any sensitive information.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/get-my-rights/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getMyRights

# getMyRights

{{{since "1.0.0"}}}

Returns the exhaustive list of granted or denied rights for the currently logged in user.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/get-strategies/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getStrategies

# getStrategies

{{{since "1.0.0"}}}

Gets the exhaustive list of registered authentication strategies.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/login/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: login

# login

{{{since "1.0.0"}}}

Authenticates a user.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/logout/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: logout

# logout

{{{since "1.0.0"}}}

Revokes the provided authentication token.

If there were any, real-time subscriptions are cancelled.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/update-my-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: updateMyCredentials

# updateMyCredentials

{{{since "1.0.0"}}}

Updates the credentials of the currently logged in user.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/update-self/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: updateSelf

# updateSelf

{{{since "1.0.0"}}}

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]({{ site_base_path }}api/1/controller-security/update-user) must be used instead.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-auth/validate-my-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: validateMyCredentials

# validateMyCredentials

{{{since "1.0.0"}}}

Validates the provided credentials against a specified authentication strategy.

This route neither creates nor modifies credentials.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-bulk/import/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: import

# import

{{{since "1.0.0"}}}

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]({{ site_base_path }}api/1/controller-document/m-create)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: create

# create

{{{since "1.0.0"}}}

Creates a new [collection]({{ site_base_path }}guide/1/essentials/persisted), in the provided `index`.

{{{since "1.3.0"}}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: deleteSpecifications

# deleteSpecifications

{{{since "1.0.0"}}}

Deletes validation specifications for a collection.

The request succeeds even if no specification exist for that collection.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/exists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: exists

# exists

{{{since "1.0.0"}}}

Checks whether a collection exists.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/get-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getMapping

# getMapping

{{{since "1.0.0"}}}

Returns the collection mapping.

{{{since "1.7.1"}}}
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/get-specifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: getSpecifications

# getSpecifications

{{{since "1.0.0"}}}

Returns the validation specifications associated to the given index and collection.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: list

# list

{{{since "1.0.0"}}}

Returns the list of collections associated to a provided index.

The returned list is sorted in alphanumerical order.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: scrollSpecifications

# scrollSpecifications

{{{since "1.0.0"}}}

Moves a result set cursor forward, created by the [`searchSpecifications` request]({{ site_base_path }}api/1/controller-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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: searchSpecifications

# searchSpecifications

{{{since "1.0.0"}}}

Searches collection specifications.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/truncate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: truncate

# truncate

{{{since "1.0.0"}}}

Empties a collection by removing all its documents, while keeping any associated mapping.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-collection/update-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: updateMapping

# updateMapping

{{{since "1.0.0"}}}

Updates a collection mapping.

{{{since "1.7.1"}}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: updateSpecifications

# updateSpecifications

{{{since "1.0.0"}}}

You can specify validation specifications in order to enforce your own rules over documents and real-time messages.
Whenever a document is stored or updated, or a message is published, Kuzzle applies these specifications to check if the new data complies to the defined rules. If not, the document or message will be rejected and the request will return an error message.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: validateSpecifications

# validateSpecifications

{{{since "1.0.0"}}}

You can specify validation specifications in order to enforce your own rules over documents and real-time messages.
Whenever a document is stored or updated, or a message is published, Kuzzle applies these specifications to check if the new data complies to the defined rules. If not, the document or message will be rejected and the request will return an error message.

Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/count/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: count

# count

{{{since "1.0.0"}}}

Counts documents in a collection.

A query can be provided to alter the count result, otherwise returns the total number of documents in the collection.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/create-or-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: createOrReplace

# createOrReplace

{{{since "1.0.0"}}}

Creates a new document in the persistent data storage, or replaces its content if it already exists.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: create

# create

{{{since "1.0.0"}}}

Creates a new document in the persistent data storage.

Returns an error if the document already exists.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/delete-by-query/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: deleteByQuery

# deleteByQuery

{{{since "1.0.0"}}}

Deletes documents matching the provided search query.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: delete

# delete

{{{since "1.0.0"}}}

Deletes a document.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: get

# get

{{{since "1.0.0"}}}

Gets a document.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-create-or-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mCreateOrReplace

# mCreateOrReplace

{{{since "1.0.0"}}}

Creates or replaces multiple documents.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mCreate

# mCreate

{{{since "1.0.0"}}}

Creates multiple documents.

If a document identifier already exists, the creation fails for that document.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mDelete

# mDelete

{{{since "1.0.0"}}}

Deletes multiple documents.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mGet

# mGet

{{{since "1.0.0"}}}

Gets multiple documents.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mReplace

# mReplace

{{{since "1.0.0"}}}

Replaces multiple documents.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/m-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: mUpdate

# mUpdate

{{{since "1.0.0"}}}

Updates multiple documents.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: replace

# replace

{{{since "1.0.0"}}}

Replaces the content of an existing document.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/scroll/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: scroll

# scroll

{{{since "1.0.0"}}}

Moves a search cursor forward.

A search cursor is created by a [search]({{ site_base_path }}api/1/controller-document/search/) API call, with a `scroll` value provided.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/search/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: search

# search

{{{since "1.0.0"}}}

Searches documents.

There is a limit to how many documents can be returned by a single search query.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: update

# update

{{{since "1.0.0"}}}

Updates a document content.

---
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-document/validate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: validate

# validate

{{{since "1.0.0"}}}

Validates data against existing validation rules.

Documents are always valid if no validation rules are defined on the provided index and collection.
Expand Down
2 changes: 0 additions & 2 deletions src/api/1/controller-index/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: create

# create

{{{since "1.0.0"}}}

Creates a new [index]({{ site_base_path }}guide/1/essentials/persisted) in Kuzzle.

---
Expand Down
Loading