feature request: Make "Permissions" API objects consistent

Abierto
#29 0 comentarios 1 reacción 0 asignados Ver en GitHub

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
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
openapi, typescript
Área
api

Línea de trabajo

Comienza comparando los objetos Permissions en la especificación de la API para Set Role Permission y Create Role, utilizando las operaciones vinculadas como puntos de entrada. Determina qué nombres de campo deberían ser canónicos y, después, rastrea cómo las tipificaciones de TypeScript y la salida generada por OpenAPI representan ambos esquemas. Se considera terminado cuando los modelos de la API utilizan una representación coherente sin un manejo redundante de la deserialización.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
What do you want to see?

There are multiple places in the API spec where an object representing a role's permissions (allowed and denied) is expressed, but I've noticed an inconsistency: Sometimes the fields are allow and deny (example: Set Role Permission), and sometimes they are a and d (example: Create Role). Could this be fixed up and unified in one way or another? It would make some API wrappers' lives easier not needing to include special JSON deserialization logic to handle the same model with differing field names, or having to include redundant model code. 😄

Lenguaje dominante
TypeScript
Estrellas
42
Forks
34
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stoatchat/javascript-client-api

Todos los issues de stoatchat/javascript-client-api

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.