-
Notifications
You must be signed in to change notification settings - Fork 132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] 491 formal spec reorg #679
Conversation
Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>
Co-authored-by: openfin-johans <98814236+openfin-johans@users.noreply.github.com>
Co-authored-by: openfin-johans <98814236+openfin-johans@users.noreply.github.com>
… past verions, refactors nav and sidebar, first pass at implementations page
…content and correcting structure of document
491 formal spec reorg
… fix headers in intents overview)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a result a launcher can use a shortened URI construct "https://appd.foo.com/api/appd/v2/app1" to resolve the application data vs "https://appd.foo.com/api/appd/v2/app1@appd.foo.com".
Isn't there a potential here to collide with a REST endpoint for the appD?
This is in fact the REST GET endpoint for the appd. Ignore the v1 / v2 mis match in the URL, I put the v2 link in the copy to save updating it later, a different PR from the appD discussion group actually adds the v2 endpoints. We should actually add a comment to the openapi spec about being able to use either the fully qualified app id or bare. I'll take care of that at some point. |
I presume you'll get Hugh's review as well before merging. I'm working with @maoo and @TheJuanAndOnly99 to try and get the preview server up and running so he can look at the complete version |
Yep and ideally other maintainers as well, hence a preview would be very useful! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good, some small comments, a few broken/stale links. Don't see any breaking changes to the spec.
@kriswest I'm happy to file a PR with these changes if you would like.
{doc: 'use-cases/overview', label: 'Use Cases'}, | ||
//{page: 'implementations', label: 'Implementations'}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want this commented out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes for now - its added but shouldn't be linked to/released until populated (and relationship to the FDC3 conformance program worked out). Separate PR raised to enable it:
Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>
@greyseer256 many thanks for the review - changes all applied |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍
Closing to re-create with preview |
resolves #491
resolves #482
resolves #483
prepares for but doesn't close (as page is disabled):
Reorganizes the FDC3 website navigation, introduces an implementations page, an abstract page for the standard and reactors standard content pages to reduce duplication and improve organization