Skip to content

v3.2: Ordered multipart examples #4746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: v3.2-dev
Choose a base branch
from

Conversation

handrews
Copy link
Member

@handrews handrews commented Jun 21, 2025

These are the examples that go with PRs #4745 and #4744.

This includes the recently (this past week) updated multipart/related example that was provoking a lot of discussion. Otherwise, the examples are the same as in the old PR #4589.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

@handrews handrews added this to the v3.2.0 milestone Jun 21, 2025
@handrews handrews added the media and encoding Issues regarding media type support and how to encode data (outside of query/path params) label Jun 21, 2025
@handrews handrews requested review from a team as code owners June 21, 2025 01:21
Copy link
Contributor

@miqui miqui left a comment

Choose a reason for hiding this comment

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

@handrews looks good other than the minor typo

Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

+1, minor nits

@handrews
Copy link
Member Author

@ralfhandl @miqui I have updated the above and will mark them resolved to reduce noise when we look at this in the call, but here is a summary:

  • I removed the whitespace in contentType and filed issue v3.x: Does the Encoding Object's contentType allow whitespace around commas? #4788 to track if we should say something about it. The no-whitespace version is definitely valid so we'll go with that here
  • The "page" vs "pages" was a bit of a mess as I was allowing additional text/html resources, so I changed that and reworded things a bit to make it clear that this example is for a single page, even if you could also do a linked set of pages
  • I changed the ref name to RFC2557NoContentId which makes it easier for me to parse- it took me a minute to realize what I'd been doing there with the other name. The referenced schema is the same- I don't actually know any other way to forbid a header except with not: {} which is 😵‍💫

required: true
content:
text/plain:
schema:
Copy link
Contributor

Choose a reason for hiding this comment

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

@handrews a note to review the wording here, and consider if we need both this example and the one above

@lornajane
Copy link
Contributor

We discussed the media range in the multipart/related example - the type param is actually required so we agreed to keep it in the example this time.

@lornajane lornajane requested review from lornajane, ralfhandl, miqui and a team July 17, 2025 16:55
ralfhandl
ralfhandl previously approved these changes Jul 18, 2025
@ralfhandl ralfhandl requested a review from a team July 18, 2025 07:43
ralfhandl
ralfhandl previously approved these changes Jul 19, 2025
@ralfhandl ralfhandl requested a review from a team July 19, 2025 15:06
@handrews
Copy link
Member Author

With (more) apologies to @ralfhandl I rebased to clear conflicts with #4747, in this case it was just that both added new examples in the same place at the end of the section, so now this PR adds them after the old examples but before the nested multipart example. The commits are otherwise identical to before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
media and encoding Issues regarding media type support and how to encode data (outside of query/path params)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants