Skip to content

[Schema Inaccuracy] Example and schema mismatch for #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields/get #5600

@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the json ref for the example

#/components/examples/projects-v2-field-items/value

Schema and example mismatch.

Here's a snippet

    5:   "data_type" : "single_select",
    6:   "project_url" : "https://api.github.com/projects/67890",
    7:   "options" : [ {
    8:     "id" : "option_1",
>   9:     "name" : "Low",
   10:     "color" : "GREEN",
   11:     "description" : "Low priority items"
   12:   }, {
   13:     "id" : "option_2",

The definition of name is

          "name": {
            "type": "object",
            "description": "The display name of the option, in raw text and HTML formats.",
            "properties": {
              "raw": {
                "type": "string"
              },
              "html": {
                "type": "string"
              }
            },
            "required": [
              "raw",
              "html"
            ]
          }

This also affects

#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields~1{field_id}/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions