Skip to content
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

Jump to bottom

Add option to disable Swagger #2981

Merged
merged 19 commits into from
Dec 25, 2022
Merged

Add option to disable Swagger #2981

merged 19 commits into from
Dec 25, 2022

Conversation

yuvalyaron
Copy link
Collaborator

@yuvalyaron yuvalyaron commented Dec 20, 2022 •
edited
Loading

Resolves #2925

What is being addressed

Added the option to disable Swagger UI

How is this addressed

  • Added 'ENABLE_SWAGGER' option in the config.yaml
  • When swagger is disabled, the /docs endpoint will return an error messages saying that Swagger is disabled.
  • The Swagger UI is disabled by default, but the config.yaml has a default value of true, so developers will still have Swagger.

@yuvalyaron yuvalyaron added the api Composition Service API label Dec 20, 2022
@yuvalyaron yuvalyaron requested a review from LizaShak December 20, 2022 17:51
@github-actions
Copy link

github-actions bot commented Dec 20, 2022 •
edited
Loading

Unit Test Results

536 tests   536 ✔️  16s ⏱️
    1 suites      0 💤
    1 files        0 ❌

Results for commit 00e295f.

♻️ This comment has been updated with latest results.

LizaShak
LizaShak reviewed Dec 21, 2022
View reviewed changes
config.sample.yaml Show resolved Hide resolved
api_app/api/routes/api.py Outdated Show resolved Hide resolved
tamirkamara
tamirkamara reviewed Dec 21, 2022
View reviewed changes
templates/core/terraform/api-webapp.tf Show resolved Hide resolved
api_app/api/routes/api.py Outdated Show resolved Hide resolved
api_app/api/routes/api.py Outdated Show resolved Hide resolved
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:34 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 11:41 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:22 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:22 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:22 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:22 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:28 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:50 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 12:50 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron temporarily deployed to CICD December 22, 2022 13:30 — with GitHub Actions Inactive
@yuvalyaron yuvalyaron enabled auto-merge (squash) December 25, 2022 12:41
@yuvalyaron
Copy link
Collaborator Author

/test

@github-actions
Copy link

🤖 pr-bot 🤖

🏃 Running tests: https://github.com/microsoft/AzureTRE/actions/runs/3775882671 (with refid 63291076)

(in response to this comment from @yuvalyaron)

@yuvalyaron yuvalyaron merged commit d39e05c into microsoft:main Dec 25, 2022
@yuvalyaron yuvalyaron deleted the feature/2925-add-option-to-disable-swagger-ui branch December 25, 2022 13:51
@yuvalyaron yuvalyaron mentioned this pull request Mar 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tamirkamara tamirkamara tamirkamara left review comments

@LizaShak LizaShak LizaShak approved these changes

Assignees
No one assigned
Labels
api Composition Service API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add option to disable Swagger UI
3 participants
@yuvalyaron @tamirkamara @LizaShak