Add support for multipart HTTP request bodies #514
Merged
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.
Bug/issue #, if applicable: rdar://106389324
Summary
Introduce new "HTTPBodyParameter(s)" tags for ListItemExtractor to identify documentation for the parameters that make up a multipart (or URL-encoded) form. These are then merged with symbol graph data wherein each parameter is related to the owning HTTPBody entity via a
memberOf
oroptionalMemberOf
relationship.Dependencies
None.
Testing
Use as a starting point the HTTPRequests.docc fixture, which contains a "CreateArtist.md" file to document the
artist
anduserName
body parameters defined in the symbol graph.Steps:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded