Comments (2)
This could simplify Dredd as well. Currently its parse
function returns two results, the media type and the API Elements object. As Dredd needs to know the media type in multiple occasions later on, it's a bit tedious to keep the information together in the rest of the flow. If it's in one package out of the box, that would be nice.
And yes, I know one of the occasions is a dirty "if/else media type" branching, which is something beating the purpose of API Elements, but it's there for backward compatibility. Although scheduled to be removed, it's gonna live with us for a while. Theoretical purity meets reality 🙂
from api-elements.
Yes I think this has been discussed in the past. We need to embed the meta information from the original document inside the api elements it self. It creates a lot of problems and bypasses currently.
What the new doc renderer needs is:
- lineNumber and character possition of ADD in annotations
- Type of the ADD document; I'd rather have the canonical mimetype there than a title. I can assume title title from the mime-type and I can localize it (if needed). The link to spec is a good idea.
from api-elements.
Related Issues (20)
- Guidelines on how to use copy and description
- Single API Elements Package HOT 1
- Hypermedia Affordances
- Annotation "fixits" HOT 1
- Remove `annotation` code HOT 7
- Clarify source map type HOT 11
- Support files in Source Map
- Multiple responses HOT 3
- Document the migration path and changes between API Elements 0.6 and 1.0 HOT 3
- Make `HTTP Headers` an array of `HTTP Header`
- Broken mapping
- Headings have overlapping permalinks
- Link README to production docs HOT 1
- Clarify source map line/column indexing
- Exposing Deployment Information HOT 7
- API Elements evolution process
- Add repo URL for docs HOT 1
- nullable type attribute is undocumented
- Full support for expressing JSON Schema constraints in API Element data structures
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-elements.