Allow for more than 3 OAS files in a workspace
closed
Dom DiCicco
With a microservice based API, the 3 OpenAPI Spec file max is a restrictive limitation. We have to merge OAS files in order to meet the max.
The use of multiple workspaces would create a disjointed/unnatural separation of the documentation.
Log In
Shakeer Hussain S
closed
Shakeer Hussain S
Hi All - Thank you for your patience. After thorough consideration and an in-depth operational review, we have decided to maintain our current limit of three OAS files in a standard workspace. This decision is based on our commitment to uphold and ensure the highest levels of system performance and stability for all our users.
We understand that this decision may impact how you manage your API documentation. However, it is crucial for us to ensure that our platform remains reliable and efficient, which ultimately benefits all our customers. An increase in the number of OAS files per workspace could potentially affect these key aspects, and our priority is to provide a service that consistently meets your expectations in terms of performance and reliability.
We are exploring alternative solutions to support your expanding needs and will keep you updated on any new developments in this area. We value your business and are committed to supporting your goals while ensuring the best possible experience with our platform.
Currently, you have the option to acquire an additional API documentation workspace as an add-on, which can include up to three API references within a single workspace.
Thank you for your understanding and continued support.
Einat Mizrahi
Because of this limitation, we decided to go with a different solution for our API docs. We might reconsider if d360 allowed more.
Shakeer Hussain S
under review
Shakeer Hussain S
Hi Dom - Thanks for sharing this request. The restriction is in place to prevent an excessive number of categories and articles within the same workspace, which could have a negative impact on the performance of the knowledge base (KB). Additionally, there is a soft limit set at 1000 categories per workspace and 10000 articles per workspace.
Can you provide an estimate of the number of categories and articles that are typically present in your OAS file? We are reviewing such scenarios and looking for possibilities to overcome this.
Dom DiCicco
Shakeer Hussain S: Hi Shakeer,
Here is a breakdown:
* Between 5 and 10 services, which equates to 5-10 OAS files. (equates to a top level category in Doc360)
** Each second level grouping (equates to a nested 'category' in Doc360) would contain about 5 operations - max would be around 100 categories
*** Each OAS is in the range of 25-50 operations (equates to an 'article' in Doc360) - so the max would be around 500 articles.
We would not be close to the excessive numbers you listed. It seems that the cap would be better served on the number of operations(categories and articles) in a workspace, rather than the number of OAS files allowed to be added.
Shakeer Hussain S
Dom DiCicco: Thank you for providing the details. We will internally review this with our team and keep you informed about the potential solutions.
Dom DiCicco
Shakeer Hussain S: Hi Shakeer, any update on this? Would be happy to be a trial customer which gets a bumped up number of OAS files. We are well under the 10000 articles with all of our OAS files combined.