Skip to content

Conversation

@pdwilson12
Copy link
Contributor

@pdwilson12 pdwilson12 commented Mar 23, 2023

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 or optionalMemberOf relationship.

Dependencies

None.

Testing

Use as a starting point the HTTPRequests.docc fixture, which contains a "CreateArtist.md" file to document the artist and userName body parameters defined in the symbol graph.

Steps:

  1. Build docc and preview the fixture.
  2. Modify the CreateArtist.md file to add/remove HTTPBodyParameter entries and make sure changes get reflected in the rendered page.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

Introduce "HTTPBodyParameter(s)" new tags for ListItemExtractor to identify documentation for the parameters that make up a multipart (or URL-encoded) form.

rdar://106389324
@pdwilson12
Copy link
Contributor Author

@swift-ci please test

Copy link
Contributor

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@pdwilson12
Copy link
Contributor Author

@swift-ci please test

@pdwilson12
Copy link
Contributor Author

@swift-ci please test

@pdwilson12 pdwilson12 merged commit ae6341c into swiftlang:main Mar 27, 2023
@pdwilson12 pdwilson12 deleted the http_multipart_body branch March 27, 2023 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants