Comments (3)
Sono d'accordo sul posizionare le info di glossario in components.schemas.
A tal proposito ti propongo una struttura come questa:
components:
schemas:
taxCode:
$ref: '#/components/x-glossary/teamdigitale/TaxCode'
Problem:
$ref: '#/components/x-glossary/teamdigitale/Problem'
x-glossary:
teamdigitale:
TaxCode:
$ref: "https://raw.githubusercontent.com/teamdigitale/openapi/master/docs/schemas/tax_code.yaml#/TaxCode"
Problem:
$ref: "https://raw.githubusercontent.com/teamdigitale/openapi/0.0.1/docs/schemas/problem.yaml#/Problem"
description: "Glossario definito dal Team Digitale"
publisher: Team Digitale
ecosystem: Eventuale Ecosistema
version: Versione
In questo modo abbiamo:
- la possibilità di definire modelli a partire da un glossario esterno definito
- la possibilità di definire più di un glossario a cui fare riferimento negli schema
- la possibilità di descrivere in termini business, con i campi opzionali description, publisher, ecosystem e version lo specifico glossario
from api-openapi-samples.
Ciao @stefkohub
- capito l'obiettivo
- potremmo farlo nel file sorgente (eg. schemas/glossario-muoversi.yaml#/x-glossary/Tax-Code)
- non cambierei l'alberatura di OAS invece. Il glossario, come la definizione gdpr lo ricaverei dai datatype, non dall'API.
from api-openapi-samples.
Concordo, la struttura x-glossary può andare in un YAML separato, e contenere sia le informazioni dei datatype che le informazioni "di business" accessorie.
from api-openapi-samples.
Related Issues (20)
- Cleanup old files
- Add IndicePA current specs
- Metadata on Muoversi Lombardia
- Muoversi Lombardia: deprecation dates HOT 3
- Muoversi Lombardia: ambiente sandbox HOT 4
- Add securityScheme HOT 2
- lock openapi-resolver to 0.0.2
- bump openapi-resolver to 0.0.3 HOT 1
- Validate external-apis via tox.
- Update references in COMPLIANCE.md
- Metadatazione API caso specifico PA2PA
- Metadata per Umbria
- Metadata Veneto
- Add x-summary and x-project for catalog
- ERROR: json-schema-generator 0.3 has requirement jsonschema==0.8.0, but you'll have jsonschema 3.0.1 which is incompatible. HOT 2
- .env.example PORTAL_ suffix for variables??
- POST /create/user example
- Remove swagger / openapi v2 files
- Remove core-vocabularies as it's in daf-anpr-api
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api-openapi-samples.