Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Encoding Object content and header clarifications (3.0.4) #3857

Merged
merged 7 commits into from
Jun 12, 2024
Merged

Encoding Object content and header clarifications (3.0.4) #3857

merged 7 commits into from
Jun 12, 2024

Commits on Jun 11, 2024

  1. Encoding Object content and header clarifications 

    The Encoding Object's `contentType` field takes a comma-separated
list of either regular or wildcared media types.  These are the
"two types" mentioned in the previous wording – "two" here did
*not* refer to a limit on the number of entries in the list.

These are not exactly media-type or media-range values, as both
of those include parameters.

This change also moves the hard-to-follow list of default values
out of the individual field cell and into its own table.

It takes `Content-Disposition` out of the header field's cell
and instead explains limitations on header usage, and explains
how `Content-Disposition` is used for encoding.

This explanation includes a suggestion on how other `multipart`
formats could be used with an Encoding Object, since their
unnamed parts otherwise cannot be supported.

Finally, it clarifies the interaction between `contentType`
and the three fields imported from the Parameter Object, by
aligning the recommended (but not, for compatibility reasons,
required) behavior with guidance added in 3.1.0.
    @handrews
    handrews committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    dc41f76 View commit details
    Browse the repository at this point in the history

  2. More detail on correlating properties

    @handrews
    handrews committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    6326993 View commit details
    Browse the repository at this point in the history

  3. Fix typo (review feedback) 

    Co-authored-by: Ralf Handl <ralf.handl@sap.com>
    @handrews @ralfhandl
    handrews and ralfhandl committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    ed03673 View commit details
    Browse the repository at this point in the history

  4. Reword default handling (review feedback) 

    Thanks to @notEthan for the comments!
    @handrews
    handrews committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    328998e View commit details
    Browse the repository at this point in the history

  5. Split up Encoding fields like Param/Header 

    This splits the Encoding Object's fixed fields table
to make the usage more clear, and closer to how it is presented
for the Parameter and Header Objects
    @handrews
    handrews committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    65c2960 View commit details
    Browse the repository at this point in the history

  6. Name the right section matching the link (review feedback) 

    🤦 thanks for catching this, @ralfhandl

Co-authored-by: Ralf Handl <ralf.handl@sap.com>
    @handrews @ralfhandl
    handrews and ralfhandl committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    285b300 View commit details
    Browse the repository at this point in the history

  7. Discuss null values and contentType

    @handrews
    handrews committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    6cefd77 View commit details
    Browse the repository at this point in the history