Move read only property in order to fix Dagrun API docs #30149
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
SamWheating
force-pushed
the
sw-fix-openapi-spec
branch
from
d8f1b6c
to
0adb9b7
Compare
SamWheating
changed the title
SamWheating
force-pushed
the
sw-fix-openapi-spec
branch
from
0adb9b7
to
561c713
Compare
SamWheating
changed the title
|
I think that one looks cool @ephraimbuddy ? |
ephraimbuddy
approved these changes
Mar 21, 2023
Yes. Makes sense. |
pierrejeambrun
pushed a commit
that referenced
this pull request
Mar 23, 2023
(cherry picked from commit e01c146)
pierrejeambrun
changed the title
pierrejeambrun
pushed a commit
that referenced
this pull request
Mar 24, 2023
(cherry picked from commit e01c146)
28 tasks
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.
Closes: #30075
Note: We should either merge this or #30113, but not both.
Using
$refalongside other attributes can lead to unintentional errors in the API documentation (source):Because of this, the
statefield was incorrectly showing up in the API docs for the trigger DagRun endpoint:By instead these attributes under
allOf:, this change removes this field from the docs, making it more consistent with the intended API behaviour:There are a few other instances in the Spec in which $ref is used alongside another attribute which could lead to similar issues, I will fix those in a subsequent PR when I have a bit more time.