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

Synopackage API v2 #288

Open
14 tasks
szyb opened this issue Mar 31, 2022 · 0 comments
Open
14 tasks

Synopackage API v2 #288

szyb opened this issue Mar 31, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@szyb
Copy link
Owner

szyb commented Mar 31, 2022

Create v2 API that will:

  • remove redundant paths i.e. /api/Changelogs/GetChangelogs -> /api/Changelogs
  • add "v2" in url: i.e. /api/v2/*
  • remove redundant data not displayed on the page. i.e. CustomUserAgent in /api/Sources/GetSource?sourceName=x
  • document OpenAPI for all methods
  • use [Required] & other attributes to validate the input
  • the website will use v2 version
  • Change OpenApi description

Check list: (This list does not include /v2/ in the URL, but it will be)

  • add ApiVersioning

Changelogs

  • /api/Changelogs/GetChangelogs -> /api/Changelogs

Downloads

  • POST /api/Download/DownloadRequest -> POST /api/Download

Models

  • GET /api/Models/GetAll -> /api/Models
  • Remove "family" from the output /api/Models/GetAll
  • GET /api/Models/GetDefaultModel -> /api/Models?default=true

News

  • GET /api/News/GetNews -> /api/News

Packages

  • /api/Packages/GetServerResponse -> /api/Packages

Repository

  • no change except /v2/ in url for GET /api/Repository/info

Sources

  • GET /api/Sources/GetAllSources -> /api/Sources/
  • GET /api/Sources/GetAllActiveSources -> /api/Sources/Active
  • GET /api/Sources/GetSource -> /api/Sources?source=x
  • check where those methods are used in frontend and remove properties that are not used there

Versions

  • GET /api/Versions/GetAll -> /api/Versions
  • GET /api/Versions/GetDefaultVersion -> /api/Versions?default=true
@szyb szyb added the enhancement New feature or request label Mar 31, 2022
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

No branches or pull requests

1 participant