{"id":23525392,"url":"https://github.com/directus/openapi","last_synced_at":"2025-04-22T11:28:29.888Z","repository":{"id":269446318,"uuid":"904926545","full_name":"directus/openapi","owner":"directus","description":"OpenAPI Specification for the Directus API","archived":false,"fork":false,"pushed_at":"2025-04-07T13:02:23.000Z","size":318,"stargazers_count":4,"open_issues_count":9,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-15T21:17:32.375Z","etag":null,"topics":["directus","openapi","spec"],"latest_commit_sha":null,"homepage":"https://directus.io","language":"TypeScript","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/directus.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}},"created_at":"2024-12-17T20:19:25.000Z","updated_at":"2025-04-07T13:02:11.000Z","dependencies_parsed_at":"2025-02-12T17:38:10.363Z","dependency_job_id":null,"html_url":"https://github.com/directus/openapi","commit_stats":null,"previous_names":["directus/openapi"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/directus%2Fopenapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/directus%2Fopenapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/directus%2Fopenapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/directus%2Fopenapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/directus","download_url":"https://codeload.github.com/directus/openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250231237,"owners_count":21396430,"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":["directus","openapi","spec"],"created_at":"2024-12-25T19:09:11.235Z","updated_at":"2025-04-22T11:28:29.864Z","avatar_url":"https://github.com/directus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Directus' OpenAPI Specification\n\nThis repo contains the OpenAPI specifications for Directus' API.\n\nThe static spec in this repo contains all the system endpoints and a definition for a generic `/items/{collection}` endpoint.\n\n## Usage\n\nThe spec is exported in 3 formats: `.yaml`, `.json`, and `.js`. The JS file is just an `export` of the same JSON but parsed into JS for ease of use in JS projects.\n\n## Requirements\n\nThe specification is written to work with OpenAPI version 3 and up.\n\n## Vendor Extensions\n\nThe spec relies on two vendor-specific fields to represent information required by the system:\n\n### `x-collection`\n\nKey that maps a system endpoint to its corresponding system collection. \n\n### `x-codeSamples`\n\nExamples of how to use the equivalent of the documented REST endpoint in the JS SDK and/or GraphQL endpoint.\n\n## Deploying Releases\n\n\u003e [!NOTE]\n\u003e This requires write access to the `@directus` organization on npm\n\nTo deploy a new release to npm:\n\n- `rm -rf dist` if it exists\n- `pnpm build` to build a new `dist` folder\n- `pnpm lint` to ensure the built spec is valid\n- `pnpm version \u003cpatch | minor\u003e`\n- `git push \u0026\u0026 git push --tags`\n- `pnpm publish`\n\nThis manual process will be replaced with a CD action, but until we set that up, follow the above :) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirectus%2Fopenapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdirectus%2Fopenapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirectus%2Fopenapi/lists"}