Skip to content

Conversation

@bcbogdan
Copy link

@bcbogdan bcbogdan commented Aug 25, 2025

Summary
The following PR improves the explanations for each endpoint in order to make the spec easier to understand for the end user.
The following changes have been added:

  • Tenant ID parameter format was changed from <tenantId>, to {tenantId}, in description and all URL paths. Same for appId
    This was done to have consistency in how we present path parameters in our documentation.
  • Summary fields have been added on all the endpoints
  • Each. response schema now has a title and a description
  • The apikey header is now included in the security configuration. This is required so that the API docs properly display the authentication requirements for each request.

@bcbogdan bcbogdan requested a review from porcellus September 3, 2025 13:19
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