Skip to content
This repository has been archived by the owner on Feb 25, 2022. It is now read-only.

API Schemas & client libraries #69

Closed
14 tasks
tomchristie opened this issue Apr 20, 2017 · 1 comment
Closed
14 tasks

API Schemas & client libraries #69

tomchristie opened this issue Apr 20, 2017 · 1 comment
Labels
Baseline feature

Comments

@tomchristie
Copy link
Member

tomchristie commented Apr 20, 2017 •
edited
Loading

Some initial work for this is now in place, but there's plenty more still to do:

  • Add descriptions to fields and links.
  • Support direct usage of QueryParam, RequestData.
  • Include proper type information in the API Schemas.
  • Include response schemas.
  • Allow for API structure, using includes.
  • Allow for eg _id -> id in function arguments, to work around python keyword-clashes.
  • Allow for explicit naming in Route to override automatic function naming.
  • Figure out encodings on links.
  • API Name
  • API Description
  • API Base URL
  • Document usage of client libraries.
  • Figure out naming - APISchema vs schema module.
  • Returning a schema from a view.
@tomchristie tomchristie changed the title Schemas API Schemas Apr 20, 2017
@tomchristie tomchristie changed the title API Schemas API Schemas & client libraries Apr 20, 2017
@tomchristie tomchristie modified the milestone: 0.2 Release Apr 24, 2017
@tomchristie tomchristie mentioned this issue May 3, 2017
Merged
12 tasks
@frankie567 frankie567 mentioned this issue Jul 20, 2017
Merged
tomchristie pushed a commit that referenced this issue Jul 20, 2017
@frankie567 @tomchristie
Add link descriptions in schema (#230)
e9f1a12 
Related to #69: add the ability to describe a Link by providing
a docstring in the view function.
@tomchristie
Copy link
Member Author

We have this now. Still some refinements worth pursuing, but we should tackle anything there as individual issues.

@tomchristie tomchristie removed this from the 0.2 Release milestone Aug 11, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Baseline feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tomchristie