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

Sublinks Native API #119

Open
jgrim opened this issue Dec 21, 2023 · 0 comments · May be fixed by #359
Open

Sublinks Native API #119

jgrim opened this issue Dec 21, 2023 · 0 comments · May be fixed by #359
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jgrim
Copy link
Member

jgrim commented Dec 21, 2023

Create basic CRUD restful endpoints for the core entities:

  1. Announcements
  2. Comments
  3. Communities
  4. Instances
  5. People
  6. Posts
  7. PrivateMessages

This means each resource will have a POST, PUT, GET support in the following format:
Create: POST /api/v1/{resource}
Read: GET /api/v1/{resource} & GET /api/v1/{resource}/{id}
Update: PUT /api/v1/{resource}/{id}
Delete: DELETE /api/v1/{resource}/{id}

Do not create and RPC endpoints. For example, instead of adding a moderator to a communtiy like this: POST /api/v1/community/sublinks/addModerator do it like this: POST /api/v1/community/sublinks/moderator. Then create a new Controller for moderators with CRUD actions to create, read, update, and delete moderators from a community. An update for example could change the sort order of moderators.

@jgrim jgrim converted this from a draft issue Dec 21, 2023
@jgrim jgrim self-assigned this Dec 21, 2023
@jgrim jgrim added this to the Version 0.1 - Parity milestone Dec 21, 2023
@jgrim jgrim added the documentation Improvements or additions to documentation label Apr 14, 2024
@jgrim jgrim assigned Pdzly and unassigned jgrim Apr 23, 2024
@Pdzly Pdzly linked a pull request Apr 24, 2024 that will close this issue
@jgrim jgrim linked a pull request May 12, 2024 that will close this issue
@ericjmorey ericjmorey moved this from 🏗 In progress to 👀 In review in Sublinks Development Jul 24, 2024
@lazyguru lazyguru moved this from 👀 In review to 🏗 In progress in Sublinks Development Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🏗 In progress
Development

Successfully merging a pull request may close this issue.

2 participants