Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

sra-spec: Clients generated from SRA spec think Network ID is a fractional number #1762

Open
@feuGeneA

Description

Expected Behavior

Clients generated from the SRA spec should use correct data types. Specifically, in the spec, integers should be integer, not number. More specifically, Network ID and pagination values should be integer. (There may be more, but these are what I noticed.)

Current Behavior

Network ID, and pagination values, are currently specified with "schema":{"type":"number",...}.

(There are other parameters in the spec that we correctly denote with {"type":"integer"}.)

Possible Solution

Change integral parameters to be integer rather than number. A quick look at the spec suggests that we should probably should get rid of all instances of "type":"number".

Steps to Reproduce (for bugs)

Generate a client from the spec and look at the types of the parameters. The Python SRA client's generate.sh script may be useful to reproduce the problem.

Context

We generated our Python SRA client from the spec, and the documentation came out describing Network ID and pagination parameters as floats. If we were to generate a client for a more strongly typed language, it would probably be actually broken rather than just having wrong documentation.

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions