rucio / rucio/documentation

Ensure YAML-parsable OpenAPI docs

Open
#567 0 comments 0 reactions 1 assignee View on GitHub

@Geogouz is already working on this.

Since Sep 12, 2025.

bug documentation enhancement
Dominant language
Python
Stars
4
Forks
71
Avg merge
2d 1h
Merged PRs (30d)
11

Description

As pointed in https://github.com/rucio/documentation/pull/563#pullrequestreview-2861928498, the OpenAPI docs contained in our web classes should be YAML parsable without causing issues. Specifically about the pointed issue, a simple approach that I follow is to quote my one-line description fields like so:

description: "The scope and the name of the DID (e.g., 'scope:name')."

or for multilines we could be using:

description: |
  Set metadata for a data identifier (DID). If a piece of metadata for a given key
  already exists, it will be handled according to the underlying metadata plugin
  in use. blablabla.

Regarding this, we should maybe mention this somewhere, but we should ideally also introduce somewhere a check about this (either at rucio/documentation side or rucio/rucio).

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.