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

Feature/SK-687 | Fedn API v1 #532

Merged
merged 70 commits into from
Feb 29, 2024
Merged

Feature/SK-687 | Fedn API v1 #532

merged 70 commits into from
Feb 29, 2024

Conversation

niklastheman
Copy link
Contributor

@niklastheman niklastheman commented Feb 21, 2024

Fedn API v1

New /api/v1 endpoints added along with a Swagger api UI.

  • New endpoints added in separate files based on the entity they handle
  • New "stores" added in separate files base on the entity they handle
    • All stores derive from the same parent class (Store). This way most db operations are harmonised regardless of the entity.

Endpoints added

  • Clients (/api/v1/clients)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Combiners (/api/v1/combiners)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Models (/api/v1/models)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
    • GET /str:id/ancestors - list
    • GET /str:id/descendants - list
  • Packages (/api/v1/packages)

    • GET / - list, filer by url params
    • GET /active - object
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Rounds (/api/v1/rounds)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Statuses (/api/v1/statuses)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Validations (/api/v1/validations)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object
  • Sessions (/api/v1/sessions)

    • GET / - list, filer by url params
    • GET /count - count, filter by url params
    • POST /count - count, filter by body params
    • POST /list - list, filter by body params
    • GET /str:id - object

Image of Swagger UI:

Screenshot 2024-02-21 at 14 51 42

@niklastheman niklastheman merged commit d4c5949 into master Feb 29, 2024
15 checks passed
@niklastheman niklastheman deleted the feature/SK-687 branch February 29, 2024 13:00
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.

2 participants