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

docs(template): Document template too large #321

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

SimonRichardson
Copy link

@SimonRichardson SimonRichardson commented May 9, 2022

Changes:

ErrorResponse for /api/v2/template/apply

The following adds documentation about a new feature that issues an
error message if the template is too large. Currently, this targets only
cloud, but we should consider this for OSS. I'll open this up for
discussion, if in doubt I'll move this to cloud only as a divergent API.


  • Fix the bug, that if you have two error codes that have the same body, then it creates a $ref type that prevents it from parsing correctly.

@SimonRichardson SimonRichardson added the documentation Improvements or additions to documentation label May 9, 2022
Changes:

  ErrorResponse for /api/v2/template/apply

The following adds documentation about a new feature that issues an
error message if the template is too large. Currently, this targets only
cloud, but we should consider this for OSS. I'll open this up for
discussion, if in doubt I'll move this to cloud only as a divergent API.
The following just ensures that we don't inline the reference for errors
that have the same body but different error code. This is shame, but I
can see why.

The fix is simple, just create a new template reference that duplicates
the TemplateSummaryError.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant