[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1orgs~1{org}~1artifacts~1{subject_digest}~1metadata~1deployment-records/get`

Open
#5,683 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Start with the example ref #/components/examples/artifact-deployment-record-list/value and compare it with the schemas for the three affected path refs listed in the issue. Check the created and created_at fields, then align the example and schema so all affected references describe the same field and confirm the mismatch is resolved.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/artifact-deployment-record-list/value

The field created doesn't exist in the schema, but exists in the example. This looks like a typo. There is a field called created_at.

Here's a snippet

    8:     "deployment_name" : "prod-deployment",
    9:     "tags" : {
   10:       "data" : "sensitive"
   11:     },
>  12:     "created" : "2011-01-26T19:14:43Z",
   13:     "updated_at" : "2011-01-26T19:14:43Z",
   14:     "attestation_id" : 456
   15:   } ],
   16:   "total_count" : 1

Affected Schema Refs

#/paths/~1orgs~1{org}~1artifacts~1{subject_digest}~1metadata~1deployment-records/get
#/paths/~1orgs~1{org}~1artifacts~1metadata~1deployment-record/post
#/paths/~1orgs~1{org}~1artifacts~1metadata~1deployment-record~1cluster~1{cluster}/post

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
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.