Skip to content

Commit

Permalink
add code from gitlab
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryT-CG committed Sep 4, 2024
1 parent 9f7a8c8 commit 9bfb082
Show file tree
Hide file tree
Showing 33 changed files with 1,806 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
name: onecx-bookmark
title: Bookmark Management
version: latest
4 changes: 4 additions & 0 deletions docs/modules/onecx-bookmark-svc/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* xref:onecx-bookmark-svc:index.adoc[Backend Service]
** External API(s)
*** xref:onecx-bookmark-svc:openapi/onecx-bookmark-v1-openapi.adoc[Bookmark Management V1]
*** xref:onecx-bookmark-svc:openapi/di-bookmark-v1.adoc[Bookmark Data Import V1]
10 changes: 10 additions & 0 deletions docs/modules/onecx-bookmark-svc/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
include::onecx-bookmark-svc-attributes.adoc[opts=optional]

== onecx-bookmark-svc

include::docs.adoc[opts=optional]

=== Configuration
include::onecx-bookmark-svc.adoc[opts=optional]

include::onecx-bookmark-svc-docs.adoc[opts=optional]
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

:docker-registry: https://github.com/onecx/onecx-bookmark-svc/pkgs/container/onecx-bookmark-svc
:helm-registry: https://github.com/onecx/onecx-bookmark-svc/pkgs/container/charts%2Fonecx-bookmark-svc
:properties-file: src/main/resources/application.properties
:helm-file: src/main/helm/values.yaml
69 changes: 69 additions & 0 deletions docs/modules/onecx-bookmark-svc/pages/onecx-bookmark-svc-docs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@

include::onecx-bookmark-svc-attributes.adoc[opts=optional]

=== Default properties

