exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
60b19a6bd429e6b1d6cf6ac12ea8a6714ae417e1
python/exercises/practice/rest-api/.docs/instructions.md

49 lines
2.3 KiB
Markdown
Raw Normal View History

[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
# Instructions
Implement a RESTful API for tracking IOUs.
Four roommates have a habit of borrowing money from each other frequently, and have trouble remembering who owes whom, and how much.
Sync docs with problem-specifications Most of the docs changes recently have been formatting-related, though in a few exercises there have also been improvements to the descriptions in an attempt to make the exercises easier to understand.
2022-11-19 11:13:59 +01:00
Your task is to implement a simple [RESTful API][restful-wikipedia] that receives [IOU][iou]s as POST requests, and can deliver specified summary information via GET requests.
[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
## API Specification
### User object
Sync practice exercise instructions with problem-specifications. Pulled in updates to instructions from problem specifications.
2022-02-09 14:30:43 -08:00
[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
```json
{
"name": "Adam",
"owes": {
"Bob": 12.0,
"Chuck": 4.0,
"Dan": 9.5
},
"owed_by": {
"Bob": 6.5,
[Problem Spec Sync] Practice Exercise Instruction Sync (#3507) * Synced exercise insructions with problem specifications. * Delete exercises/practice/raindrops/.articles/Progression Revised.md --> File added by mistake. Still needs additions and revisions before committing.
2023-09-22 01:20:13 -07:00
"Dan": 2.75
[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
},
"balance": "<(total owed by other users) - (total owed to other users)>"
}
```
### Methods
[Problem Spec Sync] Practice Exercise Instruction Sync (#3507) * Synced exercise insructions with problem specifications. * Delete exercises/practice/raindrops/.articles/Progression Revised.md --> File added by mistake. Still needs additions and revisions before committing.
2023-09-22 01:20:13 -07:00
| Description | HTTP Method | URL | Payload Format | Response w/o Payload | Response w/ Payload |
| ------------------------ | ----------- | ------ | ------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------- |
| List of user information | GET | /users | `{"users":["Adam","Bob"]}` | `{"users":<List of all User objects>}` | `{"users":<List of User objects for <users> (sorted by name)}` |
| Create user | POST | /add | `{"user":<name of new user (unique)>}` | N/A | `<User object for new user>` |
| Create IOU | POST | /iou | `{"lender":<name of lender>,"borrower":<name of borrower>,"amount":5.25}` | N/A | `{"users":<updated User objects for <lender> and <borrower> (sorted by name)>}` |
[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
Sync practice exercise instructions with problem-specifications. Pulled in updates to instructions from problem specifications.
2022-02-09 14:30:43 -08:00
## Other Resources
Sync docs with problem-specifications Most of the docs changes recently have been formatting-related, though in a few exercises there have also been improvements to the descriptions in an attempt to make the exercises easier to understand.
2022-11-19 11:13:59 +01:00
- [REST API Tutorial][restfulapi]
[v3] Create instruction from prob-specs descriptions Practice Exercises in Exercism v3 will be structured differently. One such change is that there won't be a (generated) README.md file anymore. This file will be replaced by `.docs/instructions.md` and optionally a `.docs/introduction.md` files. These files are copies of the information defined for their corresponding problem-specifications exercise (if any). The `.docs/instructions.md` file is a copy of the `instructions.md` file of the problem-specifications exercise, or if that does not exists, its `description.md` file. The new [configlet](https://github.com/exercism/configlet) version will add support for doing this syncing automatically. See [the spec](https://github.com/exercism/docs/blob/main/anatomy/tracks/practice-exercises.md) for more information.
2021-02-05 16:42:36 +01:00
- Example RESTful APIs
Sync docs with problem-specifications Most of the docs changes recently have been formatting-related, though in a few exercises there have also been improvements to the descriptions in an attempt to make the exercises easier to understand.
2022-11-19 11:13:59 +01:00
- [GitHub][github-rest]
- [Reddit][reddit-rest]
[restful-wikipedia]: https://en.wikipedia.org/wiki/Representational_state_transfer
[iou]: https://en.wikipedia.org/wiki/IOU
[github-rest]: https://developer.github.com/v3/
Synced practice exercise docs to problem specificatons. (#3573)
2023-12-27 05:05:44 -08:00
[reddit-rest]: https://web.archive.org/web/20231202231149/https://www.reddit.com/dev/api/
Sync docs with problem-specifications Most of the docs changes recently have been formatting-related, though in a few exercises there have also been improvements to the descriptions in an attempt to make the exercises easier to understand.
2022-11-19 11:13:59 +01:00
[restfulapi]: https://restfulapi.net/
Reference in New Issue Copy Permalink