box-openapi icon indicating copy to clipboard operation
box-openapi copied to clipboard

Documentation of various types inconsistent with example responses

Open lucastheisen opened this issue 3 years ago • 1 comments

Description of the issue

Currently the documentation for File (base) says id has type string, but the example json shows numeric:

{
  "id": 12345,
  "type": "file",
  "etag": 1,
}

The actual openapi definition also says string. The same stands for etag and other fields throughout the documentation on various types (but have not done a thorough inspection of all the examples).

I am not a Boxer (assuming that means employee of Box).

I would provide a PR if i knew which direction the fix should go in. I imagine its the example that is wrong because the API currently responds with numeric values, but cannot be certain.

Current content

{
  "id": 12345,
  "type": "file",
  "etag": 1,
}

Expected content

{
  "id": "12345",
  "type": "file",
  "etag": "1",
}

lucastheisen avatar Jun 02 '22 21:06 lucastheisen

Additionally, I notice that the Users object says notification_email is an object, but the response i am getting is an array.

lucastheisen avatar Jun 05 '22 16:06 lucastheisen

@lucastheisen - sorry for coming back to you with a delay - we are aware and working on this issue.

bszwarc avatar Feb 13 '23 09:02 bszwarc

This has been fixed - strings are displayed properly.

bszwarc avatar Aug 31 '23 13:08 bszwarc