{"id":21455515,"url":"https://github.com/hookdeck/hookdeck-api-schema","last_synced_at":"2025-10-12T21:27:33.823Z","repository":{"id":88348341,"uuid":"553220037","full_name":"hookdeck/hookdeck-api-schema","owner":"hookdeck","description":"Hookdeck's API Definition, which is used to generate SDKs.","archived":false,"fork":false,"pushed_at":"2024-10-30T00:10:29.000Z","size":760,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-30T02:48:39.430Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/hookdeck.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":"2022-10-17T22:47:45.000Z","updated_at":"2024-10-10T09:06:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb10470c-1c47-479f-8e41-28e9b94e0430","html_url":"https://github.com/hookdeck/hookdeck-api-schema","commit_stats":null,"previous_names":["hookdeck/hookdeck-api-schema"],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fhookdeck-api-schema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fhookdeck-api-schema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fhookdeck-api-schema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hookdeck%2Fhookdeck-api-schema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hookdeck","download_url":"https://codeload.github.com/hookdeck/hookdeck-api-schema/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226002997,"owners_count":17558157,"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-23T05:12:28.043Z","updated_at":"2025-10-12T21:27:28.772Z","avatar_url":"https://github.com/hookdeck.png","language":"Go","readme":"# Hookdeck OpenAPI Schema\n\nIn addition to the standard uses of OpenAPI schema, the Hookdeck OpenAPI schema is used to generate our SDKS using [Fern](https://www.buildwithfern.com/?ref=hookdeck):\n\n- [Go SDK](https://github.com/hookdeck/hookdeck-go-sdk)\n- [TypeScript SDK](https://github.com/hookdeck/hookdeck-typescript-sdk)\n\n## What is in this repository?\n\nThis repository contains\n\n- Hookdeck's API Definition which lives in the root directory and contains some Fern specific extensions\n- Generators used to generate the SDK (see [generators.yml](./fern/generators.yml))\n\n## About Fern\n\nFern is used to generate our SDKs from the OpenAPI specification.\n\nIn order to make sure that the definition is valid, you can use the Fern CLI.\n\n```bash\nnpm install -g fern-api # Installs CLI\nfern check # Checks if the definition is valid\n```\n\n### What are Generators?\n\nGenerators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in [generators.yml](./fern/generators.yml).\n\n#### Local preview\n\nYou can preview the generated code in the `./local/go/generated/hookdeck-go-sdk` directory by running the following command:\n\n```sh\nfern generate --group local\n```\n\n### Validating your API Definition\n\nTo validate your API, run: \n```sh\nnpm install -g fern-api # only required once\nfern check\n```\n\n### Updating your SDKs\n\nTo update your SDKs, run `fern generate`. \n\n```sh\nnpm install -g fern-api # only required once\nfern generate --group node-sdk\n```\n\nThis repository contains Github Actions that will trigger SDK generation. Check them out by navigating\nto the `Actions` tab and clicking `Release TypeScript SDK`. \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhookdeck%2Fhookdeck-api-schema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhookdeck%2Fhookdeck-api-schema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhookdeck%2Fhookdeck-api-schema/lists"}