{"id":20770622,"url":"https://github.com/ably/open-specs","last_synced_at":"2025-12-25T07:28:48.851Z","repository":{"id":40672863,"uuid":"188071998","full_name":"ably/open-specs","owner":"ably","description":"Descriptions for all Open Specifications available for Ably","archived":false,"fork":false,"pushed_at":"2024-08-23T15:39:44.000Z","size":758,"stargazers_count":6,"open_issues_count":7,"forks_count":4,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-01-18T07:11:59.270Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/ably.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-22T16:04:03.000Z","updated_at":"2024-11-13T13:28:58.000Z","dependencies_parsed_at":"2024-02-28T15:51:16.132Z","dependency_job_id":"48c76114-a96d-4bf0-a4ab-5be24d51be52","html_url":"https://github.com/ably/open-specs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fopen-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fopen-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fopen-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ably%2Fopen-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ably","download_url":"https://codeload.github.com/ably/open-specs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243104204,"owners_count":20236943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-17T12:10:58.765Z","updated_at":"2025-12-25T07:28:43.799Z","avatar_url":"https://github.com/ably.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ably OpenAPI documents\n\n\u003e [!IMPORTANT]\n\u003e The specs in this repository are deprecated in favor of those found in the [Ably docs](https://github.com/ably/docs/tree/main/static/open-specs) repository as of August 2024.\n\nThis repository contains [OpenAPI Specification v3](https://swagger.io/specification/) documents for the following Ably REST APIs:\n\n- Platform API\n- Control API\n\n## Versions\n\nEach OpenAPI document file name contains a version number. If a change is made that is breaking (that is, not backwards-compatible) Ably will create a new OpenAPI document. For example, Control API version one is in `control-v1.yaml`, but version two would be in `control-v2.yaml`. When you are viewing the contents of this repository locally, the latest version is displayed by default. To view older versions of the API reference, modify the files in the `openapi` folder to point to the version of the document that you would like to view.\n\n## Installation\n\nThe following command installs the requirements (currently, only `http-server`):\n\n```\nnpm install\n```\n\n## Viewing the API reference locally\n\nTo View the API reference locally, run:\n\n```\nnpm start\n```\n\nPoint your browser at http://localhost:8080. You can then select the API reference of your choice, rendered by [Redoc](https://github.com/Redocly/redoc).\n\n## Validating the OpenAPI documents with Spectral\n\nYou can validate the OpenAPI documents with [Spectral](https://github.com/stoplightio/spectral).\n\nTo install Spectral:\n\n```\nnpm install -g @stoplight/spectral\n```\n\nOr using Yarn:\n\n```\nyarn global add @stoplight/spectral\n```\n\nYou can then validate your OpenAPI document as required. For example, on the command-line enter:\n\n```\nspectral lint control-v1.yaml\n```\n\nSpectral then lists any issues with the document.\n\n## Quickstart\n\nYou can see the [quickstart guide](quickstart.md) in this repository, or refer to the [main documentation](https://ably.com/documentation).\n\nA quick example request using Curl is shown here:\n\n```\ncurl \"https://control.ably.net/v1/accounts/\u003cACCOUNT_ID\u003e/apps\" \\\n     --header \"Authorization: Bearer \u003cACCESS_TOKEN\u003e\" \\\n     --header \"Accept: application/json\"\n```\n\n1. Copy and paste your [account ID](https://ably.com/documentation/control-api#account-id) to `\u003cACCOUNT_ID\u003e`.\n2. Copy and paste your [access token](https://ably.com/documentation/control-api#authentication) to `\u003cACCESS_TOKEN\u003e`.\n\nRun the Curl command in your shell. You will receive back a list of your Ably applications.\n\n## About Ably\n\n[Ably](https://ably.com) is a pub/sub messaging platform with a suite of integrated services to deliver realtime experiences such as interactive learning, logistics GPS tracking, and live sports updates.\n\nFind out more about at [ably.com](https://ably.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fopen-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fably%2Fopen-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fably%2Fopen-specs/lists"}