Skip to content

Add possibility to customize API swagger texts. #66

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.

Sign up for GitHub

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

Open
RomainMou wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add possibility to customize API swagger texts. #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@ Object storage (S3):
| api_workers | 8 | Number of web processes
to handle requests. |
||||
| api_swagger_customization | false | Enable/Disable API swagger (/doc/) text customization. |
| api_swagger_title | "BIMData API" | API swagger (/doc/) page title. |
| api_swagger_tos | "" | API swagger (/doc/) URL to TOS. |
| api_swagger_contact_name | "Support" | API swagger (/doc/) contact name information. |
| api_swagger_contact_url | "" | API swagger (/doc/) contact URL information. |
| api_swagger_contact_email | "{{ debug_mail_to }}" | API swagger (/doc/) contaxct mail information. |
||||
| connect_secret_key | "{{ vault_connect_secret_key }}" | You should not change this. |
| connect_client_id | "{{ 'connect_client_id' \| to_uuid(namespace=uuid_namespace) }}" | You should not change this. |
| connect_client_secret | "{{ 'connect_client_secret' \| to_uuid(namespace=uuid_namespace) }}" | You should not change this. |
Expand Down
7 changes: 7 additions & 0 deletions roles/bimdata/templates/compose-app.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,13 @@ services:
{% endif %}
{% if tls_acme | bool %}
- LETSENCRYPT_HOST={{ api_dns_name }}
{% endif %}
{% if api_swagger_customization | bool %}
- SWAGGER_TITLE={{ api_swagger_title }}
- SWAGGER_TOS={{ api_swagger_tos }}
- SWAGGER_CONTACT_NAME={{ api_swagger_contact_name }}
- SWAGGER_CONTACT_URL={{ api_swagger_contact_url }}
- SWAGGER_CONTACT_EMAIL={{ api_swagger_contact_email }}
{% endif %}
restart: unless-stopped
{% if docker_use_extra_hosts | bool %}
Expand Down
8 changes: 8 additions & 0 deletions roles/prepare_vars/defaults/main/applications.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ csp_storage_url: "https://{{ s3_storage_connect_bucket_name }}.{{ (s3_endpoint_u
api_secret_key: "{{ vault_api_secret_key }}" # Change me in the vault
api_workers: 8

# API swagger (/doc/)
api_swagger_customization: false
api_swagger_title: BIMData API
api_swagger_tos: ""
api_swagger_contact_name: "Support"
api_swagger_contact_url: ""
api_swagger_contact_email: "{{ debug_mail_to }}"

# connect
connect_secret_key: "{{ vault_connect_secret_key }}" # Change me in the vault
connect_client_id: "{{ 'connect_client_id' | to_uuid(namespace=uuid_namespace) }}"
Expand Down