{"id":15091513,"url":"https://github.com/spraakbanken/sb-api-doc","last_synced_at":"2026-02-24T21:34:00.279Z","repository":{"id":88149729,"uuid":"154642403","full_name":"spraakbanken/sb-api-doc","owner":"spraakbanken","description":"Guidelines for API documentation","archived":false,"fork":false,"pushed_at":"2025-12-03T12:05:43.000Z","size":381,"stargazers_count":2,"open_issues_count":6,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-12-06T15:52:51.993Z","etag":null,"topics":["api-documentation","oas","openapi","redoc","rest-api"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spraakbanken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-10-25T09:12:37.000Z","updated_at":"2025-12-03T12:05:47.000Z","dependencies_parsed_at":"2024-09-09T10:17:00.111Z","dependency_job_id":"6e2a96a0-e19e-42b3-9d41-3893129d7312","html_url":"https://github.com/spraakbanken/sb-api-doc","commit_stats":{"total_commits":74,"total_committers":7,"mean_commits":"10.571428571428571","dds":0.2702702702702703,"last_synced_commit":"6058f9182cc57990a5cd1c7d2b0a2088bea4701d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/spraakbanken/sb-api-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spraakbanken%2Fsb-api-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spraakbanken%2Fsb-api-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spraakbanken%2Fsb-api-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spraakbanken%2Fsb-api-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spraakbanken","download_url":"https://codeload.github.com/spraakbanken/sb-api-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spraakbanken%2Fsb-api-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29801023,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T21:02:39.706Z","status":"ssl_error","status_checked_at":"2026-02-24T21:02:21.834Z","response_time":75,"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":["api-documentation","oas","openapi","redoc","rest-api"],"created_at":"2024-09-25T10:41:31.703Z","updated_at":"2026-02-24T21:34:00.262Z","avatar_url":"https://github.com/spraakbanken.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Documentation at Språkbanken\n\nThe goal of this project is to standardise the documentation of REST APIs at Språkbanken.\n\nThis repository contains:\n\n* guidelines for API documentation\n* a register for Open API Specification files\n* code for generating html documentation from Open API Specification files\n\n## API Documentation Guidelines\n\nPlease check the [guidelines document](guidelines.md) for more information on how to write documentation for\nSpråkbanken's REST APIs.\n\n## Automatic Generation of HTML Documentation\n\nBy registering your Open API Specification (OAS) file in [`oas-register.yaml`](oas-register.yaml) an HTML version of the\ndocumentation will automatically be available on the [SB API documentation portal](https://ws.spraakbanken.gu.se/docs/).\n\nTo register your API documentation please add the following information to [`oas-register.yaml`](oas-register.yaml):\n\n* `name`: The name of your API (used as meta data only).\n* `oas-file`: The URL from where the OAS file can be retrieved. This URL must be accessible from Språkbanken's servers.\n* `path`: The path to your API documentation that will be created automatically. This path should be relative to the [SB\n  API documentation portal](https://ws.spraakbanken.gu.se/docs/). E.g. if the `path` is set to `sparv` the documentation\n  will be available at https://ws.spraakbanken.gu.se/docs/sparv.\n* `description`: A very short description of the API.\n* `favicon`: Optional. A link to the API's favicon.\n\nTo preview your API documentation, you can use the test page available at https://ws.spraakbanken.gu.se/docs/test.\n\n## TODO\n\n* Indexing and search function for all documentations on portal\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspraakbanken%2Fsb-api-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspraakbanken%2Fsb-api-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspraakbanken%2Fsb-api-doc/lists"}