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

GAWB-2339 Add swagger #3

Merged
merged 8 commits into from
Jul 21, 2017
Merged

GAWB-2339 Add swagger #3

merged 8 commits into from
Jul 21, 2017

Conversation

helgridly
Copy link
Contributor

@helgridly helgridly commented Jul 19, 2017 •
edited
Loading

Also reference.conf and logback

  • Submitter: Include the JIRA issue number in the PR description
  • Submitter: Make sure Swagger is updated if API changes
  • Submitter: If updating admin endpoints, also update firecloud-admin-cli
  • Submitter: Check documentation and code comments. Add explanatory PR comments if helpful.
  • Submitter: JIRA ticket checks:
    • Acceptance criteria exists and is met
    • Note any changes to implementation from the description
    • To Demo flag is set
    • Release Summary is filled out, if applicable
    • Add notes on how to QA
  • Submitter: Update RC_XXX release ticket with any config or environment changes necessary
  • Submitter: Update FISMA documentation if changes to:
    • Authentication
    • Authorization
    • Encryption
    • Audit trails
  • Tell the tech lead (TL) that the PR exists if they wants to look at it
  • Anoint a lead reviewer (LR). Assign PR to LR
  • Review cycle:
    • LR reviews
    • Rest of team may comment on PR at will
    • LR assigns to submitter for feedback fixes
    • Submitter rebases to develop again if necessary
    • Submitter makes further commits. DO NOT SQUASH
    • Submitter updates documentation as needed
    • Submitter reassigns to LR for further feedback
  • TL sign off
  • LR sign off
  • Product Owner sign off
  • Assign to submitter to finalize
  • Submitter: Verify all tests go green, including CI tests
  • Submitter: Squash commits and merge to develop
  • Submitter: Delete branch after merge
  • Submitter: Test this change works on dev environment after deployment. YOU own getting it fixed if dev isn't working for ANY reason!
  • Submitter: Verify swagger UI on dev environment still works after deployment
  • Submitter: Inform other teams of any API changes via Slack and/or email
  • Submitter: Mark JIRA issue as resolved once this checklist is completed

@helgridly helgridly requested a review from rtitle July 19, 2017 20:59
@helgridly helgridly changed the title Add swagger GAWB-2339 Add swagger Jul 19, 2017
rtitle
rtitle reviewed Jul 19, 2017
View reviewed changes
src/main/resources/logback.xml Outdated
</appender>

<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>log/sam.log</file>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leonardo.log?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feck

rtitle
rtitle reviewed Jul 19, 2017
View reviewed changes
src/main/resources/logback.xml Outdated
<append>true</append>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- daily rollover -->
<fileNamePattern>rawls.%d{yyyy-MM-dd}.log</fileNamePattern>
Copy link
Collaborator

@rtitle rtitle Jul 19, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leonardo

(I see your copy-paste strategy)

rtitle
rtitle reviewed Jul 19, 2017
View reviewed changes
src/main/scala/org/broadinstitute/dsde/workbench/leonardo/api/SwaggerRoutes.scala
val swaggerRoutes: server.Route = {
path("") {
get {
parameter("url") { urlparam =>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this redirects to the same URI but with the query string stripped out? What is the url parameter -- is it a Swagger thing that we don't care about?

Since urlparam is not used I'd recommend doing:

parameter("url") { _ =>
  ...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i yanked this blindly from sam, so no idea what it's up to

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rawls doesn't do this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dvoet can you clear this up?

rtitle
rtitle reviewed Jul 19, 2017
View reviewed changes
src/main/scala/org/broadinstitute/dsde/workbench/leonardo/api/SwaggerRoutes.scala Outdated
redirect(uri.withRawQueryString(""), StatusCodes.MovedPermanently)
}
} ~
serveIndex()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation, I think this is correct:

  } ~
  serveIndex()

@coveralls
Copy link

Coverage Status

Coverage increased (+2.0%) to 26.966% when pulling e2d7f8c on add_swagger into f67298e on develop.

@coveralls
Copy link

Coverage Status

Coverage increased (+2.0%) to 26.966% when pulling e2d7f8c on add_swagger into f67298e on develop.

rtitle
rtitle reviewed Jul 19, 2017
View reviewed changes
src/main/scala/org/broadinstitute/dsde/workbench/leonardo/api/SwaggerRoutes.scala Outdated
// .replace("your-client-id", swaggerConfig.googleClientId) //awaiting integration with dev
// .replace("your-realms", swaggerConfig.realm)
// .replace("your-app-name", swaggerConfig.realm)
.replace("scopeSeparator: \",\"", "scopeSeparator: \" \"")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor, could use """ to avoid escaping quotes, and also interpolated strings.

BTW this is terrifying but I don't really have a better suggestion.

@rtitle
Copy link
Collaborator

rtitle commented Jul 19, 2017

Some minor comments, overall 👍

@helgridly helgridly merged commit 030a2dc into develop Jul 21, 2017
@helgridly helgridly deleted the add_swagger branch July 21, 2017 22:55
akarukappadath pushed a commit that referenced this pull request Jul 11, 2018
@helgridly @akarukappadath
GAWB-2339 Add swagger (#3)
5e3f680
akarukappadath pushed a commit that referenced this pull request Oct 22, 2018
@helgridly @akarukappadath
GAWB-2339 Add swagger (#3)
68b7dfb
Qi77Qi pushed a commit that referenced this pull request Jun 25, 2019
@helgridly @Qi77Qi
GAWB-2339 Add swagger (#3)
5a445e2
jchanbroad pushed a commit that referenced this pull request Jun 27, 2019
@helgridly @jchanbroad
GAWB-2339 Add swagger (#3)
4b452fa
@jdcanas jdcanas mentioned this pull request Feb 20, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rtitle rtitle rtitle approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@helgridly @coveralls @rtitle