.{properties-file}
[%collapsible%open]
====
[source,properties,subs=attributes+]
----
quarkus.datasource.db-kind=postgresql
quarkus.datasource.jdbc.max-size=30
quarkus.datasource.jdbc.min-size=10
quarkus.http.auth.permission.health.paths=/q/*
quarkus.http.auth.permission.health.policy=permit
quarkus.http.auth.permission.default.paths=/*
quarkus.http.auth.permission.default.policy=authenticated
quarkus.hibernate-orm.database.generation=validate
quarkus.hibernate-orm.multitenant=DISCRIMINATOR
quarkus.hibernate-orm.jdbc.timezone=UTC
quarkus.liquibase.migrate-at-start=true
quarkus.liquibase.validate-on-migrate=true
tkit.dataimport.enabled=false
tkit.dataimport.configurations.template.file=import/template.json
tkit.dataimport.configurations.template.metadata.tenants=default
tkit.dataimport.configurations.template.class-path=true
tkit.dataimport.configurations.template.enabled=false
tkit.dataimport.configurations.template.stop-at-error=true
tkit.rs.context.tenant-id.enabled=true
%prod.quarkus.datasource.jdbc.url=${DB_URL:jdbc:postgresql://postgresdb:5432/onecx-bookmark?sslmode=disable}
%prod.quarkus.datasource.username=${DB_USER:onecx-bookmark}
%prod.quarkus.datasource.password=${DB_PWD:onecx-bookmark}
----
====

=== Extensions

include::onecx-bookmark-svc-extensions.adoc[opts=optional]

=== Container

{docker-registry}[Docker registry]


=== Helm

{helm-registry}[Helm registry]

Default values

.{helm-file}
[source,yaml]
----
app:
name: svc
image:
repository: "onecx/onecx-bookmark-svc"
db:
enabled: true
operator:
keycloak:
client:
enabled: true
spec:
kcConfig:
defaultClientScopes: [ ocx-tn:read ]
----

Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@

include::onecx-bookmark-svc-attributes.adoc[opts=optional]

[.extension.table.searchable, cols="50,.^15,.^15,.^20"]
|===
h| Extensions
h| Documentation
h| Configuration
h| Version

| onecx-core

| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-core.html[Link]
|
| 0.26.0

| onecx-tenant

| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-tenant.html[Link]
| https://github.com/onecx/onecx-quarkus/blob/0.26.0/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc[Link]
| 0.26.0

| quarkus-oidc

| https://quarkus.io/guides/security-oidc-bearer-token-authentication-tutorial[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc.adoc[Link]
| 3.13.2
| tkit-quarkus-rest-context
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest-context.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest-context.adoc[Link]
| 2.31.0
| tkit-quarkus-jpa-tenant
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-jpa-tenant.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa-tenant.adoc[Link]
| 2.31.0
| tkit-quarkus-data-import
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-data-import.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-data-import.adoc[Link]
| 2.31.0
| tkit-quarkus-jpa
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-jpa.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa.adoc[Link]
| 2.31.0
| tkit-quarkus-log-cdi
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-cdi.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-cdi.adoc[Link]
| 2.31.0
| tkit-quarkus-log-rs
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-rs.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-rs.adoc[Link]
| 2.31.0
| tkit-quarkus-log-json
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-json.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-json.adoc[Link]
| 2.31.0
| tkit-quarkus-rest
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest.adoc[Link]
| 2.31.0
| quarkus-arc
| https://quarkus.io/guides/cdi-reference[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-arc.adoc[Link]
| 3.13.2
| quarkus-liquibase
| https://quarkus.io/guides/liquibase[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-liquibase.adoc[Link]
| 3.13.2
| quarkus-smallrye-health
| https://quarkus.io/guides/smallrye-health[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-health.adoc[Link]
| 3.13.2
| quarkus-micrometer-registry-prometheus
| https://quarkus.io/guides/telemetry-micrometer[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-micrometer-registry-prometheus.adoc[Link]
| 3.13.2
| quarkus-hibernate-orm
| https://quarkus.io/guides/hibernate-orm[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-orm.adoc[Link]
| 3.13.2
| quarkus-rest
| https://quarkus.io/guides/rest[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-rest.adoc[Link]
| 3.13.2
| quarkus-rest-jackson
| https://quarkus.io/guides/rest-json[Link]
|
| 3.13.2
| quarkus-jdbc-postgresql
| https://quarkus.io/guides/datasource[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-jdbc-postgresql.adoc[Link]
| 3.13.2
| quarkus-smallrye-openapi
| https://quarkus.io/guides/openapi-swaggerui[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc[Link]
| 3.13.2
| quarkus-hibernate-validator
| https://quarkus.io/guides/validation[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-validator.adoc[Link]
| 3.13.2
| quarkus-opentelemetry
| https://quarkus.io/guides/opentelemetry[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-opentelemetry.adoc[Link]
| 3.13.2
| tkit-quarkus-security
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-security.html[Link]
| https://github.com/1000kit/tkit-quarkus/blob/2.31.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-security.adoc[Link]
| 2.31.0
| quarkus-container-image-docker
| https://quarkus.io/guides/container-image[Link]
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-container-image-docker.adoc[Link]
| 3.13.2
| onecx-security
|
|
| 0.26.0
| quarkus-smallrye-context-propagation
|
|
| 3.13.2
|===
63 changes: 63 additions & 0 deletions docs/modules/onecx-bookmark-svc/pages/onecx-bookmark-svc.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@

:summaryTableId: onecx-bookmark-svc
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[onecx-bookmark-svc_configuration]]link:#onecx-bookmark-svc_configuration[Configuration property]

h|Type
h|Default

a| [[onecx-bookmark-svc_onecx-bookmark-default-enabled]]`link:#onecx-bookmark-svc_onecx-bookmark-default-enabled[onecx.bookmark.default.enabled]`


[.description]
--
Enable or disable default bookmark

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++ONECX_BOOKMARK_DEFAULT_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++ONECX_BOOKMARK_DEFAULT_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[onecx-bookmark-svc_onecx-bookmark-default-url]]`link:#onecx-bookmark-svc_onecx-bookmark-default-url[onecx.bookmark.default.url]`


[.description]
--
Default bookmark URL

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++ONECX_BOOKMARK_DEFAULT_URL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++ONECX_BOOKMARK_DEFAULT_URL+++`
endif::add-copy-button-to-env-var[]
--|string
|`https://github.com/onecx`


a| [[onecx-bookmark-svc_onecx-bookmark-product-item-id]]`link:#onecx-bookmark-svc_onecx-bookmark-product-item-id[onecx.bookmark.product-item-id]`


[.description]
--
Default bookmark URL

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++ONECX_BOOKMARK_PRODUCT_ITEM_ID+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++ONECX_BOOKMARK_PRODUCT_ITEM_ID+++`
endif::add-copy-button-to-env-var[]
--|string
|`PRODUCT_BASE_DOC_URL`

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:page-layout: swagger
:page-swagger-url: https://raw.githubusercontent.com/onecx/onecx-bookmark-svc/main/src/main/openapi/onecx-bookmark-internal-openapi.yaml
Loading

0 comments on commit 9bfb082

Please sign in to comment.