Project

General

Profile

Actions

Bug #19795

open

API discovery document uses unrecognized type names

Added by Brett Smith about 2 years ago. Updated 10 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
API
Target version:
Story points:
-
Release:
Release relationship:
Auto

Description

google-api-python-client uses the discovery document to generate docstrings for its methods. In particular, it documents all the keys that can appear in the returned object, and their corresponding types. Here's an excerpt of the return type documentation from arvados.api('v1').users().create.__doc__:

    Returns:
      An object of the form:

        { # User
        …      
        "email": "A String",
        "first_name": "A String",
        "last_name": "A String",
        "identity_url": "A String",
        "is_admin": True or False,
        "prefs":   Unknown type! Hash

        "updated_at":   Unknown type! datetime
        …
      }

The "Unknown type!" errors appear because our discovery document lists types that are not supported by the format.

  • type: Hash should be type: object
  • type: datetime should be type: string, format: date-time

Cleaning these up would provide better documentation and compatibility with other client libraries… assuming it doesn't break anything. Obviously we'd want to be careful to run the full test suite after making this change.

Actions #1

Updated by Peter Amstutz almost 2 years ago

  • Release set to 60
Actions #2

Updated by Peter Amstutz 10 months ago

  • Target version set to Future
Actions

Also available in: Atom PDF