The "@id" fields cause problems, rename to "id"
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Refactorización
- Claridad
- Necesita aclaración
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Look for '@id' field definitions in the metadata schema files. Understand the schema structure and where these fields are used. Check for any validation or processing that depends on the '@id' naming. Rename occurrences to 'id' and ensure the schema remains valid.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description of the issue
OEMetadata instance documents use @id wherever a resource — usually an ontology term — is referenced. The @ prefix creates concrete friction for consumers:
- JSONPath (RFC 9535) reserves @ as the current-node identifier, so $.subject[*].@id is not expressible. Every extraction rule needs bracket notation.
- GraphQL field names must match /[_A-Za-z][_0-9A-Za-z]*/. @id is illegal as a field name, which blocks a GraphQL surface over OEMetadata.
- @ is not a valid identifier character in most languages. Generated models need explicit alias declarations (Field(alias="@id") in Pydantic); JS/TS destructuring becomes awkward.
- YAML reserves @ as an indicator character, so the key must be quoted in any YAML representation.
Ideas of solution
Alias the keyword in the context. Instance documents then write id, and the emitted RDF is unchanged:
"@context": { "id": "@id", ... }
Keyword aliasing exists for exactly this purpose and is standard practice in the JSON-LD ecosystem.
This affects @id in instance documents only. Occurrences inside context term definitions — "publicationYear": {"@id": "fabio:hasPublicationYear"} — are unaffected, because aliased keywords may not be used within a context itself. These are confined to the single context file and never appear in user-authored metadata.
Data Package reserves a root-level id for globally unique identifiers and explicitly permits non-IRI values such as bare UUIDs. If OEMetadata inherits that field unchanged, aliasing id to @id would silently reinterpret such values as relative IRIs resolved against the document base.
Workflow checklist
- I am aware of the workflow in CONTRIBUTING.md
- Lenguaje dominante
- Python
- Estrellas
- 26
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la 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 OpenEnergyPlatform/oemetadata
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
OpenEnergyPlatform/oemetadata#328 ·
-
Develop AI tooling for usersAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
OpenEnergyPlatform/oemetadata#327 · 1 comentario ·
-
Codecov workflow fails on every develop push: frictionless not installedPosiblemente ocupada @jh-RLI la tomó hace 52 días. Abiertopart: github :octocat: status: active 🚧 type: bug 🐛
OpenEnergyPlatform/oemetadata#325 · 1 asignado ·
-
status: active 🚧 type: bug 🐛
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
OpenEnergyPlatform/oemetadata#323 · 1 reacción ·
-
Revise and update testsPosiblemente ocupada @jh-RLI la tomó hace 52 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
OpenEnergyPlatform/oemetadata#316 · 1 comentario · 3 asignados ·
Todos los issues de OpenEnergyPlatform/oemetadata
Issues similares
-
needs-triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
flashinfer-ai/flashinfer#9803 ·
Los mantenedores suelen responder en 1 día
-
bug frontend good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
oscarbol09/thesisforge#61 ·
-
api bug performance
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
oscarbol09/audiobard#159 ·
-
area:web p2 product:business triage:active type:bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 89/100
cuadrao-ai/argus#2328 ·
Los mantenedores suelen responder en 1 día
-
bug frontend good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
nikhilb2/simple_invoicing#907 ·