api: Document /realm/presence API endpoint. #22509
Closed
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
akashaviator
force-pushed
the
realm_presence
branch
from
7f9760f
to
d0573e8
Compare
akashaviator
force-pushed
the
realm_presence
branch
6 times, most recently
from
496cb66
to
e96892c
Compare
akashaviator
changed the title
akashaviator
force-pushed
the
realm_presence
branch
3 times, most recently
from
bf875ee
to
ec2cf18
Compare
akashaviator
changed the title
akashaviator
force-pushed
the
realm_presence
branch
from
ec2cf18
to
121feb4
Compare
akashaviator
changed the title
`render_table` calls itself recursively when it finds nested `additionalProperties` (i.e. nested objects) in response schema, to render their properties. This fixes `render_table` to call `render_desc` along with calling itself, to render the description of the nested `additionalProperties` as well.
akashaviator
force-pushed
the
realm_presence
branch
from
121feb4
to
7048a12
Compare
12 tasks
laurynmm
reviewed
Aug 1, 2022
There was a problem hiding this comment.
@akashaviator - In general, this all looks good to me. I did notice that the aggregated key for the presence objects wasn't being documented, which led me to look at the other places that presence is documented.
And I found a bunch of interrelated things to fix, so I put up an updated version of this PR with those changes (#22641). Would you be up for looking at those updates / changes?
|
Closing in favor of #22641, huge thanks for documenting this @akashaviator! |
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.
This documents the
/realm/presenceAPI endpoint and fixes a bug inrender_tablethat causes the description of nested objects in the response schema to not get rendered.