OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

oslc-core message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: [OASIS Issue Tracker] (OSLCCORE-9) Bootstrapping discovery


    [ https://issues.oasis-open.org/browse/OSLCCORE-9?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=60368#comment-60368 ] 

Martin Pain  commented on OSLCCORE-9:
-------------------------------------

I've removed the original proposals from the "proposal" field and the description in order to avoid confusion.

The original proposals are here for the sake of recording the discussion/history:

Primary proposal:
- We define a URI "http://open-services.net/ns/core#resourceDiscoveryRoot"; (note that this is a change in name from the email) to be used as a Link header "rel" URI, where the value of that Link header is the URI pointing to a ServiceProviderCatalog.
- We add to the discovery spec that servers MUST (maybe SHOULD) include that Link header on responses to OPTIONS requests to their web UI home page. The Link header MUST point to a ServiceProviderCatalog. That ServiceProviderCatalog SHOULD allow discovery of all OSLC resources on that server through any of: links to other ServiceProviderCatalogs, links to ServiceProviders, links to LDPCs and/or links to QueryCapabilities.
- We also add to the spec that servers MUST (maybe SHOULD) include that Link header on responses to OPTIONS requests for "any URI that is likely to be seen to represent the OSLC server's root or the OSLC server as a whole". (As this is rather subjective we could make it a non-normative suggestion instead).

Secondary proposal:
- We define a URI "http://open-services.net/ns/core#scopedResourceDiscovery"; (note that this is a change in name from the email) to be used as a Link header "rel" URI, where the value of that Link header is the URI pointing to a ServiceProviderCatalog for the same "scope" as the page it was linking from.
- We add to the discovery spec that when servers split their resources up into different scopes (e.g. teams, projects, tenants) within one server, then the home page for each of those projects MAY use this URI to point to a ServiceProviderCatalog which has the same scope as that page. For example, a project's home page can use it to link to the ServiceProviderCatalog for that project.
- This means that when giving the home page for a project to a client, the client can then say something like "You gave me the link for the 'Project X' scope. By default I'll look in there for resources, but if you want to look in a different project or across the whole server then <click here> (or <change this setting>)." 

> Bootstrapping discovery
> -----------------------
>
>                 Key: OSLCCORE-9
>                 URL: https://issues.oasis-open.org/browse/OSLCCORE-9
>             Project: OASIS OSLC Lifecycle Integration Core (OSLC Core) TC
>          Issue Type: Task
>            Reporter: Martin Pain 
>            Assignee: James Amsden
>
> See https://lists.oasis-open.org/archives/oslc-core/201503/msg00016.html
> The problem is about the user experience's when configuring OSLC clients to connect to OSLC servers. I think having to search a server's documentation and UI to find a discovery URI that is used only once is not a good user experience, and this will come very early in new users' experimentation with OSLC (both developers and administrators).
> The resource the client wants is the "root" ServiceProviderCatalog. The user will be aware of the idea of URIs representing resources, but the resource in their mind is the server, and the URI they associate with the server is most likely the home page of its web UI. So I suggest we define a Link header rel that is used to link that web UI URI to the ServerProviderCatalog URI.
> So then the user's experience will be:
> - They are reading the client's instructions for integrating with OSLC servers.
> - It says to enter the URI to the server's home page.
> - The user copies that from their browser and enters it into the client.
> - The client finds what it needs on the server. (Under the covers: they do a OPTIONS request on the URI that was provided, follow the Link header that has the rel that we define, and request that URI with an Accept header for the content types that they support, and receive the root ServiceProviderCatalog).
> (The original proposal has been moved to a comment on 24th July 2015 to avoid confusion with the revised proposal that is in the "proposal" field above.)



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]