Document Field.schema

[chtseac]

I have looked in the following places to find information about how to use Field.schema that supposedly replaces Field.description, Field.type, Field.example.

• https://github.com/core-api/python-client/blob/master/coreapi/document.py#L47
• https://github.com/core-api/python-client/blob/master/docs/api-guide/document.md#link
• https://github.com/core-api/python-client/blob/master/docs/api-guide/document.md#field
• https://github.com/core-api/python-client/blob/master/docs/api-guide/transports.md#making-requests
• https://github.com/core-api/core-api/#links
• http://www.coreapi.org/specification/document/#the-document-primitives
• https://github.com/core-api/python-client/blob/master/tests/test_document.py

Am I missing something or is the documentation just not written yet?

[chtseac]

@tomchristie Can you shred some light on this? I really want to use rest-framework's default documentation page and I do not want to find ways around the immutable to inject my own data structures.

[pasevin]

coreapi.Field(
 "field",
 required=False,
 location="query",
 schema=coreschema.String(
 description="Which fields to return (e.g. field=id will only return ids)",
 title="Field",
 ),
 ),

based on: https://github.com/core-api/python-coreschema/blob/master/coreschema/schemas.py

[chtseac]

So that's exactly the problem. There is 4 occurrences to the coreschema module in the entire codebase and there is no usage example anywhere in this repository.

https://github.com/core-api/python-client/search?q=coreschema