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 a diagram showing what the request flow looks like #461

Merged
merged 781 commits into from
Feb 5, 2024

Conversation

alexwlchan
Copy link
Contributor

@alexwlchan alexwlchan commented May 23, 2022

I was struggling to hold these interactions in my head, so I drew a quick diagram. This is also a place to hang any information about short-circuiting logic if it's useful; but for now it's just a diagram.

Rendered version: https://github.com/wellcomecollection/catalogue-api/blob/items-apis-documentation/docs/requesting_flow.md

@alexwlchan alexwlchan force-pushed the items-apis-documentation branch from 252ea87 to 6e52a35 Compare June 6, 2022 10:04
paul-butcher and others added 28 commits April 6, 2023 15:42
* add genre concept ids to image filters

* Apply auto-formatting rules

* update test docs

* update test docs

* add works filter test

* new test docs

* genre concept id filter on works

* add genre concept ids to image filters

* Apply auto-formatting rules

* use new availability data in aggregation test

* update images includes tests

* update availabilities test data

* update test for new data

* update test for new data

* update test for new data

* remove .id from genre concept filters

---------

Co-authored-by: Buildkite on behalf of Wellcome Collection <[email protected]>
…odule

Use the new Terraform module to create ACM certificates
rank tests for articles, exhibitions, and events
* first stab

* annotate on nano

* Apply auto-formatting rules

* try without the colours

* term wrapping

* annotation styling

* annotation styling

* double dollar

* put it in the right pipeline

* add artifact path

---------

Co-authored-by: Buildkite on behalf of Wellcome Collection <[email protected]>
Change the way we handle the lookup of unhandled items
…oduction-dates

Add filtering and sorting by production date on images
…-changed-work-id

update the rank tests to use a changed work id
corrected [search_docs] and [snapshots] URLs
kenoir and others added 16 commits January 25, 2024 13:42
This change follows #736, and adds an HTTP healthcheck to the items API to ensure the scala service has started before it is registered healthy at the NLB and starts serving requests.
…dpoint-items

Adds a simple healthcheck endpoint for the items service
This change adds a healthcheck endpoint to provide to a loadbalancer for the purposes of checking application health at deployment and under normal service.
…dpoint-requests

Adds a simple healthcheck endpoint for the requests service
## What is this change?

This change allows reviews from all developers to be sufficient for terraform changes. At present an approval to merge a PR for a terraform change must come from someone in the developers group, we probably want to widen that.

## How to test?

Merge it and see if developers outside the scala-reviewers group can approve terraform changes.
Mermaid on Github doesn't like it when an arrow is unlabelled in a sequence diagram, even when it's just a response to the previous message in the opposite direction.

I have added an "OK" to each of these and turned them all into dashed arrows to signify they are responses.
@alexwlchan alexwlchan requested a review from a team February 5, 2024 15:49
Copy link
Contributor

@jamieparkinson jamieparkinson left a comment

Choose a reason for hiding this comment

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

This PR seems to be h a u n t e d 👻 - thank you for the reminder, ghosts

alexwlchan and others added 4 commits February 5, 2024 15:59
Mermaid on Github doesn't like it when an arrow is unlabelled in a sequence diagram, even when it's just a response to the previous message in the opposite direction.

I have added an "OK" to each of these and turned them all into dashed arrows to signify they are responses.
@alexwlchan alexwlchan requested a review from a team as a code owner February 5, 2024 15:59
@jamieparkinson
Copy link
Contributor

@alexwlchan have we just rebased over each other? 😬

@alexwlchan
Copy link
Contributor Author

alexwlchan commented Feb 5, 2024

@jamieparkinson That seems unlikely, given I haven't touched this repo in months! I am still getting the odd GitHub notification for issues/PRs that I opened and haven't unsubscribed from yet, but I'm not pushing code (and don't think I should be able to?!).

Whatever mess is going on here is somebody else's fault 😜

And I'm not actually requesting a review 👻 but I guess GitHub is telling you I am because I "own" the pull request? Very spooky!

[Confirmed, GitHub blocks me from pushing new branches!]

@paul-butcher paul-butcher merged commit b75594c into main Feb 5, 2024
1 check passed
@jamieparkinson
Copy link
Contributor

Aha - I've caused my own issues then! Very odd, anyway, as you were!

@paul-butcher paul-butcher deleted the items-apis-documentation branch February 5, 2024 16:08
@alexwlchan
Copy link
Contributor Author

*retreats back into fog and darkness*

@alexwlchan
Copy link
Contributor Author

But yay for finally getting this merged!

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.

9 participants