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

Create Announcements Endpoints #47

Open
4 tasks
ben9583 opened this issue Oct 10, 2023 · 0 comments
Open
4 tasks

Create Announcements Endpoints #47

ben9583 opened this issue Oct 10, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@ben9583
Copy link
Member

ben9583 commented Oct 10, 2023

We should the following endpoints for announcements:

  • /announcements/metadata/{id}: Gets the metadata for the announcement id (date, title, blurb)
  • /announcements/get/{id}: Gets the markdown content for the announcement id
  • /announcements/last: Returns the ID of the most recent announcement
  • /announcements/last/{num}: Returns the sorted IDs of the num most recent announcements (must cap num to something)

The API should make use an ocflib backend tool to get this information, rather than directly obtaining the information from the repository itself. These functions should essentially just be interfaces for the respective ocflib functions that get this information (maybe /last can use the same ocflib method as /last/{num}, but withnum = 1). It should be assumed that ocflib implements an appropriate caching strategy.

@ben9583 ben9583 added the enhancement New feature or request label Oct 10, 2023
@ben9583 ben9583 added this to the Announcements API milestone Oct 10, 2023
@vicshi06 vicshi06 self-assigned this Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants