{"id":22468584,"url":"https://github.com/projectweekend/links-api","last_synced_at":"2025-03-27T15:44:49.799Z","repository":{"id":19063553,"uuid":"22290269","full_name":"projectweekend/Links-API","owner":"projectweekend","description":"The RESTful API for what will become: http://links.projectweekend.net","archived":false,"fork":false,"pushed_at":"2014-08-19T10:34:12.000Z","size":408,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T19:29:57.344Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/projectweekend.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}},"created_at":"2014-07-26T15:58:08.000Z","updated_at":"2014-07-29T10:36:46.000Z","dependencies_parsed_at":"2022-09-25T04:10:58.772Z","dependency_job_id":null,"html_url":"https://github.com/projectweekend/Links-API","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/projectweekend%2FLinks-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectweekend%2FLinks-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectweekend%2FLinks-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectweekend%2FLinks-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectweekend","download_url":"https://codeload.github.com/projectweekend/Links-API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245874260,"owners_count":20686739,"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-12-06T11:17:53.205Z","updated_at":"2025-03-27T15:44:49.782Z","avatar_url":"https://github.com/projectweekend.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"The RESTful API for what will become: http://links.projectweekend.net\n\n## Development Environment\n\nThe development environment for this project is fully bootstrapped and portable with the help of: [Vagrant](http://www.vagrantup.com/), [Docker](https://www.docker.com/), and [Fig](http://orchardup.github.io/fig/index.html). If using Linux, all of the `Vagrant` stuff can be ignored since Docker runs natively.\n\n* `vagrant up` - Start the VM. On first launch a lot of things need to be downloaded and installed so it could take a little while. Subsequent launches are much faster.\n* `vagrant ssh` - Connect to the VM\n* `vagrant halt` - Shut down the VM\n* `vagrant destroy` - Delete the VM.\n* `/vagrant` - The path on the VM where the project code is mounted. All `fig` commands mus be executed from this path.\n* `fig up` - Start the web application and database containers. On first launch base containers will be downloaded from the Docker Registry so it could take a while. Subsequent launches are much faster.\n* `fig build` - Rebuild the web application container. This needs to be done any time a new Python dependency is added to `requirements.txt`\n* `fig run web python manage.py syncdb` - Run Django's `syncdb` command on a new database.\n* `fig run web python manage.py migtrate` - Apply South database migrations\n* `fig run web python manage.py test` - Run all project tests\n\n-------------------------------------------------------------------------------\n\n### Register a new user\n\n**POST:** `/v1/maker/register`\n\n**Body:**\n~~~json\n{\n    \"email\": \"test@test.com\",\n    \"password\": \"adfadsf\",\n    \"first_name\": \"Thomas\",\n    \"last_name\": \"Jefferson\"\n}\n~~~\n\n**Response:** None\n\n**Status Codes:**\n* `201` - Registration was created\n* `400` - Invalid request body\n\n\n### Verify new user email address\n\n**POST:** `/v1/maker/email/verification`\n\n**Body:**\n~~~json\n{\n    \"token\": \"asdjfkal48a09d853qlkjadfl93\u0026%3l2k\"\n}\n~~~\n\n**Response:** None\n\n**Status Codes:**\n* `200` - Verification was successful\n* `400` - Invalid request body\n\n\n### Request password reset for user\n\n**POST:** `/v1/maker/password/reset`\n\n**Body:**\n~~~json\n{\n    \"email\": \"test@test.com\"\n}\n~~~\n\n**Response:** None\n\n**Status Codes:**\n* `201` - Reset request was created\n* `400` - Invalid request body\n\n\n### Reset password for user\n\n**POST:** `/v1/maker/password/reset/update`\n\n**Body:**\n~~~json\n{\n    \"token\": \"alskdfj93lak4r\u0026$@_23;lads\",\n    \"new_password\": \"newPassword\",\n    \"confirm_password\": \"newPassword\"\n}\n~~~\n\n**Status Codes:**\n* `200` - Authentication was successful\n* `400` - Invalid request body\n* `412` - Invalid reset token\n\n\n### Authenticate user\n\n**POST:** `/v1/maker/authenticate`\n\n**Body:**\n~~~json\n{\n    \"identifier\": \"test@test.com\",\n    \"password\": \"adfadsf\"\n}\n~~~\n\n**Response:**\n~~~json\n{\n    \"token\": \"kja03984q0oaj34j*@$Fmjadfl\"\n}\n~~~\n\n**Status Codes:**\n* `200` - Authentication was successful\n* `400` - Invalid request body\n* `401` - Invalid identifier/password\n\n\n### Request email change for user\n\n**POST:** `/v1/maker/email`\n\n**Body:**\n~~~json\n{\n    \"new_email\": \"something@different.com\"\n}\n~~~\n\n**Response:** None\n\n**Status Codes:**\n* `201` - Request was created\n* `400` - Invalid request body\n* `409` - Email in use\n\n\n### Change password for user\n\n**POST:** `/v1/maker/email/update`\n\n**Body:**\n~~~json\n{\n    \"token\": \"jal39aULJ3IRA90W3R0@appsd03\"\n}\n~~~\n\n**Response:** None\n\n**Status Codes:**\n* `200` - Change was successful\n* `400` - Invalid request body\n* `412` - Invalid change token\n\n\n### Get logged in user detail\n\n**GET:** `/v1/maker/self`\n\n**Response:**\n~~~json\n{\n    \"id\": 3,\n    \"identifier\": \"test@test.com\",\n    \"first_name\": \"Thomas\",\n    \"last_name\": \"Jefferson\",\n    \"email\": \"test@test.com\",\n    \"photo_url\": \"http://urlforphoto.com/image/something.jpg\",\n    \"bio\": \"This is my optional bio\",\n    \"joined\": \"2014-08-18T12:32:58.930Z\"\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n\n\n### Get list of users\n\n**GET:** `/v1/maker`\n\n**Response:**\n~~~json\n{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 3,\n            \"identifier\": \"test@test.com\",\n            \"first_name\": \"Thomas\",\n            \"last_name\": \"Jefferson\",\n            \"email\": \"test@test.com\",\n            \"photo_url\": \"http://urlforphoto.com/image/something.jpg\",\n            \"bio\": \"This is my optional bio\",\n            \"joined\": \"2014-08-18T12:32:58.930Z\",\n            \"folders\": [],\n            \"links\": []\n        }\n    ]\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n\n\n### Get single user\n\n**GET:** `/v1/maker/:id`\n\n**Response:**\n~~~json\n{\n    \"id\": 3,\n    \"identifier\": \"test@test.com\",\n    \"first_name\": \"Thomas\",\n    \"last_name\": \"Jefferson\",\n    \"email\": \"test@test.com\",\n    \"photo_url\": \"http://urlforphoto.com/image/something.jpg\",\n    \"bio\": \"This is my optional bio\",\n    \"joined\": \"2014-08-18T12:32:58.930Z\",\n    \"folders\": [],\n    \"links\": []\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n\n\n### Add a folder\n\n**POST:** `/v1/folder`\n\n**Body:**\n~~~json\n{\n    \"name\": \"Cool Links\",\n    \"Description\": \"Random links I thought were cool\",\n    \"is_public\": true\n}\n~~~\n\n**Response:**\n~~~json\n{\n    \"id\": 1,\n    \"name\": \"Cool Links\",\n    \"description\": \"Random links I thought were cool\",\n    \"is_public\": true,\n    \"created\": \"2014-08-19T00:05:51.611Z\"\n}\n~~~\n\n**Status Codes:**\n* `201` - Folder was created\n* `400` - Invalid request body\n* `401` - Not logged in\n* `409` - Duplicate folder name\n\n\n### Get list of folders for logged in user\n\n**GET:** `/v1/folder`\n\n**Response:**\n~~~json\n{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 1,\n            \"name\": \"Cool Links\",\n            \"description\": \"Random links I thought were cool\",\n            \"links\": [\n                {\n                    \"id\": 2,\n                    \"folder\": 1,\n                    \"url\": \"https://learn.adafruit.com/flora-and-codebender\",\n                    \"note\": \"Using Codebender with Flora\",\n                    \"photo_url\": \"\",\n                    \"created\": \"2014-08-04T00:00:26.284Z\"\n                }\n            ],\n            \"is_public\": true,\n            \"created\": \"2014-08-03T23:23:43.117Z\"\n        }\n    ]\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n\n\n### Get single folder for logged in user\n\n**GET:** `/v1/folder/:id`\n\n**Response:**\n~~~json\n{\n    \"id\": 1,\n    \"name\": \"Cool Links\",\n    \"description\": \"Random links I thought were cool\",\n    \"links\": [\n        {\n            \"id\": 2,\n            \"folder\": 1,\n            \"url\": \"https://learn.adafruit.com/flora-and-codebender\",\n            \"note\": \"Using Codebender with Flora\",\n            \"photo_url\": \"\",\n            \"created\": \"2014-08-04T00:00:26.284Z\"\n        }\n    ],\n    \"is_public\": true,\n    \"created\": \"2014-08-03T23:23:43.117Z\"\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n* `404` - Folder does not exist\n\n\n### Add a link\n\n**POST:** `/v1/link`\n\n**Body:**\n~~~json\n{\n    \"url\":\"https://learn.adafruit.com/flora-and-codebender\",\n    \"note\":\"Using Codebender with Flora\",\n    \"folder\":1\n}\n~~~\n\n**Response:**\n~~~json\n{\n    \"id\": 3,\n    \"folder\": 1,\n    \"url\": \"https://learn.adafruit.com/flora-and-codebender\",\n    \"note\": \"Using Codebender with Flora\",\n    \"photo_url\": \"\",\n    \"created\": \"2014-08-19T00:43:18.064Z\"\n}\n~~~\n\n**Status Codes:**\n* `201` - Link was created\n* `400` - Invalid request body\n* `401` - Not logged in\n\n\n### Get list of links for logged in user\n\n**GET:** `/v1/link`\n\n**Response:**\n~~~json\n{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 3,\n            \"folder\": null,\n            \"url\": \"https://learn.adafruit.com/flora-and-codebender\",\n            \"note\": \"Using Codebender with Flora\",\n            \"photo_url\": \"\",\n            \"created\": \"2014-08-19T00:43:18.064Z\"\n        }\n    ]\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n\n\n### Get single links for logged in user\n\n**GET:** `/v1/link/:id`\n\n**Response:**\n~~~json\n{\n    \"id\": 3,\n    \"folder\": null,\n    \"url\": \"https://learn.adafruit.com/flora-and-codebender\",\n    \"note\": \"Using Codebender with Flora\",\n    \"photo_url\": \"\",\n    \"created\": \"2014-08-19T00:43:18.064Z\"\n}\n~~~\n\n**Status Codes:**\n* `200` - Request was successful\n* `401` - Not logged in\n* `404` - Link does not exist\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectweekend%2Flinks-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectweekend%2Flinks-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectweekend%2Flinks-api/lists"}