{"id":16539552,"url":"https://github.com/al3rez/pet-store","last_synced_at":"2026-05-18T02:31:59.661Z","repository":{"id":127306843,"uuid":"138073286","full_name":"al3rez/pet-store","owner":"al3rez","description":"🐱🏪This is a simple pet store REST API that simplifies interaction between pet owners and customers","archived":false,"fork":false,"pushed_at":"2019-03-05T03:22:33.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-09T10:39:19.563Z","etag":null,"topics":["pet-store","rails","rest","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/al3rez.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":"2018-06-20T18:51:47.000Z","updated_at":"2019-03-05T03:22:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"2d43c4e0-c752-490d-b826-6e7f400d6db6","html_url":"https://github.com/al3rez/pet-store","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/al3rez/pet-store","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fpet-store","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fpet-store/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fpet-store/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fpet-store/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/al3rez","download_url":"https://codeload.github.com/al3rez/pet-store/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fpet-store/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33162607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T22:39:12.733Z","status":"online","status_checked_at":"2026-05-18T02:00:06.436Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["pet-store","rails","rest","ruby"],"created_at":"2024-10-11T18:49:38.844Z","updated_at":"2026-05-18T02:31:59.635Z","avatar_url":"https://github.com/al3rez.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pet Store API [![Build Status](https://travis-ci.org/azbshiri/pet-store.svg?branch=master)](https://travis-ci.org/azbshiri/pet-store) [![codecov](https://codecov.io/gh/azbshiri/pet-store/branch/master/graph/badge.svg)](https://codecov.io/gh/azbshiri/pet-store)\n\nThis is a simple pet store REST API that simplifies interaction between pet owners and customers.\n\n## Sign up\nRegister as a new user\n\n`POST` http://localhost:3000/sign_up?as=:role\n\n#### Path Parameters\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| role | String | User role. `pet_owner`, `manager`, `customer`   |\n\n#### Result Format - Sign up\n```\n{\n\t\"email\": \"test+customer@gmail.com\",\n\t\"role\": \"customer\",\n\t\"created_at\": \"2018-06-20T20:30:15.425Z\",\n\t\"updated_at\": \"2018-06-20T20:30:15.425Z\"\n}\n```\n\n## View pets\nView the details of multiple pets\n\n`GET` http://localhost:3000/pets?limit=:limit\u0026offset=:offset\n\n#### Path Parameters\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| limit | String | How many pets to return. Default is 10   |\n| offset | String | Result offset. Default is 0.  |\n\n#### Result Format - View pets\n```\n[\n\t{\n\t\t\"id\": \"6YEfR6\",\n\t\t\"name\": \"foo\",\n\t\t\"pet_type\": \"cat\",\n\t\t\"created_at\": \"2018-06-20T20:28:52.561Z\",\n\t\t\"updated_at\": \"2018-06-20T20:29:54.801Z\",\n\t\t\"owner\": {\n\t\t\t\"email\": \"test+owner@gmail.com\",\n\t\t\t\"role\": \"pet_owner\",\n\t\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t\t}\n\t},\n\t{\n\t\t\"id\": \"6YFfR6\",\n\t\t\"name\": \"bar\",\n\t\t\"pet_type\": \"cat\",\n\t\t\"created_at\": \"2018-06-20T20:28:53.561Z\",\n\t\t\"updated_at\": \"2018-06-20T20:29:56.801Z\",\n\t\t\"owner\": {\n\t\t\t\"email\": \"test+manager@gmail.com\",\n\t\t\t\"role\": \"manager\",\n\t\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t\t}\n\t}\n]\n```\n\n\n\n## View pet\nView the details of a single pet\n\n\n`GET` http://localhost:3000/pets/:id\n\n#### Path Parameters\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Pet ID   |\n\n\n\n#### Body Parameters - Add a pet \n\n| name | type    | description    |\n| ---- | ------- | -------------- |\n| email | String | **REQUIRED** Email address   |\n| password | String | **REQUIRED** Password   |\n| password | String | **REQUIRED** Password confirmation   |\n\n#### Result Format - Add a pet\n```\n{\n\t\"id\": \"673fL6\",\n\t\"name\": \"foo\",\n\t\"pet_type\": \"cat\",\n\t\"created_at\": \"2018-06-19T20:37:38.442Z\",\n\t\"updated_at\": \"2018-06-19T21:03:01.976Z\",\n\t\"owner\": {\n\t\t\"email\": \"test@gmail.com\",\n\t\t\"created_at\": \"2018-06-19T20:36:16.703Z\",\n\t\t\"updated_at\": \"2018-06-19T20:36:16.703Z\"\n\t}\n}\n```\n\n## Add a pet\nAdd a new pet to your collection\n\n`POST` http://localhost:3000/pets\n\n#### Body Parameters - Add a pet \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| name | String | **REQUIRED** Pet name   |\n| pet_type | String | **REQUIRED** Pet type. `dog`, `cat` |\n\n#### Result Format - Add a pet\n```\n{\n\t\"id\": \"673fL6\",\n\t\"name\": \"foo\",\n\t\"pet_type\": \"cat\",\n\t\"created_at\": \"2018-06-19T20:37:38.442Z\",\n\t\"updated_at\": \"2018-06-19T21:03:01.976Z\",\n\t\"owner\": {\n\t\t\"email\": \"test@gmail.com\",\n\t\t\"created_at\": \"2018-06-19T20:36:16.703Z\",\n\t\t\"updated_at\": \"2018-06-19T20:36:16.703Z\"\n\t}\n}\n```\n\n## Update a pet\n\nUpdate an existing pet\n\n\n`PUT` http://localhost:3000/pets/:id\n\n#### Path Parameters - Update a pet \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Pet ID   |\n\n#### Body Parameters - Update a pet \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| name | String | **REQUIRED** Pet name   |\n| pet_type | String | **REQUIRED** Pet type. `dog`, `cat` |\n\n\n#### Result Format - Update a pet\n```\n{}\n```\n\n## Delete a pet\nDelete an existing pet\n\n\n`DELETE` http://localhost:3000/pets/:id\n\n#### Body Parameters - Add a pet \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Pet ID   |\n\n#### Result Format - Delete a pet\n```\n{}\n```\n\n## View categories\nView the details of multiple categories\n\n`GET` http://localhost:3000/categories?limit=:limit\u0026offset=:offset\n\n#### Path Parameters\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| limit | String | How many categories to return. Default is 10   |\n| offset | String | Result offset. Default is 0.  |\n\n#### Result Format - View pets\n```\n[\n\t{\n\t\t\"id\": 1,\n\t\t\"name\": \"foo\",\n\t\t\"created_at\": \"2018-06-20T23:15:33.008Z\",\n\t\t\"updated_at\": \"2018-06-20T23:15:33.008Z\",\n\t\t\"user\": {\n\t\t\t\"email\": \"azbshiri+manager@gmail.com\",\n\t\t\t\"role\": \"manager\",\n\t\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t\t},\n\t\t\"pets\": []\n\t},\n\t{\n\t\t\"id\": 2,\n\t\t\"name\": \"bar\",\n\t\t\"created_at\": \"2018-06-20T23:15:33.008Z\",\n\t\t\"updated_at\": \"2018-06-20T23:15:33.008Z\",\n\t\t\"user\": {\n\t\t\t\"email\": \"azbshiri+manager@gmail.com\",\n\t\t\t\"role\": \"manager\",\n\t\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t\t},\n\t\t\"pets\": []\n\t}\n]\n```\n\n\n\n## View category\nView the details of a single category\n\n\n`GET` http://localhost:3000/categories/:id\n\n#### Path Parameters\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Category ID   |\n\n#### Result Format - View pet\n```\n{\n\t\"id\": 1,\n\t\"name\": \"foo\",\n\t\"created_at\": \"2018-06-20T23:15:33.008Z\",\n\t\"updated_at\": \"2018-06-20T23:15:33.008Z\",\n\t\"user\": {\n\t\t\"email\": \"azbshiri+manager@gmail.com\",\n\t\t\"role\": \"manager\",\n\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t},\n\t\"pets\": []\n}\n```\n\n## Add a category\nAdd a new category to your collection\n\n`POST` http://localhost:3000/categories\n\n#### Body Parameters - Add a category \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| name | String | **REQUIRED** Category name   |\n\n#### Result Format - Add a category\n```\n{\n\t\"id\": 1,\n\t\"name\": \"foo\",\n\t\"created_at\": \"2018-06-20T23:15:33.008Z\",\n\t\"updated_at\": \"2018-06-20T23:15:33.008Z\",\n\t\"user\": {\n\t\t\"email\": \"azbshiri+manager@gmail.com\",\n\t\t\"role\": \"manager\",\n\t\t\"created_at\": \"2018-06-20T20:27:23.013Z\",\n\t\t\"updated_at\": \"2018-06-20T20:27:23.013Z\"\n\t},\n\t\"pets\": []\n}\n```\n\n## Update a category\n\nUpdate an existing category\n\n\n`PUT` http://localhost:3000/categories/:id\n\n#### Path Parameters - Update a category \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Category ID   |\n\n\n#### Body Parameters - Update a category \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| name | String | **REQUIRED** Category name   |\n| pet_ids | Array | **REQUIRED** IDs of pets that belongs to the category.   |\n\n\n#### Result Format - Update a category\n```\n{}\n```\n\n## Delete a category\nDelete an existing category\n\n\n`DELETE` http://localhost:3000/categories/:id\n\n#### Body Parameters - Delete a category \n\n| Parameter | Type    | Description    |\n| ---- | ------- | -------------- |\n| id | String | **REQUIRED** Category ID   |\n\n#### Result Format - Delete a category\n```\n{}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fal3rez%2Fpet-store","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fal3rez%2Fpet-store","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fal3rez%2Fpet-store/lists"}