Add probation teams API (and APIDocs) #56
Conversation
sldblog
force-pushed
the
probation-team-api
branch
3 times, most recently
from
e87a855
to
61c9d8a
Compare
The `APIDocs` class will set the Structurizr property called `api-docs-url`. The intent is to capture the "default" API docs URLs for C4 containers that are exposing HMPPS-usable APIs. Later, it may be possible to pull this information based on GitHub repository links, but for now, manual fill seems appropriate. The existence of this also allows for people to _search_ for `API` and get results within the codebase -- if they'd like to find out what APIs exist.
sldblog
force-pushed
the
probation-team-api
branch
from
61c9d8a
to
0ccd17f
Compare
sldblog
changed the title
There was a problem hiding this comment.
👍 this provides a nice, consistent interface to add API docs.
My gut reaction was: could we add this to our HMPPSSoftwareSystem interface, so it becomes an attribute of our object rather than a functional wrapper? Obviously that doesn't work in this case because we want to add API doc URLs to containers as well as systems, so is it highlighting the need for a container abstraction?
This does make me wonder:
- Should we be expanding our abstraction layer to include containers, and/or
- Is this a useful abstraction to push upstream?
It feels like we're unlikely to be the only users of this building additional tooling for this, and it'd be amazing if what we build here could end up helping other Structurizr/C4 developers.
Anyway, they're more grand thoughts than a review! This is spot-on while we consider the wider architecture, as it'll make identifying and refactoring API URLs much easier if/when we need to.
|
Thanks, Ryan! Good points -- I've extracted it to #58 for discussion 🙇♂️ |
|
🙇♂️ Thank you! |
What does this pull request do?
Adds the https://github.com/ministryofjustice/probation-teams API to the model.
API docs
This pull request introduces the
APIDocsclass, which sets the Structurizr propertyapi-docs-url. Please refer to the full details in ba50bf5.What is the intent behind these changes?
To make sure we can discover all APIs from this repository.
Outstanding questions
API.addTo(this)?)APIDocsobject solves this -- anything with an API docs link is an API.