Skip to content

[Schema Inaccuracy] Example and schema mismatch for #/paths/~1search~1issues/get #6233

@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the JSON ref for the example

#/components/examples/issue-search-result-item-paginated-lexical-fallback/value

Schema and example mismatch. items is supposed to be of type #/components/schemas/issue-search-result-item but the example contains a String with ellipsis.

Here's a snippet

    1: {
    2:   "incomplete_results" : false,
>   3:   "items" : [ "..." ],
    4:   "lexical_fallback_reason" : [ "quoted_text" ],
    5:   "search_type" : "lexical",
    6:   "total_count" : 280
    7: }

Affected Schema Refs

#/paths/~1search~1issues/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18
  • ghes-3.19
  • ghes-3.20

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions