Add events endpoint documentation #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -1,6 +1,6 @@ | |||
| # 1. Exploring Wellcome Collection's APIs | |||
|
|
|||
| [View on GitHub](https://github.com/wellcomecollection/developers.wellcomecollection.org/blob/main/notebooks/01-exploring-wellcome-collections-apis.ipynb) | [Run in Google Colab](https://colab.research.google.com/github/wellcomecollection/developers.wellcomecollection.org/blob/main/notebooks/01-exploring-wellcome-collections-apis.ipynb) | |||
| [View on GitHub](https://github.com/wellcomecollection/developers.wellcomecollection.org/blob/add-events/notebooks/01-exploring-wellcome-collections-apis.ipynb) | [Run in Google Colab](https://colab.research.google.com/github/wellcomecollection/developers.wellcomecollection.org/blob/add-events/notebooks/01-exploring-wellcome-collections-apis.ipynb) | |||
There was a problem hiding this comment.
I don't get why these have all been changed from main to add-events?
There was a problem hiding this comment.
This repo always makes changes in its PRs to change the internal links to match the branch, so you can navigate within it. They change it back when you merge. I haven't touched those files!
davidpmccormick
approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
wellcomecollection/content-api#124
Long overdue documentation for the events endpoints!
I also added
uidto articles' since we added it in recently.I did my best in my first go at using this language/tool, so let me know if you spot anything!
Note
This repo always makes changes in its PRs to change the internal links to match the branch. But I've personally only touched
reference/content.yml, so ignore the other files.How to test
You can run this locally with
yarn start, and consult the new docs!How can we measure success?
It's up to date and useful for anyone we might onboard.
Have we considered potential risks?
N/A