pvarki / pvarki/python-rasenmaeher-api

Make API more RESTful

Open
#74 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
1
Avg merge
4d 13h
Merged PRs (30d)
5

Description

restful See notes from @3zk1m0 above.

In addition to those: Everything that acceps invitecode or callsign as parameter MUST also accept the primary-key of the object.

PKs are UUIDs are the route must accept both the classic string form of "20994228-d379-4acd-bdd8-4de88435381b" and base64 encoded form "yUb5X1onSSCPzAFmeeyzJg==" (see helpers for encoding/decoding this form)

Anything that outputs UUIDs SHOULD output the b64 form.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the API routes and handlers that accept invitecode or callsign, and the UUID encoding/decoding helper linked in the issue. Done means those endpoints also accept UUID primary keys in both forms and UUID outputs use base64 where required; the referenced notes still need to be recovered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.