Skip to content

contributing: add openapi guide for the backend#317

Open
hhirtz wants to merge 23 commits intomasterfrom
uber/openapi
Open

contributing: add openapi guide for the backend#317
hhirtz wants to merge 23 commits intomasterfrom
uber/openapi

Conversation

@hhirtz
Copy link
Copy Markdown
Member

@hhirtz hhirtz commented Dec 12, 2025

says how to update openapi.yaml and about how some frontend code is generated from it

this information is already in editoast's README, but this way the contributing guidelines also have it https://github.com/OpenRailAssociation/osrd/blob/14b4caf76880934970bade357ca1a806dd64df9b/editoast/README.md#openapi-generation

openapi 3.1 because it seems it's what utoipa supports: https://github.com/juhaku/utoipa/tree/utoipa-5.4.0?tab=readme-ov-file#features

clarani and others added 23 commits September 15, 2025 10:20
Not useful after all.

Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Replace generic RTK information with details about our implementation

Signed-off-by: Clara Ni <clara.ni@outlook.fr>
- remove an example of scoped css to make the section lighter
- remove the CSS Modules section since we don't use them in our codebase
- transform the section about cx in a short sentence

Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Signed-off-by: Clara Ni <clara.ni@outlook.fr>
Signed-off-by: Egor Berezovskiy <egor@berezify.fr>
Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Signed-off-by: Dominik Wefering <d.wefering@tutanota.de>
Signed-off-by: Gaëtan Duchaussois <gaetan-osrd@tcgi.fr>
Signed-off-by: Gaëtan Duchaussois <gaetan-osrd@tcgi.fr>
This makes it easier for less technical folks to draft, publish
and update our blog.

Signed-off-by: Simon Ser <contact@emersion.fr>
Signed-off-by: Angelina Kuntz <angelina.kuntz@epita.fr>
Signed-off-by: Gaëtan Duchaussois <gaetan-osrd@tcgi.fr>
Signed-off-by: Dominik Wefering <d.wefering@tutanota.de>
Signed-off-by: Dominik Wefering <d.wefering@tutanota.de>
* front: regroup logos under the static folder

* front: shortcode that actually uses event logos

* front: tips and guideline on where to put images

---------

Signed-off-by: pierre santamaria <pierre.santamaria@epita.fr>
says how to update openapi.yaml and about how some frontend code is
generated from it

Signed-off-by: Hubert Hirtz <hubert@hirtz.pm>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants