{"id":19293044,"url":"https://github.com/catarse/catarse-api-specs","last_synced_at":"2026-03-14T22:04:19.869Z","repository":{"id":90494600,"uuid":"43400024","full_name":"catarse/catarse-api-specs","owner":"catarse","description":"Catarse API specification","archived":false,"fork":false,"pushed_at":"2016-05-05T16:37:19.000Z","size":26882,"stargazers_count":3,"open_issues_count":1,"forks_count":5,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-05T20:40:28.417Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/catarse.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":"2015-09-29T23:22:07.000Z","updated_at":"2019-07-03T20:48:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"f04683b8-a917-4206-b683-99f1a2392f2a","html_url":"https://github.com/catarse/catarse-api-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/catarse%2Fcatarse-api-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catarse%2Fcatarse-api-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catarse%2Fcatarse-api-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catarse%2Fcatarse-api-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catarse","download_url":"https://codeload.github.com/catarse/catarse-api-specs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240396486,"owners_count":19794691,"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-09T22:33:55.052Z","updated_at":"2025-11-15T01:18:22.415Z","avatar_url":"https://github.com/catarse.png","language":"PLpgSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Catarse API specification [![Circle CI](https://circleci.com/gh/catarse/catarse-api-specs.svg?style=svg)](https://circleci.com/gh/catarse/catarse-api-specs)\n\n## Requirements\n\n* Mac OS X or Ubuntu Linux\n* PostgreSQL 9.4+ with default contrib extensions\n* Python 2.7.10+\n* [pyresttest](https://github.com/svanoort/pyresttest)\n* [click](http://click.pocoo.org/)\n\nThe scripts assume that you have a PostgreSQL running in your local environment\nand that you have a database superuser with the same name as the user running the script.\n\nYou also need to be able to connect with any arbitrary PostgreSQL user without a password.\n\nIf you need to use a password to connect try setting up a [pgpass](http://www.postgresql.org/docs/current/static/libpq-pgpass.html) file.\n\n## Installation\n\n```\npip install -r requirements.txt\n```\n\n## Running tests\n\nIf everything is installed and configured properly you should be able to run the entire suite\nusing the command:\n\n```\n./api_spec.py run_tests\n```\n\nYou can also pass one parameter with a different database name to use for testing.\nThe default name is **catarse_api_test**.\n\n## Updating the database schema\n\nThere is a script recreate_schema.sh in the database directory\nthat will read a given database and store its schema in the file database/schema.sql\nAfter modifying the development database you should run this script\nand run the tests to check if everything is still working.\n\n```\n./api_spec.py recreate_schema --name=database_name\n```\n\n## Adding tests\n\nThe tests are organized in files by endpoint, so you should\nnever test more than one endpoint per yml file.\nAdd the test file named after the endpoint you are testing, if you are\ntesting the endpoint **foo**, the test file will be **test/foo.yml**.\n\nTo bootstrap a basic get test against the foo endpoint use the command:\n\n```\n./api_spec.py generate_test --name=foo\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatarse%2Fcatarse-api-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatarse%2Fcatarse-api-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatarse%2Fcatarse-api-specs/lists"}