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.

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

Add API docs to Delius and NOMIS containers #62

Merged
merged 3 commits into from
Aug 19, 2020
Merged

Conversation

sldblog
Copy link
Contributor

@sldblog sldblog commented Aug 19, 2020

What does this pull request do?

Adds API docs to Delius community-api (related to ministryofjustice/community-api#242)
Adds API docs to NOMIS prisoner-offender-search and prison-apis.

What is the intent behind these changes?

To make sure we have as many APIs documented and published in #61 as possible.

@sldblog sldblog requested a review from a team as a code owner August 19, 2020 09:57
@sldblog sldblog changed the title Add API docs to Delius community-api Add API docs to Delius community-api, NOMIS prisoner-offender-search and prison-apis Aug 19, 2020
@sldblog sldblog changed the title Add API docs to Delius community-api, NOMIS prisoner-offender-search and prison-apis Add API docs to Delius and NOMIS containers Aug 19, 2020
@@ -44,6 +44,7 @@ class Delius private constructor() {
"Community API",
"API over the nDelius DB used by HMPPS Digital team applications and services", "Java"
).apply {
APIDocs("https://community-api.test.delius.probation.hmpps.dsd.io/swagger-ui.html").addTo(this)
Copy link
Contributor

Choose a reason for hiding this comment

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

I notice this is a test URL, where-as the other swagger docs are production.
Also it's not accessible unless on the MoJ VPN - maybe not an issue for a dev, but just an observation about the availability of the swagger docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll approve anyway as it is factually correct and what we use right now, but maybe highlights a few inconsistencies we can look at in future.

Copy link
Contributor Author

@sldblog sldblog Aug 19, 2020

Choose a reason for hiding this comment

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

👍 Yes, unfortunately, this is the one that's widely shared with everyone at the moment (as far as I can see).

I want to go through the whole lot and settle on pre-production or production URLs at some point next week (coming weeks?). I'll make an issue out of this with a deadline

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Opened #64.

Copy link
Contributor

@philroffe philroffe left a comment

Choose a reason for hiding this comment

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

Approved. Might be useful to try to drive some consistency in our swagger docs in future (different test envs etc).

@@ -44,6 +44,7 @@ class Delius private constructor() {
"Community API",
"API over the nDelius DB used by HMPPS Digital team applications and services", "Java"
).apply {
APIDocs("https://community-api.test.delius.probation.hmpps.dsd.io/swagger-ui.html").addTo(this)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll approve anyway as it is factually correct and what we use right now, but maybe highlights a few inconsistencies we can look at in future.

@sldblog sldblog merged commit 6b1ec72 into main Aug 19, 2020
@sldblog sldblog deleted the community-api-docs branch August 19, 2020 16:20
@sldblog
Copy link
Contributor Author

sldblog commented Aug 19, 2020

Thank you! 🙇‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants