Add contact information to Swagger UI (#6205) #6720

achave11-ucsc · 2024-11-20T17:51:59Z

Connected issues: #6205

Checklist

Author

PR is a draft
Target branch is develop
Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
On ZenHub, PR is connected to all issues it (partially) resolves
PR description links to connected issues
PR title matches¹ that of a connected issue _{or comment in PR explains why they're different}
PR title references all connected issues
For each connected issue, there is at least one commit whose title references that issue

¹ when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (partiality)

Added p tag to titles of partial commits
This PR is labeled partial _{or completely resolves all connected issues}
This PR partially resolves each of the connected issues _{or does not have the partial label}

Author (chains)

This PR is blocked by previous PR in the chain _{or is not chained to another PR}
The blocking PR is labeled base _{or this PR is not chained to another PR}
This PR is labeled chained _{or is not chained to another PR}

Author (reindex, API changes)

Added r tag to commit title _{or the changes introduced by this PR will not require reindexing of any deployment}
This PR is labeled reindex:dev _{or the changes introduced by it will not require reindexing of dev}
This PR is labeled reindex:anvildev _{or the changes introduced by it will not require reindexing of anvildev}
This PR is labeled reindex:anvilprod _{or the changes introduced by it will not require reindexing of anvilprod}
This PR is labeled reindex:prod _{or the changes introduced by it will not require reindexing of prod}
This PR is labeled reindex:partial and its description documents the specific reindexing procedure for dev, anvildev, anvilprod and prod _{or requires a full reindex or carries none of the labels reindex:dev, reindex:anvildev, reindex:anvilprod and reindex:prod}
This PR and its connected issues are labeled API _{or this PR does not modify a REST API}
Added a (A) tag to commit title for backwards (in)compatible changes _{or this PR does not modify a REST API}
Updated REST API version number in app.py _{or this PR does not modify a REST API}

Author (upgrading deployments)

Ran make docker_images.json and committed the resulting changes _{or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable}
Documented upgrading of deployments in UPGRADING.rst _{or this PR does not require upgrading deployments}
Added u tag to commit title _{or this PR does not require upgrading deployments}
This PR is labeled upgrade _{or does not require upgrading deployments}
This PR is labeled deploy:shared _{or does not modify docker_images.json, and does not require deploying the shared component for any other reason}
This PR is labeled deploy:gitlab _{or does not require deploying the gitlab component}
This PR is labeled deploy:runner _{or does not require deploying the runner image}

Author (hotfixes)

Added F tag to main commit title _{or this PR does not include permanent fix for a temporary hotfix}
Reverted the temporary hotfixes for any connected issues _{or the none of the stable branches (anvilprod and prod) have temporary hotfixes for any of the issues connected to this PR}

Author (before every review)

Rebased PR branch on develop, squashed old fixups
Ran make requirements_update _{or this PR does not modify requirements*.txt, common.mk, Makefile and Dockerfile}
Added R tag to commit title _{or this PR does not modify requirements*.txt}
This PR is labeled reqs _{or does not modify requirements*.txt}
make integration_test passes in personal deployment _{or this PR does not modify functionality that could affect the IT outcome}

Peer reviewer (after approval)

PR is not a draft
Ticket is in Review requested column
PR is awaiting requested review from system administrator
PR is assigned to only the system administrator

System administrator (after approval)

Actually approved the PR
Labeled connected issues as demo or no demo
Commented on connected issues about demo expectations _{or all connected issues are labeled no demo}
Decided if PR can be labeled no sandbox
A comment to this PR details the completed security design review
PR title is appropriate as title of merge commit
N reviews label is accurate
Moved connected issues to Approved column
PR is assigned to only the operator

Operator (before pushing merge the commit)

System administrator

Background migrations for dev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
Background migrations for anvildev.gitlab are complete _{or this PR is not labeled deploy:gitlab}
PR is assigned to only the operator

Operator (before pushing merge the commit)

Operator (chain shortening)

Changed the target branch of the blocked PR to develop _{or this PR is not labeled base}
Removed the chained label from the blocked PR _{or this PR is not labeled base}
Removed the blocking relationship from the blocked PR _{or this PR is not labeled base}
Removed the base label from this PR _{or this PR is not labeled base}

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Propagated the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels to the next promotion PRs _{or this PR carries none of these labels}
Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels, from the description of this PR to that of the next promotion PRs _{or this PR carries none of these labels}
PR is assigned to no one

Shorthand for review comments

L line is too long
W line wrapping is wrong
Q bad quotes
F other formatting problem

codecov · 2024-11-20T18:19:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.68%. Comparing base (0bb6aab) to head (85066ce).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6720      +/-   ##
===========================================
+ Coverage    85.66%   85.68%   +0.01%     
===========================================
  Files          149      149              
  Lines        20996    21013      +17     
===========================================
+ Hits         17987    18005      +18     
+ Misses        3009     3008       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coveralls · 2024-11-20T18:20:03Z

coverage: 85.702% (+0.02%) from 85.686%
when pulling 85066ce on issues/achave11-ucsc/6205-add-contact-to-swagger
into 0bb6aab on develop.

nadove-ucsc · 2024-11-20T23:14:53Z

lambdas/service/app.py

+            [GitHub](https://github.com/DataBiosphere/azul/issues) or email
+            `[email protected]`. To report a security concern or misconduct
+            please email `[email protected]`.
+


Suggested change

hannes-ucsc · 2024-11-26T18:02:15Z

lambdas/indexer/app.py

+
+            ## Contact us
+
+            For technical and user support please file an issue on


Suggested change

For technical and user support please file an issue on

For technical support please file an issue at

hannes-ucsc · 2024-11-26T18:03:44Z

lambdas/service/app.py

+
+            ## Contact us
+
+            For technical and user support please file an issue on
+            [GitHub](https://github.com/DataBiosphere/azul/issues) or email
+            `[email protected]`. To report a security concern or misconduct
+            please email `[email protected]`.


It should be possible to avoid this duplication.

hannes-ucsc · 2025-01-13T19:33:11Z

Security design review

achave11-ucsc · 2025-01-14T18:05:55Z

PR failed sandbox, returning to in progress for further triaging.
https://gitlab.dev.singlecell.gi.ucsc.edu/ucsc/azul/-/jobs/108066
https://gitlab.anvil.gi.ucsc.edu/ucsc/azul/-/jobs/55734

achave11-ucsc · 2025-01-14T22:13:04Z

The make check_clean target fails …

$ make check_clean
git diff --exit-code && git diff --cached --exit-code
diff --git a/lambdas/indexer/openapi.json b/lambdas/indexer/openapi.json
index 06738c6..3274d94 100644
--- a/lambdas/indexer/openapi.json
+++ b/lambdas/indexer/openapi.json
@@ -2,7 +2,7 @@
     "openapi": "3.0.1",
     "info": {
         "title": "azul-indexer-dev",
-        "description": "…CONDENSED… or email\n`[email protected]`. To report a security concern or misconduct please email\n`[email protected]`.\n",
+        "description": "…CONDENSED… or email\n`[email protected]`. To report a security concern or misconduct please email\n`[email protected]`.\n",
         "version": "1.1"
     },

… this is due to the sandbox deployments deriving the monitoring email from AZUL_OWNER, which in this case is [email protected].

diff --git a/deployments/anvilbox/environment.py b/deployments/anvilbox/environment.py
index f000d4380..a667e1c8b 100644
--- a/deployments/anvilbox/environment.py
+++ b/deployments/anvilbox/environment.py
@@ -150,6 +150,7 @@ def env() -> Mapping[str, Optional[str]]:
         'AZUL_OWNER': '[email protected]' if is_sandbox else None,
 
         'AZUL_MONITORING_EMAIL': '{AZUL_OWNER}',
+        # NOTE ^^
 
         'AZUL_AWS_ACCOUNT_ID': '289950828509',
         'AWS_DEFAULT_REGION': 'us-east-1',
diff --git a/deployments/hammerbox/environment.py b/deployments/hammerbox/environment.py
index 3265eacd9..af2771ce5 100644
--- a/deployments/hammerbox/environment.py
+++ b/deployments/hammerbox/environment.py
@@ -1026,6 +1026,7 @@ def env() -> Mapping[str, Optional[str]]:
         'AZUL_OWNER': '[email protected]' if is_sandbox else None,
 
         'AZUL_MONITORING_EMAIL': '{AZUL_OWNER}',
+        # NOTE ^^
 
         'AZUL_AWS_ACCOUNT_ID': '465330168186',
         'AWS_DEFAULT_REGION': 'us-east-1',
diff --git a/deployments/sandbox/environment.py b/deployments/sandbox/environment.py
index 7b0860f94..80ace3b83 100644
--- a/deployments/sandbox/environment.py
+++ b/deployments/sandbox/environment.py
@@ -273,6 +273,7 @@ def env() -> Mapping[str, Optional[str]]:
         'AZUL_OWNER': '[email protected]' if is_sandbox else None,
 
         'AZUL_MONITORING_EMAIL': '{AZUL_OWNER}',
+        # NOTE ^^
 
         'AZUL_AWS_ACCOUNT_ID': '122796619775',
         'AWS_DEFAULT_REGION': 'us-east-1',

When the OpenAPI spec is generated with this details, given …

   @property
    def contact_us(self) -> str:
        email = self.monitoring_email
        return format_description(f'''
            ## Contact us
            For technical support please file an issue at
            [GitHub](https://github.com/DataBiosphere/azul/issues) or email
            `{email}`. To report a security concern or misconduct please email
            `{email}`.
        ''')

… in src/azul/__init__.py from this PR, it results in the make check_clean failure.

Condense patching of config properties

github-actions bot added the orange [process] Done by the Azul team label Nov 20, 2024

achave11-ucsc added the API API change affecting callers label Nov 20, 2024

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from 176b1ed to 721a91a Compare November 20, 2024 17:58

achave11-ucsc requested a review from nadove-ucsc November 20, 2024 18:21

achave11-ucsc assigned nadove-ucsc and unassigned nadove-ucsc Nov 20, 2024

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from 721a91a to 11a1181 Compare November 20, 2024 20:15

achave11-ucsc removed the API API change affecting callers label Nov 20, 2024

achave11-ucsc assigned nadove-ucsc Nov 20, 2024

nadove-ucsc requested changes Nov 20, 2024

View reviewed changes

nadove-ucsc removed their assignment Nov 20, 2024

achave11-ucsc requested a review from nadove-ucsc November 21, 2024 01:26

achave11-ucsc assigned nadove-ucsc Nov 21, 2024

nadove-ucsc previously approved these changes Nov 21, 2024

View reviewed changes

nadove-ucsc marked this pull request as ready for review November 21, 2024 02:01

nadove-ucsc requested a review from hannes-ucsc as a code owner November 21, 2024 02:01

nadove-ucsc assigned hannes-ucsc and unassigned nadove-ucsc Nov 21, 2024

hannes-ucsc requested changes Nov 26, 2024

View reviewed changes

hannes-ucsc removed their assignment Nov 26, 2024

hannes-ucsc added the 1 review [process] Lead requested changes once label Nov 26, 2024

achave11-ucsc dismissed nadove-ucsc’s stale review via 9db9335 November 26, 2024 19:27

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from d792aa0 to 9db9335 Compare November 26, 2024 19:27

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch 5 times, most recently from d2d5d3d to 552bcda Compare December 5, 2024 23:20

hannes-ucsc removed their assignment Jan 13, 2025

hannes-ucsc requested review from hannes-ucsc and nadove-ucsc January 13, 2025 19:33

hannes-ucsc previously approved these changes Jan 13, 2025

View reviewed changes

hannes-ucsc removed the request for review from nadove-ucsc January 13, 2025 19:35

achave11-ucsc dismissed hannes-ucsc’s stale review via 359edb9 January 13, 2025 22:27

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from 5a7f4c2 to 359edb9 Compare January 13, 2025 22:27

achave11-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label Jan 13, 2025

achave11-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch 4 times, most recently from 144a3db to 06a9d7a Compare January 17, 2025 00:04

achave11-ucsc removed their assignment Jan 17, 2025

achave11-ucsc requested a review from hannes-ucsc January 17, 2025 00:40

achave11-ucsc assigned hannes-ucsc Jan 17, 2025

achave11-ucsc and others added 3 commits January 17, 2025 15:31

[1/4] Add contact information to Swagger UI (#6205)

1cb0e03

[2/4] Add contact information to Swagger UI (#6205)

bdcdfa6

[3/4] Add contact information to Swagger UI (#6205)

f2ba8d5

hannes-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from 06a9d7a to 1294e31 Compare January 17, 2025 23:31

hannes-ucsc previously approved these changes Jan 17, 2025

View reviewed changes

hannes-ucsc assigned achave11-ucsc and unassigned hannes-ucsc Jan 17, 2025

[4/4] Add contact information to Swagger UI (#6205)

85066ce

Condense patching of config properties

hannes-ucsc dismissed their stale review via 85066ce January 17, 2025 23:35

hannes-ucsc force-pushed the issues/achave11-ucsc/6205-add-contact-to-swagger branch from 1294e31 to 85066ce Compare January 17, 2025 23:35

achave11-ucsc assigned hannes-ucsc and unassigned achave11-ucsc Jan 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add contact information to Swagger UI (#6205) #6720

Add contact information to Swagger UI (#6205) #6720

achave11-ucsc commented Nov 20, 2024 •

edited

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading

coveralls commented Nov 20, 2024 •

edited

Loading

nadove-ucsc Nov 20, 2024

hannes-ucsc Nov 26, 2024

hannes-ucsc Nov 26, 2024

hannes-ucsc commented Jan 13, 2025

achave11-ucsc commented Jan 14, 2025

achave11-ucsc commented Jan 14, 2025


		## Contact us

		For technical and user support please file an issue on

	For technical and user support please file an issue on
	For technical support please file an issue at

Add contact information to Swagger UI (#6205) #6720

Are you sure you want to change the base?

Add contact information to Swagger UI (#6205) #6720

Conversation

achave11-ucsc commented Nov 20, 2024 • edited Loading

Checklist

Author

Author (partiality)

Author (chains)

Author (reindex, API changes)

Author (upgrading deployments)

Author (hotfixes)

Author (before every review)

Peer reviewer (after approval)

System administrator (after approval)

Operator (before pushing merge the commit)

System administrator

Operator (before pushing merge the commit)

Operator (chain shortening)

Operator (after pushing the merge commit)

Operator (reindex)

Operator

Shorthand for review comments

codecov bot commented Nov 20, 2024 • edited Loading

Codecov Report

coveralls commented Nov 20, 2024 • edited Loading

nadove-ucsc Nov 20, 2024

Choose a reason for hiding this comment

hannes-ucsc Nov 26, 2024

Choose a reason for hiding this comment

hannes-ucsc Nov 26, 2024

Choose a reason for hiding this comment

hannes-ucsc commented Jan 13, 2025

Security design review

achave11-ucsc commented Jan 14, 2025

achave11-ucsc commented Jan 14, 2025

achave11-ucsc commented Nov 20, 2024 •

edited

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading

coveralls commented Nov 20, 2024 •

edited

Loading