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.

Sign up for GitHub

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

Jump to bottom

[Schema Inaccuracy] "Content Tree" content is a required property, but is unlisted #3974

Closed
orange-buffalo opened this issue Sep 16, 2024 · 1 comment
Closed

[Schema Inaccuracy] "Content Tree" content is a required property, but is unlisted #3974

orange-buffalo opened this issue Sep 16, 2024 · 1 comment
Labels
documentation inaccuracy rest-schema

Comments

@orange-buffalo
Copy link

Schema Inaccuracy

The "Content Tree" object lists content as a required property, but doesn't list the content property itself.

"content-tree": {
        "title": "Content Tree",
        "description": "Content Tree",
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "sha": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "git_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "html_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "download_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "entries": {
            ...
            }
          },
          "_links": {
            ...
        },
        "required": [
          "_links",
          "git_url",
          "html_url",
          "download_url",
          "name",
          "path",
          "sha",
          "size",
          "type",
          "url",
          "content",
          "encoding"
        ]
      },

Expected

content property is in the list of properties of content-tree.

Reproduction Steps

See OpenAPI JSON spec in this repository.
@vaindil
Copy link

vaindil commented Sep 24, 2024

Thanks for this report! I fixed up that schema, the content property has been added to the root of that schema and removed from the required list, along with a couple of other tweaks.

@vaindil vaindil closed this as completed Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation inaccuracy rest-schema
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@shiftkey @vaindil @orange-buffalo