keycloak/keycloak

Several issues with Open API documentation

Ouverte

#36 384 ouverte le 13 janv. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (3 réactions) (0 personne assignée)Java (8 346 forks)batch import
area/admin/apiarea/authorization-servicesarea/docshelp wantedkind/enhancementpriority/lowstatus/auto-bumpteam/core-iamteam/core-shared

Métriques du dépôt

Stars
 (34 398 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Before reporting an issue

  • I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.

Area

docs

Describe the bug

Several issues with Open API documentation.

Version

26.0.7

Regression

  • The issue is a regression

Expected behavior

Correct Open API Documentation

Actual behavior

Incorrect Open API Documentation

How to Reproduce?

Check https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml. We have attached the excel sheet that has identified the issues documented. Identified_Issues.xlsx

Anything else?

No response

Guide contributeur

Direction de recherche
Examinez le fichier Excel joint 'Identified Issues.xlsx' pour obtenir une liste de problèmes spécifiques dans la documentation OpenAPI. Ensuite, ouvrez le fichier YAML OpenAPI à l'adresse https://www.keycloak.org/docs api/latest/rest api/openapi.yaml et localisez les sections correspondantes. Pour chaque problème, apportez les corrections nécessaires au fichier YAML. Validez les modifications en vérifiant la documentation générée. Enfin, créez une pull request avec toutes les corrections.
Stack technique
javarest api
Domaine
documentationapi
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitOpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60