CASMCMS-8798: Update BOS API spec to reflect internal change to all v2-compatible session templates #211
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsollom-hpe
approved these changes
Sep 12, 2023
…2-compatible session templates
mharding-hpe
force-pushed
the
CASMCMS-8798
branch
from
7071d46 to
12d4067
Compare
…emplates from v1 to v2
CASMCMS-8799: Create v2-compatible session templates with v1 endpoint
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary and Scope
We have decided to change BOS in CSM 1.5 so that even when using the v1 endpoint to create session templates, BOS will always create a v2-compatible session template.
CASMCMS-8797 modified the v1 session template template endpoint so that it returns a v2-compatible template.
This PR updates the API spec to reflect the fact that BOS will never return to the user a v1-format session template. It will still allow them to be created, but all session templates it outputs will be v2-compatible.
This PR does not change BOS itself to do this – that is being done with this PR. Thus I do not plan to merge this PR until that one is also approved.
None of the schemas that I removed in this PR are used in the BOS source code. I ran the updated API spec through an OpenAPI schema validator and it reported no errors.