Skip to content
This repository has been archived by the owner on Mar 18, 2019. It is now read-only.

Field parameters not in spec #134

Open
carltongibson opened this issue May 20, 2017 · 1 comment
Open

Field parameters not in spec #134

carltongibson opened this issue May 20, 2017 · 1 comment

Comments

@carltongibson
Copy link

carltongibson commented May 20, 2017

From the source:

# The field class, as used by Link objects:

# NOTE: 'type', 'description' and 'example' are now deprecated,
#       in favor of 'schema'.
Field = namedtuple('Field', ['name', 'required', 'location', 'schema', 'description', 'type', 'example'])

But the spec for Link Parameters (which are the same thing as Field here right?) doesn't mention anything beyond 'name', 'required', and 'location'.

Q: What's the format of the schema parameter? Is this documented?

Thanks.

UPDATE: Looking further, other fields don't match either. e.g. Link has encoding, title, description which aren't in the spec either. What's canonical here?

@tomchristie
Copy link
Contributor

We'll want to revisit all the docs for 3.0

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

No branches or pull requests

2 participants