Comments (7)
@apomelov, are you still on that? Would be great to understand more what you want to achieve.
from api-designer.
@sichvoge , hello. To be honest I'm not using API designer now. I understood it is very difficult for me to support actual specification the same time I develop new features:)
But I'll try to describe my issue. May be it will be helpful for somebody else.
The idea was to specify some context for each raml file to activate correct autocompletion. I can say, that "main.raml" has the "root context". So editor will propose to fill in the title, version and so on. Than I declare a resource /user and include there another file "user.raml". Now I need to declare another context -- "resource context" for "user.raml". In this file editor should propose me to add http methods as top-level elements. In fact, this context could be implicitly inferenced from usage of the file "user.raml".
I'm not sure that "context" is good term for this case but I hope my idea was understood.
from api-designer.
I guess I do get what you mean. Currently the API Designer only knows about one file and can't see what's around it (files included). You suggest that we should make the editor more "context" aware, so that the current "view/editor window" knows about all included files. Am I right?
from api-designer.
big +1 on this. we choose RAML over alternatives because it lets us split stuff into lots of small reusable files. but api-designer currently isn't super useful unless you are only editing the 'main' RAML file.
Date: Wed, 17 Jun 2015 11:47:36 -0700
From: [email protected]
To: [email protected]
Subject: Re: [api-designer] Raml document decomposition (#205)
I guess I do get what you mean. Currently the API Designer only knows about one file and can't see what's around it (files included). You suggest that we should make the editor more "context" aware, so that the current "view/editor window" knows about all included files. Am I right?
—
Reply to this email directly or view it on GitHub.
from api-designer.
OK - seems to be really useful. To make a better justification for that, @robertlevy can I ask you to also provide some more context on the problem which such a feature would solve on your end and what "isn't really useful" means. It would help to better understand what needs to be implemented.
from api-designer.
Over the course of a project we spend way more time tweaking these secondary files (especially schemas and examples) than the main RAML file.
Low hanging fruit would be to have the pretty documentation pane stay open and up to date while changing other files.
Even better would be having autocomplete account for traits/types/schemes defined in other files.
There may also be an opportunity to show smarter error messages but that work probably belongs in the parser rather than the designer
On Jun 17, 2015, at 5:37 PM, Christian Vogel [email protected] wrote:
OK - seems to be really useful. To make a better justification for that, @robertlevy can I ask you to also provide some more context on the problem which such a feature would solve on your end and what "isn't really useful" means. It would help to better understand what needs to be implemented.
—
Reply to this email directly or view it on GitHub.
from api-designer.
"Low hanging fruit would be to have the pretty documentation pane stay open and up to date while changing other files." +1 -> Definitely, especially editing markdown files. The console should also save state and stay at a view when you save a file. Currently, the api console automatically switch back to the list of resources.
"Even better would be having autocomplete account for traits/types/schemes defined in other files." BIG +1
Last but not least, yes - the error management is something we are looking at currently as well, but you are absolutely correct - it's not only the designer. ;)
BTW, if you want to help implementing the discussed topics - I would definitely not mind at all :) Let me know.
from api-designer.
Related Issues (20)
- discriminatorValue not recognized if declared in sub-sub-type (warning) HOT 1
- How can I create a key named value? HOT 6
- Missed request module in dependencies. HOT 7
- Mock Service not accepting multiple occurrences of arrays HOT 1
- Syntax error in RAML 200 tutorial HOT 1
- !include no longer works as array item HOT 6
- API Manager in Anypoint RAML error HOT 4
- Array types not being displayed correctly HOT 1
- Error: /api.raml.meta does not exist HOT 2
- Error: Cannot find module 'request' HOT 15
- Unable to read external schemas in raml HOT 1
- NPM package is out of date HOT 7
- CLI arg --help
- Error when run api-designer HOT 5
- Mocking Service cannot be turned on... HOT 3
- Unable to check examples in README.md
- not able to see the vertical lines in editor
- support for git style versioning/source code control of RAML files
- Request entity too large when trying to save a modified RAML file in API Designer...
- Hosting on Apache displays console error "Cannot read property 'ds' of undefined"
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-designer.