{"id":19888618,"url":"https://github.com/postgrest/postgrest-openapi","last_synced_at":"2025-06-14T07:38:37.278Z","repository":{"id":202709348,"uuid":"638743792","full_name":"PostgREST/postgrest-openapi","owner":"PostgREST","description":"OpenAPI output generated in SQL for a PostgREST instance","archived":false,"fork":false,"pushed_at":"2024-11-11T22:01:59.000Z","size":117,"stargazers_count":24,"open_issues_count":16,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-12T19:46:22.177Z","etag":null,"topics":["openapi","openapi3","postgresql","postgresql-extension","postgrest"],"latest_commit_sha":null,"homepage":"","language":"PLpgSQL","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/PostgREST.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2023-05-10T02:33:03.000Z","updated_at":"2025-05-08T20:55:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"1093fb59-2c7d-4c11-912a-76f0c21b4196","html_url":"https://github.com/PostgREST/postgrest-openapi","commit_stats":null,"previous_names":["postgrest/postgrest-openapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PostgREST/postgrest-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PostgREST%2Fpostgrest-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PostgREST%2Fpostgrest-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PostgREST%2Fpostgrest-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PostgREST%2Fpostgrest-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PostgREST","download_url":"https://codeload.github.com/PostgREST/postgrest-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PostgREST%2Fpostgrest-openapi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259778042,"owners_count":22909778,"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":["openapi","openapi3","postgresql","postgresql-extension","postgrest"],"created_at":"2024-11-12T18:07:43.814Z","updated_at":"2025-06-14T07:38:37.262Z","avatar_url":"https://github.com/PostgREST.png","language":"PLpgSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PostgREST OpenAPI\n\nSQL functions to build the OpenAPI output of a PostgREST instance.\n\n## Roadmap\n\n- The first step in the roadmap is to migrate the OpenAPI spec from the PostgREST core repository (version 2.0 to 3.1):\n  - [x] Info object\n  - [x] Server object (replaces host, basePath and schemes from OAS 2.0)\n  - [x] Components object\n    - [x] Schemas (definitions in OAS 2.0)\n    - [x] Security scheme (security definitions in OAS 2.0)\n    - [x] Parameters\n  - [x] Paths object\n    - [x] Tables and Views\n      - [x] GET\n      - [x] POST\n      - [x] PATCH\n      - [x] DELETE\n    - [x] Functions\n      - [x] GET\n      - [x] POST\n  - [ ] External Documentation Object\n  - [ ] Handle relevant OpenAPI elements according to user permissions\n- The next step is to fix the issues tagged with `OpenAPI` in the core repo.\n\n## Installation\n\n```bash\nmake \u0026\u0026 sudo make install\n```\n\n## Development\n\nCheck the code documentation at [/docs](/docs) to familiarize yourself with the project structure and function usage.\n\nFor testing on your local database:\n\n```bash\n# this will load fixtures in a contrib_regression db on your local postgres\nmake fixtures\n\n# run the tests, they can be run repeatedly\nmake installcheck\n\n# to clean the fixtures you can use\nmake clean\n```\n\nFor an isolated and reproducible enviroment you can use [Nix](https://nixos.org/download.html).\n\n```bash\n# to run tests\nnix-shell --run \"with-pg-15 make installcheck\"\n\n# to interact with the local database with fixtures loaded\nnix-shell --run \"with-pg-15 psql contrib_regression\"\n\n# you can choose the pg version\nnix-shell --run \"with-pg-13 make installcheck\"\n```\n\nFor those who insist on Docker:\n```bash\n# To build a docker image and run the tests in it\nmake docker-build-test\n\n# To build a docker image for actual use\nmake docker-build\n```\n\n## References\n\n- [OpenAPI 3 Specification Documentation](https://spec.openapis.org/oas/v3.1.0): The official documentation of the spec.\n- [OpenAPI Specification Explained](https://learn.openapis.org/specification/): Introductory explanation of the spec.\n- [OpenAPI Guide](https://swagger.io/docs/specification/about/): Detailed explanation for each concept of the spec, useful to build it from scratch.\n- [OpenAPI Visual Map](http://openapi-map.apihandyman.io/?version=3.0): Visual representation of the spec using an interactive GUI to navigate through its components.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostgrest%2Fpostgrest-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpostgrest%2Fpostgrest-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostgrest%2Fpostgrest-openapi/lists"}