Skip to content

Commit

Permalink
Fix/documentation for account use cases (#195)
Browse files Browse the repository at this point in the history
* fix: api excerpt for "get currently used Identity"

* fix: api excerpt for "get synchronization status with backbone"
  • Loading branch information
britsta authored Mar 5, 2024
1 parent f87dc7d commit 1a254a4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ properties:
- size: n/a
- created_at:
- changed_at:
- api_route_regex:
- api_route_regex: GET /api/v2/Account/IdentityInfo
- published: default
- link: transport/get-currently-used-identity
- redirect_from:
require:
required_by:
api_route_regex: ^GET /api/v2/Account/IdentityInfo$
---

{% include use-cases/use-case-transport-get-currently-used-identity.md %}
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ properties:
- size: n/a
- created_at:
- changed_at:
- api_route_regex: GET /api/v2/Account/getSyncInfo
- api_route_regex: GET /api/v2/Account/SyncInfo
- published: default
- link: transport/get-synchronization-status-with-backbone
- redirect_from:
require:
required_by:
api_route_regex: ^GET /api/v2/Account/getSyncInfo$
api_route_regex: ^GET /api/v2/Account/SyncInfo$
---

{% include use-cases/use-case-transport-get-synchronization-status-with-backbone.md %}
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

{% include properties_list.html %}

This use-case returns metadata about the synchronization status of the current Identity or Device with the Backbone. So far, it returns the timestamp of the last successful synchronization run which is triggered by /use-case-transport-synchronize-updates-of-backbone
This use-case returns metadata about the synchronization status of the current Identity or Device with the Backbone. So far, it returns the timestamp of the last successful synchronization run which is triggered by the [Synchronize updates of Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) use-case.

## On Success

- Returns the metadata of the last sync run
- Returns the metadata of the last sync run.

0 comments on commit 1a254a4

Please sign in to comment.