search

lichess-org / api

Lichess API documentation and examples
https://lichess.org/api
GNU Affero General Public License v3.0
434 stars 144 forks source link

Fix warnings #331

Closed tors42 closed 5 months ago

tors42 commented 5 months ago

Fixed the warnings.

25 of the warnings were "fixed" by disabling one redocly rule for "ambiguous paths".

  no-ambiguous-paths: off

Added comment in redocly.yaml:

  # Example ambiguous paths:
  # /api/tournament/{id1}/join
  # /api/tournament/team-battle/{id2}
  # If id1 has value "team-battle", and id2 has value "join",
  # these paths would be identical...

Fixing these warnings would mean changing the paths in lila. If we think that would be desirable, we should re-enable this rule...

fitztrev commented 5 months ago

Thanks! Referencing the example json directly from its schema seems like a nice improvement too.