docs: Updated spell schema's damage property #344
Merged
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
bagelbits
reviewed
Dec 24, 2022
src/swagger/schemas/common.yml
Outdated
Comment on lines
260
to
279
| damage-at-character-level-model: | ||
| description: | | ||
| 'Spell Damage' | ||
| type: object | ||
| properties: | ||
| damage_at_character_level: | ||
| type: object | ||
| additionalProperties: true | ||
| damage_type: | ||
| $ref: './combined.yml#/APIReference' | ||
| damage-at-slot-level-model: | ||
| description: | | ||
| 'Spell Damage' | ||
| type: object | ||
| properties: | ||
| damage_at_slot_level: | ||
| type: object | ||
| additionalProperties: true | ||
| damage_type: | ||
| $ref: './combined.yml#/APIReference' |
There was a problem hiding this comment.
Can you put these in spell.yml for now? I don't think these shapes get used outside of Spells for right now.
bagelbits
reviewed
Dec 24, 2022
src/swagger/swagger.yml
Outdated
| @@ -323,3 +323,5 @@ components: | |||
|
|
|||
| schemas: | |||
| $ref: './schemas/combined.yml' | |||
|
|
|||
|
|
|||
Co-authored-by: Chris Ward <[email protected]>
bagelbits
reviewed
Dec 29, 2022
bagelbits
approved these changes
Dec 29, 2022
bagelbits
changed the title
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
What does this do?
Spell damage schema models added to common.yml file allow for more accurate spell damage schema.
How was it tested?
Followed swagger README instructions to set up local development environment which ran successfully after adding new openapi documentation. Then validated and bundled swagger with no errors. Then manually tested various http requests on Postman successfully.
Is there a Github issue this is resolving?
Yes. This resolves issue #289.
Was any impacted documentation updated to reflect this change?
The changes were made exclusively to the api documentation.
Here's a fun image for your troubles