[Schema Inaccuracy] date fields missing date-time format

Open
#4,697 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start with the OpenAPI schema entries at the paths listed in the issue, and compare their date properties with nearby fields that already use the date-time format. Update each listed date field consistently, then validate the API description to confirm all nine locations expose the expected format.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

The following fields are named date, but only have "type": "string". I believe they should also have the date-time format.

paths."/repos/{owner}/{repo}/contents/{path}".put.requestBody.content."application/json".schema.properties.committer.properties.date
paths."/repos/{owner}/{repo}/contents/{path}".put.requestBody.content."application/json".schema.properties.author.properties.date
components.schemas.billing-usage-report.properties.usageItems.items.properties.date
components.schemas.nullable-git-user.properties.date
components.schemas.file-commit.properties.commit.properties.author.properties.date
components.schemas.file-commit.properties.commit.properties.committer.properties.date
components.schemas.git-tag.properties.tagger.properties.date
components.schemas.webhook-status.properties.commit.properties.commit.properties.author.allOf.1.properties.date
components.schemas.webhook-status.properties.commit.properties.commit.properties.committer.allOf.1.properties.date

Expected

format should be set to date-time

Reproduction Steps

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.