Repository navigation
Admin REST API v2
#8983
Replies: 3 comments 1 reply
|
Let's start by creating a OpenAPI specification. We could generate clients and server code based on this. Maybe we could start with using something like https://studio.apicur.io/ to create a design? |
0 replies
This comment was marked as off-topic.
This comment was marked as off-topic.
|
A description about how Paging mechanism is completely missing in the admin REST API docs. E.g. The number of results for getting list of users is limited by default top 100. The doc is mentioning |
1 reply
|
Yes, this is a big problem we need to address in v2. The current API doesn't even implement paging the same way consistently across endpoints. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
The current Admin REST APIs are not very user friendly, and poorly documented. There are a number of issues with the APIs that require breaking changes, such as:
The REST API documentation is also lacking in quite a lot of aspects, and there's also lack of an OpenAPI specification.
We really should complete the REST API guidelines we started on, to make sure we have consistency throughout all REST APIs we offer (excluding of course OIDC and SAML, and other spec based APIs). This should be covered in #8499
Then we should break the Admin API into multiple smaller APIs such as:
These smaller APIs can be implemented and versioned separately.
All reactions