Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Schema Inaccuracy] Example and schema mismatch at patch-schema #4470

Open
rahulsom opened this issue Jan 26, 2025 · 1 comment
Open

[Schema Inaccuracy] Example and schema mismatch at patch-schema #4470

rahulsom opened this issue Jan 26, 2025 · 1 comment

Comments

@rahulsom
Copy link

rahulsom commented Jan 26, 2025

Schema Inaccuracy

The schema at this location is

#/components/schemas/patch-schema/properties/Operations/items/properties/value
                "value": {
                  "type": "string",
                  "description": "Corresponding 'value' of that field specified by 'path'"
                }

The example at is

#/paths/~1scim~1v2~1enterprises~1{enterprise}~1Groups~1{scim_group_id}/patch/requestBody/content/application~1json/examples/addMembers/value
          {
            "Operations" : [ {
              "op" : "add",
              "path" : "members",
              "value" : [ {
                "value" : "879db59-3bdf-4490-ad68-ab880a2694745"
              }, {
                "value" : "0db508eb-91e2-46e4-809c-30dcbda0c685"
              } ]
            } ],
            "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
          }

The value cannot be parsed.

Expected

Either the example or schema is updated to match the other.

Reproduction Steps

This has been observed on

https://github.com/github/rest-api-description/raw/main/descriptions-next/ghes-3.13/ghes-3.13.json

I've checked for this in 3.10, 3.11, 3.12, 3.13, 3.14.

@shiftkey
Copy link
Member

shiftkey commented Feb 3, 2025

Thanks for the report @rahulsom! I've forwarded this to the team that maintains this part of the REST API, and they'll reach out if they have any further questions...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants