Comments (21)
@harry-wood I changed it to bug and we will try to fix it within our next iteration for the current version od the console (3.x.x).
from api-console.
This is an essential feature. I am wondering why this is not included.
from api-console.
I'm not sure if this is pull request worthy but I'm pasting the patch here in case anyone else is looking to add permalinks with existing UI.
Patch: https://gist.github.com/ravikiranj/d525fc7a07f1339147ed
Demo URL: http://rkjanardhana.com/api-console-dist/#gists
from api-console.
Aha thanks. v4.0.0 looking pretty nice!
In relation to this issue, I notice on this v4.0.0 live demo site, that resource permalinks are working: http://mulesoft.github.io/api-console/#/docs/resources-2-resources-0
from api-console.
+1
from api-console.
Is there an event that gets published when RAML file is successfully parsed and UI load is complete. If yes, can someone point me to it. On this event callback, we can issue clicks to open a specific endpoint that lets us link endpoints using /doc#myendpoint
from api-console.
Hi guys, this feature is in the backlog. We are figuring out how to create a non intrusive router for this issue since there are other projects using API console embedded.
Sorry for not answering before.
from api-console.
Good to hear, thanks!
from api-console.
@jcenturion as a temporarily fix, if I were to link users using `/doc#endpoint``, is there any event I can subcribe to that indicates RAML UI loaded event ?
from api-console.
Something like would totally work for now to be honest. I only need to figure out what event to subscribe to.
$('raml_load_complete').success(function() {
var endpoint = window.location.hash.substr(1)
, dom = document.querySelector( "#" + endpoint + " .raml-console-tab-list .raml-console-tab")
;
if (dom) {
dom.click();
}
});
from api-console.
@ravikiranj: You should do that once the parser finishes at ramlParserWrapper.onParseSuccess
.
from api-console.
I'm confused @jcenturion . Do you mean the anchor linking feature was removed while you're "figuring out how to create a non intrusive router" ?
We forked from this repo at a point in time when anchor linking was still working. After some extensive experimentation looking through the git history, it looks like it was working up until this commit: 902406b "Improve resource autofocus" Jul 2015
from api-console.
We ran into this limitation today. Is there any ETA on when this will be addressed?
from api-console.
@sichvoge Could you please take this question?
Note: I'm not part of this team anymore. If you have any questions about this project please contact @sichvoge. Thanks.
from api-console.
Unless I'm misunderstanding, the label on this should change. Despite the initial description, this is not an enhancement idea. It's a thing which used to work, and was broken.
When it was broken this somehow passed unnoticed for quite a while. I don't really understand how. Are we (TransportAPI) the only ones deploying api-console to our website, and using it for documentation? ...which we need to be able to link to! I mean anchor links to specific resources, is a basic feature of any API documentation site, used for example, when we're answering support queries about how to use our API.
Our documentation site is working fine with this at the moment. Example permalink URL: https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##uk_tube_stations_near_json But that's only because we're running old api-console code from early 2015. We'd like to bring it up to date, but... this basic feature seems to have been accidentally removed.
Maybe it would be better if I create this as a new issue (?)
from api-console.
This feature is working on dev version of the API console.
from api-console.
@jarrodek When you say 'dev version', what do you mean exactly? I was just trying out 'develop' branch, which doesn't seem to have permalinking working. I also looked at 'release/4.0.0' branch, but this seems quite different. Is there lots of work happening on v4.0.0? where do I found out about that?
from api-console.
@harry-wood It is release/4.0.0
. Now the new console is a HTML element that you can use in an application that supports routing. It is now being documented but you can check https://www.npmjs.com/package/api-console-builder node module. If you won't set mainFile
or embedded
option it will generate a console as a standalone application that support routing. Otherwise you can use the console in any application and control the view with path
property.
from api-console.
@harry-wood also see #328
from api-console.
Perfect! Thanks for confirming that it fixes this issue. We are currently preparing the release which is planned for Monday atm.
from api-console.
PROUDLY: Fixed with c74eacd
from api-console.
Related Issues (20)
- Uncaught DOMException: Failed to execute 'define' on 'CustomElementRegistry': the name "oauth2-authorization" has already been used with this registry HOT 1
- Angular10/webpack: Uncaught SyntaxError: redeclaration of formal parameter module HOT 2
- Uncaught DOMException: Failed to execute 'define' on 'CustomElementRegistry' on 6.1.1
- build process fails because of outdated dependencies
- AMF configuration issues HOT 1
- OAuth request elements are duplicated in the API console and API request panel HOT 2
- api-console with react HOT 3
- Hide children endpoints under collapsible top-level endpoints
- [email protected] fails to build standalone app
- API console doesn't render headers from a trait when creating a new endpoint method in RAML extension fragment HOT 1
- URI Parameter is not reflecting properly for endpoints
- Duplicated description, example and header on Types-page
- how to save changes HOT 1
- Build result in web components being registered multiple times
- Documentation not reachable
- api-console giving blank white screen for version 6.6.5 and works only for 6.1.1
- Can not access to document HOT 1
- api-console-a6952 not found or deleted?
- enable https to serve api-console on browser HOT 1
- OAS 3.0 not supported HOT 2
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-console.