Name: developer.osf.io
Owner: Center for Open Science
Description: Documentation for the OSF APIv2
Created: 2017-12-27 17:54:54.0
Updated: 2018-04-29 14:58:32.0
Pushed: 2018-04-30 21:37:51.0
Homepage: https://developer.osf.io
Size: 344
Language: HTML
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
The Open API specification for the Open Science Framework API lives here. The developer documentation is generated from this specification by ReDoc.
swagger-spec/swagger.yaml
and contains references to many YAML files in the swagger-spec
directory.swagger.yaml
file should be kept as minimal as possible, meaning $refs
to other YAML files should be utilized over inline endpoint and model definitions.swagger-spec
directory (i.e., swagger-spec/preprints/
), with each unique API endpoint having it's own YAML file (i.e., detail.yaml
and list.yaml
for /preprints/
and /preprints/{preprint_id}/
, respectively).yarn
(Note that if you have brew upgrade
d recently, you'll have to use yarn --python python2
here.)yarn run build
(spec validation)yarn run serve
(serves at localhost:8080)yarn run watch
(serves at localhost:8080 with livereload) run build
run serve