-
Notifications
You must be signed in to change notification settings - Fork 29
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 #106 from RaythaHQ/release-v1.0.4
Release v1.0.4
- Loading branch information
Showing
38 changed files
with
1,171 additions
and
11 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 |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| on: | ||
| push: | ||
| branches: | ||
| - 'main' | ||
| - 'docfx' | ||
| jobs: | ||
| publish-docs: | ||
| runs-on: ubuntu-latest | ||
| environment: github-pages | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name: Dotnet Setup | ||
| uses: actions/setup-dotnet@v3 | ||
| with: | ||
| dotnet-version: 7.x | ||
|
|
||
| - run: dotnet tool update -g docfx | ||
| - run: docfx docfx_project/docfx.json | ||
|
|
||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.DOCS_TOKEN }} | ||
| publish_dir: docfx_project/_site |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ############### | ||
| # folder # | ||
| ############### | ||
| /**/DROP/ | ||
| /**/TEMP/ | ||
| /**/packages/ | ||
| /**/bin/ | ||
| /**/obj/ | ||
| _site | ||
| _site/* |
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,5 @@ | ||
| ############### | ||
| # temp file # | ||
| ############### | ||
| *.yml | ||
| .manifest |
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 @@ | ||
| # Application Layer Reference | ||
|
|
||
| The Application Layer Reference documentation covers all of the functionality that is available in the source code's Raytha.Application project. This is effectively the project that handles all of the business logic, read/write actions between the Web and WebApi layer and the database. | ||
|
|
||
| The code is well organized and follows the popular [CleanArchitecture pattern](https://github.com/jasontaylordev/CleanArchitecture) (CQRS). | ||
|
|
||
| Each item in this sidebar covers an aspect of the Raytha platform such as `users`, `admins`, `templates`, `content` and more. In CQRS, an action can be either a Query (read only) or a Command (write) and they are organized as such in this documentation. | ||
|
|
||
| Raytha uses [Mediatr](https://github.com/jbogard/MediatR) to send commands and queries. |
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,317 @@ | ||
| ### YamlMime:TableOfContent | ||
| - name: Admins | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Admins.Commands.CreateAdmin.Command | ||
| name: CreateAdmin | ||
| - uid: Raytha.Application.Admins.Commands.DeleteAdmin.Command | ||
| name: DeleteAdmin | ||
| - uid: Raytha.Application.Admins.Commands.EditAdmin.Command | ||
| name: EditAdmin | ||
| - uid: Raytha.Application.Admins.Commands.RemoveAdminAccess.Command | ||
| name: RemoveAdminAccess | ||
| - uid: Raytha.Application.Admins.Commands.ResetPassword.Command | ||
| name: ResetPassword | ||
| - uid: Raytha.Application.Admins.Commands.SetIsActive.Command | ||
| name: SetIsActive | ||
| - uid: Raytha.Application.Admins.Commands.CreateApiKey.Command | ||
| name: CreateApiKey | ||
| - uid: Raytha.Application.Admins.Commands.DeleteApiKey.Command | ||
| name: DeleteApiKey | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Admins.Queries.GetAdminById.Query | ||
| name: GetAdminById | ||
| - uid: Raytha.Application.Admins.Queries.GetAdmins.Query | ||
| name: GetAdmins | ||
| - uid: Raytha.Application.Admins.Queries.GetApiKeysForAdmin.Query | ||
| name: GetApiKeysForAdmin | ||
| - name: Audit Logs | ||
| items: | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.AuditLogs.Queries.GetAuditLogs.Query | ||
| name: GetAuditLogs | ||
| - name: Authentication Schemes | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.AuthenticationSchemes.Commands.CreateAuthenticationScheme.Command | ||
| name: CreateAuthenticationScheme | ||
| - uid: Raytha.Application.AuthenticationSchemes.Commands.DeleteAuthenticationScheme.Command | ||
| name: DeleteAuthenticationScheme | ||
| - uid: Raytha.Application.AuthenticationSchemes.Commands.EditAuthenticationScheme.Command | ||
| name: EditAuthenticationScheme | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.AuthenticationSchemes.Queries.GetAuthenticationSchemeById.Query | ||
| name: GetAuthenticationSchemeById | ||
| - uid: Raytha.Application.AuthenticationSchemes.Queries.GetAuthenticationSchemeByName.Query | ||
| name: GetAuthenticationSchemeByName | ||
| - uid: Raytha.Application.AuthenticationSchemes.Queries.GetAuthenticationSchemes.Query | ||
| name: GetAuthenticationSchemes | ||
| - name: Content Items | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.ContentItems.Commands.CreateContentItem.Command | ||
| name: CreateContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.DeleteAlreadyDeletedContentItem.Command | ||
| name: DeleteAlreadyDeletedContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.DeleteContentItem.Command | ||
| name: DeleteContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.DiscardDraftContentItem.Command | ||
| name: DiscardDraftContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.EditContentItem.Command | ||
| name: EditContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.EditContentItemSettings.Command | ||
| name: EditContentItemSettings | ||
| - uid: Raytha.Application.ContentItems.Commands.RestoreContentItem.Command | ||
| name: RestoreContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.RevertContentItem.Command | ||
| name: RevertContentItem | ||
| - uid: Raytha.Application.ContentItems.Commands.SetAsHomePage.Command | ||
| name: SetAsHomePage | ||
| - uid: Raytha.Application.ContentItems.Commands.UnpublishContentItem.Command | ||
| name: UnpublishContentItem | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.ContentItems.Queries.GetContentItemById.Query | ||
| name: GetContentItemById | ||
| - uid: Raytha.Application.ContentItems.Queries.GetContentItemRevisionsByContentItemId.Query | ||
| name: GetContentItemRevisionsByContentItemId | ||
| - uid: Raytha.Application.ContentItems.Queries.GetContentItems.Query | ||
| name: GetContentItems | ||
| - uid: Raytha.Application.ContentItems.Queries.GetDeletedContentItems.Query | ||
| name: GetDeletedContentItems | ||
| - name: Content Types | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.ContentTypes.Commands.CreateContentType.Command | ||
| name: CreateContentType | ||
| - uid: Raytha.Application.ContentTypes.Commands.CreateContentTypeField.Command | ||
| name: CreateContentTypeField | ||
| - uid: Raytha.Application.ContentTypes.Commands.DeleteContentTypeField.Command | ||
| name: DeleteContentTypeField | ||
| - uid: Raytha.Application.ContentTypes.Commands.EditContentType.Command | ||
| name: EditContentType | ||
| - uid: Raytha.Application.ContentTypes.Commands.EditContentTypeField.Command | ||
| name: EditContentTypeField | ||
| - uid: Raytha.Application.ContentTypes.Commands.ReorderContentTypeField.Command | ||
| name: ReorderContentTypeField | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypeByDeveloperName.Query | ||
| name: GetContentTypeByDeveloperName | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypeById.Query | ||
| name: GetContentTypeById | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypeFieldById.Query | ||
| name: GetContentTypeFieldById | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypeFields.Query | ||
| name: GetContentTypeFields | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypes.Query | ||
| name: GetContentTypes | ||
| - uid: Raytha.Application.ContentTypes.Queries.GetContentTypesAsListItems.Query | ||
| name: GetContentTypesAsListItems | ||
| - name: Dashboard | ||
| items: | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Dashboard.Queries.GetDashboardMetrics.Query | ||
| name: GetDashboardMetrics | ||
| - name: Login | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Login.Commands.BeginForgotPassword.Command | ||
| name: BeginForgotPassword | ||
| - uid: Raytha.Application.Login.Commands.BeginLoginWithMagicLink.Command | ||
| name: BeginLoginWithMagicLink | ||
| - uid: Raytha.Application.Login.Commands.ChangePassword.Command | ||
| name: ChangePassword | ||
| - uid: Raytha.Application.Login.Commands.ChangeProfile.Command | ||
| name: ChangeProfile | ||
| - uid: Raytha.Application.Login.Commands.CompleteForgotPassword.Command | ||
| name: CompleteForgotPassword | ||
| - uid: Raytha.Application.Login.Commands.CompleteLoginWithMagicLink.Command | ||
| name: CompleteLoginWithMagicLink | ||
| - uid: Raytha.Application.Login.Commands.CreateUser.Command | ||
| name: CreateUser | ||
| - uid: Raytha.Application.Login.Commands.LoginWithApiKey.Command | ||
| name: LoginWithApiKey | ||
| - uid: Raytha.Application.Login.Commands.LoginWithEmailAndPassword.Command | ||
| name: LoginWithEmailAndPassword | ||
| - uid: Raytha.Application.Login.Commands.LoginWithJwt.Command | ||
| name: LoginWithJwt | ||
| - uid: Raytha.Application.Login.Commands.LoginWithSaml.Command | ||
| name: LoginWithSaml | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Login.Queries.GetForgotPasswordTokenValidity.Query | ||
| name: GetForgotPasswordTokenValidity | ||
| - uid: Raytha.Application.Login.Queries.GetUserForAuthenticationById.Query | ||
| name: GetUserForAuthenticationById | ||
| - name: Media Items | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.MediaItems.Commands.CreateMediaItem.Command | ||
| name: CreateMediaItem | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.MediaItems.Queries.GetMediaItemById.Query | ||
| name: GetMediaItemById | ||
| - uid: Raytha.Application.MediaItems.Queries.GetMediaItemByObjectKey.Query | ||
| name: GetMediaItemByObjectKey | ||
| - uid: Raytha.Application.MediaItems.Queries.GetMediaItems.Query | ||
| name: GetMediaItems | ||
| - name: Organization Settings | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.OrganizationSettings.Commands.EditConfiguration.Command | ||
| name: EditConfiguration | ||
| - uid: Raytha.Application.OrganizationSettings.Commands.EditSmtp.Command | ||
| name: EditSmtp | ||
| - uid: Raytha.Application.OrganizationSettings.Commands.InitialSetup.Command | ||
| name: InitialSetup | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.OrganizationSettings.Queries.GetOrganizationSettings.Query | ||
| name: GetOrganizationSettings | ||
| - name: Roles | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Roles.Commands.CreateRole.Command | ||
| name: CreateRole | ||
| - uid: Raytha.Application.Roles.Commands.DeleteRole.Command | ||
| name: DeleteRole | ||
| - uid: Raytha.Application.Roles.Commands.EditRole.Command | ||
| name: EditRole | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Roles.Queries.GetRoleById.Query | ||
| name: GetRoleById | ||
| - uid: Raytha.Application.Roles.Queries.GetRoles.Query | ||
| name: GetRoles | ||
| - name: Routes | ||
| items: | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Routes.Queries.GetRouteByPath.Query | ||
| name: GetRouteByPath | ||
| - name: Email Templates | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Templates.Email.Commands.EditEmailTemplate.Command | ||
| name: EditEmailTemplate | ||
| - uid: Raytha.Application.Templates.Email.Commands.RevertEmailTemplate.Command | ||
| name: RevertEmailTemplate | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Templates.Email.Queries.GetEmailTemplateById.Query | ||
| name: GetEmailTemplateById | ||
| - uid: Raytha.Application.Templates.Email.Queries.GetEmailTemplateByName.Query | ||
| name: GetEmailTemplateByName | ||
| - uid: Raytha.Application.Templates.Email.Queries.GetEmailTemplateRevisionsByTemplateId.Query | ||
| name: GetEmailTemplateRevisionsByTemplateId | ||
| - uid: Raytha.Application.Templates.Email.Queries.GetEmailTemplates.Query | ||
| name: GetEmailTemplates | ||
| - name: Web Templates | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Templates.Web.Commands.CreateWebTemplate.Command | ||
| name: CreateWebTemplate | ||
| - uid: Raytha.Application.Templates.Web.Commands.DeleteWebTemplate.Command | ||
| name: DeleteWebTemplate | ||
| - uid: Raytha.Application.Templates.Web.Commands.EditWebTemplate.Command | ||
| name: EditWebTemplate | ||
| - uid: Raytha.Application.Templates.Web.Commands.RevertWebTemplate.Command | ||
| name: RevertWebTemplate | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Templates.Web.Queries.GetWebTemplateById.Query | ||
| name: GetWebTemplateById | ||
| - uid: Raytha.Application.Templates.Web.Queries.GetWebTemplateByName.Query | ||
| name: GetWebTemplateByName | ||
| - uid: Raytha.Application.Templates.Web.Queries.GetWebTemplateRevisionsByTemplateId.Query | ||
| name: GetWebTemplateRevisionsByTemplateId | ||
| - uid: Raytha.Application.Templates.Web.Queries.GetWebTemplates.Query | ||
| name: GetWebTemplates | ||
| - uid: Raytha.Application.Templates.Web.Queries.GetWebTemplatesAsListItems.Query | ||
| name: GetWebTemplatesAsListItems | ||
| - name: User Groups | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.UserGroups.Commands.CreateUserGroup.Command | ||
| name: CreateUserGroup | ||
| - uid: Raytha.Application.UserGroups.Commands.DeleteUserGroup.Command | ||
| name: DeleteUserGroup | ||
| - uid: Raytha.Application.UserGroups.Commands.EditUserGroup.Command | ||
| name: EditUserGroup | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.UserGroups.Queries.GetUserGroupById.Query | ||
| name: GetUserGroupById | ||
| - uid: Raytha.Application.UserGroups.Queries.GetUserGroups.Query | ||
| name: GetUserGroups | ||
| - name: Users | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Users.Commands.CreateUser.Command | ||
| name: CreateUser | ||
| - uid: Raytha.Application.Users.Commands.DeleteUser.Command | ||
| name: DeleteUser | ||
| - uid: Raytha.Application.Users.Commands.EditUser.Command | ||
| name: EditUser | ||
| - uid: Raytha.Application.Users.Commands.ResetPassword.Command | ||
| name: ResetPassword | ||
| - uid: Raytha.Application.Users.Commands.SetIsActive.Command | ||
| name: SetIsActive | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Users.Queries.GetUserById.Query | ||
| name: GetUserById | ||
| - uid: Raytha.Application.Users.Queries.GetUsers.Query | ||
| name: GetUsers | ||
| - name: Views | ||
| items: | ||
| - name: Commands | ||
| items: | ||
| - uid: Raytha.Application.Views.Commands.CreateView.Command | ||
| name: CreateView | ||
| - uid: Raytha.Application.Views.Commands.DeleteView.Command | ||
| name: DeleteView | ||
| - uid: Raytha.Application.Views.Commands.EditColumn.Command | ||
| name: EditColumn | ||
| - uid: Raytha.Application.Views.Commands.EditFilter.Command | ||
| name: EditFilter | ||
| - uid: Raytha.Application.Views.Commands.EditPublicSettings.Command | ||
| name: EditPublicSettings | ||
| - uid: Raytha.Application.Views.Commands.EditSort.Command | ||
| name: EditSort | ||
| - uid: Raytha.Application.Views.Commands.EditView.Command | ||
| name: EditView | ||
| - uid: Raytha.Application.Views.Commands.ReorderColumn.Command | ||
| name: ReorderColumn | ||
| - uid: Raytha.Application.Views.Commands.ReorderSort.Command | ||
| name: ReorderSort | ||
| - uid: Raytha.Application.Views.Commands.SetAsHomePage.Command | ||
| name: SetAsHomePage | ||
| - uid: Raytha.Application.Views.Commands.ToggleViewAsFavoriteForAdmin.Command | ||
| name: ToggleViewAsFavoriteForAdmin | ||
| - name: Queries | ||
| items: | ||
| - uid: Raytha.Application.Views.Queries.GetFavoriteViewsForAdmin.Query | ||
| name: GetFavoriteViewsForAdmin | ||
| - uid: Raytha.Application.Views.Queries.GetViewById.Query | ||
| name: GetViewById | ||
| - uid: Raytha.Application.Views.Queries.GetViews.Query | ||
| name: GetViews |
Oops, something went wrong.