Skip to content

Encoding Object examples have invalid schema property #3170

Closed

Description

@jeremyfiel

Reviewing the Encoding Object Examples

The keyword type should be $ref.

         addresses:
            # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example)
            type: array
            items:
              type: '#/components/schemas/Address'

Activity

  1. jeremyfiel commented on Feb 24, 2023

    @jeremyfiel
    ContributorAuthor

    I noticed 3.1.0 has a slightly different schema, albeit, valid. Lmk if you want that updated too.

              addresses:
                # default Content-Type for arrays is based on the _inner_ type (object shown, so `application/json` in this example)
                type: array
                items:
                  type: object
                  $ref: '#/components/schemas/Address'

    cc @handrews let me know if this should be fixed too.

  2. handrews commented on Mar 1, 2023

    @handrews
    Member

    @jeremyfiel I'm not sure what would need to be fixed in the 3.1 schema? I might be missing something.

  3. jeremyfiel commented on Mar 1, 2023

    @jeremyfiel
    ContributorAuthor
  4. handrews commented on Mar 2, 2023

    @handrews
    Member

    @jeremyfiel I suspect I put it in there just to emphasize that you can put things next to $ref now :-) I don't much care one way or the other, but I think that's why it's like that.

  5. jeremyfiel commented on Mar 2, 2023

    @jeremyfiel
    ContributorAuthor

    i'm impartial.

  6. handrews commented on Mar 5, 2023

    @handrews
    Member

    Let's leave it as-is and just fix it for 3.0.4.

  7. handrews commented on Apr 24, 2023

    @handrews
    Member

    This has been fixed in 3.0.4 and we decided not to change it in 3.1.1.

  8. added this to the v3.0.4 milestone on Jan 27, 2024
  9. added
    media and encodingIssues regarding media type support and how to encode data (outside of query/path params)
    on May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugmedia and encodingIssues regarding media type support and how to encode data (outside of query/path params)

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions