{"id":22302619,"url":"https://github.com/dataoneorg/api-documentation","last_synced_at":"2026-03-01T01:33:35.636Z","repository":{"id":56151812,"uuid":"156448835","full_name":"DataONEorg/api-documentation","owner":"DataONEorg","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-08T07:42:35.000Z","size":59074,"stargazers_count":3,"open_issues_count":14,"forks_count":1,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-09-04T02:44:02.742Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DataONEorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-06T21:15:49.000Z","updated_at":"2024-05-09T16:07:33.000Z","dependencies_parsed_at":"2023-01-25T09:01:14.549Z","dependency_job_id":null,"html_url":"https://github.com/DataONEorg/api-documentation","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/DataONEorg/api-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Fapi-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Fapi-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Fapi-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Fapi-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DataONEorg","download_url":"https://codeload.github.com/DataONEorg/api-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Fapi-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29957377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T22:53:01.873Z","status":"ssl_error","status_checked_at":"2026-02-28T22:52:50.699Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation"],"created_at":"2024-12-03T18:40:15.454Z","updated_at":"2026-03-01T01:33:35.593Z","avatar_url":"https://github.com/DataONEorg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Architecture Docs\n\n![Build Pages](https://github.com/DataONEorg/api-documentation/workflows/Build%20Pages/badge.svg)\n\nAPI and Architecture documentation for DataONE.\n\nThis is a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) \nproject that provides documentation for the DataONE\nCoordinating Node and Member Node (i.e. repository) service interfaces. \nVarious design documents are included for additional information.\n\nThe current released version of the documentation is available at:\n\n  https://purl.dataone.org/architecture\n\nOr:\n\n  https://dataoneorg.github.io/api-documentation/\n\n\n## Contributing\n\nThese documents are built automatically after the GitHub repository is updated\nwith a push to master. See the [GitHub Action work flow](https://github.com/DataONEorg/api-documentation/blob/master/.github/workflows/gh-pages.yml) for more details\n\nMinor edits can be made through the GitHub editor interface or through\nthe usual clone / fork, edit, commit, and push / pull-request process.\n\nMost of the source documents are composed in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html). \n\nThe APIs are documented with mock Python methods documented using \nGoogle docstring formatting. After editing and commiting changes to \nthose files, the changes will be reflected in the API docs through the\nvarious sphinx `auto*` directives. \n\n## Building\n\nThis project uses [Poetry](https://python-poetry.org/docs/) for dependency management. \n\n```\ngit clone https://github.com/DataONEorg/api-documentation.git\ncd api-documentation\npoetry install\nmake html\n```\n\nThe generated HTML will be available at `build/html/index.html`\n\nLive generation and reload is also available:\n\n```\nmake livehtml\n```\n\nA local web server will make the pages available at http://localhost:8000/ and edits to the source will be automatically rendered in the browser.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataoneorg%2Fapi-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdataoneorg%2Fapi-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataoneorg%2Fapi-documentation/lists"}