otto-de/api-guidelines

View on GitHub

A set of rules to build consistent and high quality REST and Async APIs at OTTO.

Stars: 50
Forks: 16
Open beginner issues: 0
Indexed issues: 21

Dominant language: TypeScript
License: CC-BY-4.0
Last GitHub push: Jun 25, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: No code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

21 open issues indexed

[update] Write introduction into API lifecycle Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

otto-de/api-guidelines#97 · Opened Aug 15, 2025
[new rule] create a new rule to deal with scope changes Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

otto-de/api-guidelines#70 · 1 comment · Opened May 29, 2024
[orga] Provide script for "next free rule number" Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

otto-de/api-guidelines#66 · Opened Apr 24, 2024
[orga] add issue template Open

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

otto-de/api-guidelines#56 · Opened Aug 30, 2023
[define] evaluate proposed w3c standard "Content Negotiation by Profile" Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#31 · Opened May 16, 2023
[update] remove rule MUST NOT validate audience of the JSON Web Token Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

otto-de/api-guidelines#30 · 1 comment · Opened May 16, 2023
[new rule] create rule for formatting prices Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#29 · 16 comments · Opened May 16, 2023
[new rule] guidelines for avro format Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

otto-de/api-guidelines#28 · Opened May 16, 2023
[new rule] write domain events originating from the same entity type to the same kafka topic Open

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

otto-de/api-guidelines#27 · Opened May 16, 2023
[update] add example for MAY provide sequence Open

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

otto-de/api-guidelines#26 · Opened May 16, 2023
[update] definition of domain event Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

otto-de/api-guidelines#25 · Opened May 16, 2023
[define] support for commands Open

Difficulty 5/5 Over a week Newbie friendliness 20/100

otto-de/api-guidelines#24 · 2 comments · Opened May 16, 2023
[define] evaluate possibilities for SNS/SQS CloudEvents binding Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#23 · 1 comment · Opened May 16, 2023
[update] relax "MUST change type context attribute to indicate incompatible changes" to allow deprecation cycle on property basis Open

Difficulty 5/5 Over a week Newbie friendliness 35/100

otto-de/api-guidelines#22 · 1 comment · Opened May 16, 2023
[define] usage of CloudEvents' `dataschema` conflicts with the Confluent wire format Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#21 · 1 comment · Opened May 16, 2023
[new rule] compacted topics must always be ordered Open

Difficulty 3/5 1-2 days Newbie friendliness 30/100

otto-de/api-guidelines#20 · Opened May 16, 2023
[new rule] producers must specify order guarantee in AsyncAPI spec Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#19 · 1 comment · Opened May 16, 2023
[update] rework ETag usage Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#18 · Opened May 16, 2023
[new rule] must provide compatibility mode for produced messages Open

Difficulty 5/5 Over a week Newbie friendliness 30/100

otto-de/api-guidelines#17 · Opened May 16, 2023
[new rule] add a rule(set) to clearly specify how data change events should be used Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

otto-de/api-guidelines#16 · Opened May 16, 2023
[new rule] must use `partitionkey` context attribute (CloudEvents) Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

otto-de/api-guidelines#15 · 1 comment · Opened May 16, 2023

otto-de/api-guidelines

Get new issues in your inbox