-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #254 from effectivemade/backendApp/feature/updateD…
…ocumentation Backend app/feature/update documentation
- Loading branch information
Showing
249 changed files
with
1,859 additions
and
858 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,15 @@ | ||
POSTGRES_PASSWORD=1234567890test | ||
POSTGRES_DB=effectiveOfficeBackendDB | ||
POSTGRES_USER=postgres | ||
DATABASE_PASSWORD=1234567890test | ||
GOOGLE_CLIENT_ID=random | ||
GOOGLE_CLIENT_SECRET=random | ||
VERIFICATION_PLUGIN_ENABLE=false | ||
DATABASE_HOST=0.0.0.0 | ||
DATABASE_PORT=15432 | ||
DATABASE_NAME=effectiveOfficeBackendDB | ||
DATABASE_USERNAME=postgres | ||
MIGRATIONS_ENABLE=true | ||
DATABASE_PASSWORD=1234567890test | ||
VERIFICATION_PLUGIN_ENABLE=false | ||
MIGRATIONS_ENABLE=false | ||
SERVICE_ACCOUNT_KEY_PATH={your firebase service account credentials json} | ||
JSON_CREDENTIALS={your google calendar service account credentials json} | ||
APPLICATION_URL=https://deployed.app.example.yandexcloud.net | ||
LOG_LEVEL=debug | ||
LOG_LEVEL=trace | ||
DEFAULT_CALENDAR=effective.office@effective.band | ||
WORKSPACE_CALENDAR=c_46707d19c716de0d5d28b52082edfeb03376269e7da5fea78e43fcb15afda57e@group.calendar.google.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 0 additions & 6 deletions
6
...nd/documentation/gfm/com.backend.effectiveoffice/model/-ending/-count/-count.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...end/documentation/gfm/com.backend.effectiveoffice/model/-ending/-count/value.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...end/documentation/gfm/com.backend.effectiveoffice/model/-ending/-empty/index.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...nd/documentation/gfm/com.backend.effectiveoffice/model/-ending/-until/-until.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...end/documentation/gfm/com.backend.effectiveoffice/model/-ending/-until/value.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 0 additions & 12 deletions
12
...mentation/gfm/com.backend.effectiveoffice/model/-recurrence/-companion/index.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...n/gfm/com.backend.effectiveoffice/model/-recurrence/-companion/to-recurrence.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...ckend/documentation/gfm/com.backend.effectiveoffice/model/-recurrence/ending.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...Backend/documentation/gfm/com.backend.effectiveoffice/model/-recurrence/freq.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...end/documentation/gfm/com.backend.effectiveoffice/model/-recurrence/interval.md
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
...ckend/documentation/gfm/com.backend.effectiveoffice/model/-recurrence/to-dto.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...ffective.common.constants/-booking-constants/-d-e-f-a-u-l-t_-c-a-l-e-n-d-a-r.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.constants](../index.md)/[BookingConstants](index.md)/[DEFAULT_CALENDAR](-d-e-f-a-u-l-t_-c-a-l-e-n-d-a-r.md) | ||
|
||
# DEFAULT_CALENDAR | ||
|
||
[jvm]\ | ||
val [DEFAULT_CALENDAR](-d-e-f-a-u-l-t_-c-a-l-e-n-d-a-r.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
6 changes: 6 additions & 0 deletions
6
...ive.common.constants/-booking-constants/-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-i-d.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.constants](../index.md)/[BookingConstants](index.md)/[DEFAULT_TIMEZONE_ID](-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-i-d.md) | ||
|
||
# DEFAULT_TIMEZONE_ID | ||
|
||
[jvm]\ | ||
val [DEFAULT_TIMEZONE_ID](-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
6 changes: 6 additions & 0 deletions
6
...-booking-constants/-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-o-f-f-s-e-t_-m-i-l-l-i-s.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.constants](../index.md)/[BookingConstants](index.md)/[DEFAULT_TIMEZONE_OFFSET_MILLIS](-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-o-f-f-s-e-t_-m-i-l-l-i-s.md) | ||
|
||
# DEFAULT_TIMEZONE_OFFSET_MILLIS | ||
|
||
[jvm]\ | ||
val [DEFAULT_TIMEZONE_OFFSET_MILLIS](-d-e-f-a-u-l-t_-t-i-m-e-z-o-n-e_-o-f-f-s-e-t_-m-i-l-l-i-s.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
6 changes: 6 additions & 0 deletions
6
...ants/-booking-constants/-r-e-g-u-l-a-r_-w-o-r-k-s-p-a-c-e-s_-c-a-l-e-n-d-a-r.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.constants](../index.md)/[BookingConstants](index.md)/[REGULAR_WORKSPACES_CALENDAR](-r-e-g-u-l-a-r_-w-o-r-k-s-p-a-c-e-s_-c-a-l-e-n-d-a-r.md) | ||
|
||
# REGULAR_WORKSPACES_CALENDAR | ||
|
||
[jvm]\ | ||
val [REGULAR_WORKSPACES_CALENDAR](-r-e-g-u-l-a-r_-w-o-r-k-s-p-a-c-e-s_-c-a-l-e-n-d-a-r.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
6 changes: 6 additions & 0 deletions
6
...office.effective.common.constants/-booking-constants/-u-n-t-i-l_-f-o-r-m-a-t.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.constants](../index.md)/[BookingConstants](index.md)/[UNTIL_FORMAT](-u-n-t-i-l_-f-o-r-m-a-t.md) | ||
|
||
# UNTIL_FORMAT | ||
|
||
[jvm]\ | ||
const val [UNTIL_FORMAT](-u-n-t-i-l_-f-o-r-m-a-t.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...s.impl/-database-transaction-manager-impl/-database-transaction-manager-impl.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.utils.impl](../index.md)/[DatabaseTransactionManagerImpl](index.md)/[DatabaseTransactionManagerImpl](-database-transaction-manager-impl.md) | ||
|
||
# DatabaseTransactionManagerImpl | ||
|
||
[jvm]\ | ||
constructor(database: Database) |
20 changes: 20 additions & 0 deletions
20
.../office.effective.common.utils.impl/-database-transaction-manager-impl/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.utils.impl](../index.md)/[DatabaseTransactionManagerImpl](index.md) | ||
|
||
# DatabaseTransactionManagerImpl | ||
|
||
[jvm]\ | ||
class [DatabaseTransactionManagerImpl](index.md)(database: Database) : [DatabaseTransactionManager](../../office.effective.common.utils/-database-transaction-manager/index.md) | ||
|
||
Class used for creation database transaction on the facade layer | ||
|
||
## Constructors | ||
|
||
| | | | ||
|---|---| | ||
| [DatabaseTransactionManagerImpl](-database-transaction-manager-impl.md) | [jvm]<br>constructor(database: Database) | | ||
|
||
## Functions | ||
|
||
| Name | Summary | | ||
|---|---| | ||
| [useTransaction](use-transaction.md) | [jvm]<br>open override fun <[T](use-transaction.md)> [useTransaction](use-transaction.md)(serviceCall: () -> [T](use-transaction.md), isolation: TransactionIsolation): [T](use-transaction.md)<br>Executes code in a database transaction. | |
19 changes: 19 additions & 0 deletions
19
...fective.common.utils.impl/-database-transaction-manager-impl/use-transaction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.common.utils.impl](../index.md)/[DatabaseTransactionManagerImpl](index.md)/[useTransaction](use-transaction.md) | ||
|
||
# useTransaction | ||
|
||
[jvm]\ | ||
open override fun <[T](use-transaction.md)> [useTransaction](use-transaction.md)(serviceCall: () -> [T](use-transaction.md), isolation: TransactionIsolation): [T](use-transaction.md) | ||
|
||
Executes code in a database transaction. | ||
|
||
Rollbacks the transaction if an exception was thrown. | ||
|
||
#### Parameters | ||
|
||
jvm | ||
|
||
| | | | ||
|---|---| | ||
| serviceCall | lambda function to be executed | | ||
| isolation | transaction isolation | |
9 changes: 9 additions & 0 deletions
9
...ion/gfm/com.backend.effectiveoffice/office.effective.common.utils.impl/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
//[com.backend.effectiveoffice](../../index.md)/[office.effective.common.utils.impl](index.md) | ||
|
||
# Package-level declarations | ||
|
||
## Types | ||
|
||
| Name | Summary | | ||
|---|---| | ||
| [DatabaseTransactionManagerImpl](-database-transaction-manager-impl/index.md) | [jvm]<br>class [DatabaseTransactionManagerImpl](-database-transaction-manager-impl/index.md)(database: Database) : [DatabaseTransactionManager](../office.effective.common.utils/-database-transaction-manager/index.md)<br>Class used for creation database transaction on the facade layer | |
6 changes: 0 additions & 6 deletions
6
...ive.common.utils/-database-transaction-manager/-database-transaction-manager.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...iveoffice/office.effective.dto/-booking-request-d-t-o/-booking-request-d-t-o.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.dto](../index.md)/[BookingRequestDTO](index.md)/[BookingRequestDTO](-booking-request-d-t-o.md) | ||
|
||
# BookingRequestDTO | ||
|
||
[jvm]\ | ||
constructor(ownerEmail: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, participantEmails: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, workspaceId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), beginBooking: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), endBooking: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), recurrence: [RecurrenceDTO](../../model/-recurrence-d-t-o/index.md)? = null) |
6 changes: 6 additions & 0 deletions
6
...nd.effectiveoffice/office.effective.dto/-booking-request-d-t-o/begin-booking.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.dto](../index.md)/[BookingRequestDTO](index.md)/[beginBooking](begin-booking.md) | ||
|
||
# beginBooking | ||
|
||
[jvm]\ | ||
val [beginBooking](begin-booking.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
6 changes: 6 additions & 0 deletions
6
...kend.effectiveoffice/office.effective.dto/-booking-request-d-t-o/end-booking.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
//[com.backend.effectiveoffice](../../../index.md)/[office.effective.dto](../index.md)/[BookingRequestDTO](index.md)/[endBooking](end-booking.md) | ||
|
||
# endBooking | ||
|
||
[jvm]\ | ||
val [endBooking](end-booking.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
Oops, something went wrong.