Documentation differs from Implementation for /packageManifests/{id} return codes (204 or 404)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- csharp
- Área
- api, documentation
Línea de trabajo
Lee documentation/WinGet-1.1.0.yaml y documentation/WinGet-1.4.0.yaml en la ruta packageManifests y compáralos con el manejo de 204 en src/WinGet.RestSource/Helpers/RestSourceTriggerFunctions.cs. Confirma qué código de estado está previsto para un paquete inexistente y alinea el esquema y la implementación de referencia para que su comportamiento y documentación coincidan.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Brief description of your issue
Hi,
according to both the 1.1.0 and 1.4.0 REST API schema, the /packageManifests/{PackageIdentifier} route is only supposed to return 200, 404 or another error:
https://github.com/microsoft/winget-cli-restsource/blob/main/documentation/WinGet-1.1.0.yaml#L506-L522
https://github.com/microsoft/winget-cli-restsource/blob/main/documentation/WinGet-1.4.0.yaml#L506-L522
However, the reference implementation also explicitly tests for the undocumented 204 here:
which raises the question - should a REST source return 404 like the schema suggests when a packageIdentifier is not found or should it return 204? I have noticed in testing that winget responds with a red error message when it gets a 404 (which I guess is fine / maybe intended?) but responds with a much more calm "no results found" message when it gets a 204 - so the client seems to handle the undocumented 204 more gracefully, further hinting that that's maybe the intended return code and the schema docs are wrong?
Thanks!
- Lenguaje dominante
- C#
- Estrellas
- 317
- Forks
- 79
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoft/winget-cli-restsource
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
-
Issue-Feature
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
Font Support AbiertoIssue-Feature
microsoft/winget-cli-restsource#310 · 1 comentario · 1 asignado ·
-
Issue Deploying in GCC-H AbiertoIssue-Bug
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
microsoft/winget-cli-restsource#309 · 2 comentarios ·
Todos los issues de microsoft/winget-cli-restsource
Issues similares
-
core dependencies
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
-
bug frontend good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Down / Waiting for removal
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100