Skip to content

Incorrect field name in example response given for "List items for an organization owned project" API #42983

@GabrielMajeri

Description

@GabrielMajeri

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/projects/items?apiVersion=2022-11-28#list-items-for-an-organization-owned-project

What part(s) of the article would you like to see updated?

The "Example response" for the "List items for an organization owned project" API call indicates that the objects contained with the fields array have a type key (e.g. the response would contain something like "fields": [ { "type": "title", ... }, ... ]):

Image

However, I've used this API and discovered that in practice the type key is called data_type (probably due to the fact that type is a reserved keyword in many programming languages):

Image

The example should be updated to reflect the actual structure of the response object. This could be a problem with the other project items-related APIs as well, but I haven't checked.

Additional information

The "List project fields for organization" example is correct; it uses the data_type key name.

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions