Fix general structure - Githubissues

riboseinc / ribose-api

API for Ribose

0 stars 0 forks source link

Fix general structure #21

Closed ribose-jeffreylau closed 6 years ago

ribose-jeffreylau commented 6 years ago

This PR aims to fix several problems introduced in recent commits, namely, it:

uses the 'unix' line endings instead of 'dos'
moves common_ds.apib back to the top section to bring back Data Structures
uses the Group directive for each section
uses 4-space indentation as per convention
uses Request heading explicitly
uses the correct syntax for API blueprint for specifying URL parameters
doesn't confound URL parameters with request attributes
extracts File and FileVersion data structures for DRYing purposes
fixes structure for nested request attributes
uses the more specific data types for object IDs, datetime strings, enums, etc.
aligns File API documentation to the one in the riboseinc Github wiki