[Esip-discovery] Notification of next ESIP Discovery Telecon 1:00pm PST / 4:00pm EST today
soren.scott at nsidc.org
Wed May 13 13:23:09 EDT 2015
Doug and Chris (and Steve),
It might be useful to clarify the use cases for Swagger, RAML, or any of those RESTful API documentation frameworks and the alignment with OGC and OpenSearch at least. From our scoping round, there’s two main cases - there’s the basic documentation (defining parameters, route elements) and then there’s the promise (in Swagger) of being able to “Try it out” so generating a correctly formatted request from the method document.
The first is just data entry, really. The second one is where the dependencies in the OGC query parameters *and* their values or the OpenSearch parameters differences between datasets cause problems for any of these frameworks. For example, we’re describing a WMS so we enter WMS for the service and pick a supported version. There’s no place in Swagger to then say if you have selected SERVICE value WMS and VERSION value 1.3.0, the query parameter key is CRS instead of SRS for 1.1.1. Because it doesn’t grok those route or parameter dependencies, the actual generation of a correctly structured URL is back on the dev building the client or the user and not the more generic actionable self-describing services. And where having a solid Swagger and/or RAML OGC extension would be fantastic from a dev point of view. But it’s a modification of the spec and the interface and a conceptual understanding that the Swagger group, as of last fall, felt was an edge case that they wouldn’t support (not their idea of RESTful).
For OpenSearch, it’s a question of not having a way to access the enumerations for a parameter, ie I can’t get a list of dataset names without running the dataset search and understanding how to parse that - pull the granule links and, hopefully, get a new OSDD back or something. We have some numbers about OS services supporting that second level OSDD access. Nothing about differing parameter requirements, though.
I hear whispers of broader implementation of Swagger at different repositories but not of anyone handling the depency issues. And I am very much in favor of someone tackling the first case for things like OGC - just having some structured document that could be used to generate the docs for Swagger or RAML or 19119 or whatever would save so much time. But the second case is more what we’re all after.
My two cents,
On May 12, 2015, at 7:00 AM, Doug Newman via Esip-discovery <esip-discovery at lists.esipfed.org> wrote:
> Now with correct date:
> Doug Newman - ECHO Operations Lead
> douglas.j.newman at nasa.gov
> doug.newman at raytheon.com
> Raytheon Mission Support Solutions Intelligence, Information and Services | NASA | ECS Evolution Development Program
> Note: I am not a government employee and have no legal authority to obligate any federal, state, or local government to perform any action of payment.
> On 5/12/15 8:33 AM, Doug Newman wrote:
>> Ladies and gentlemen,
>> Link: http://wiki.esipfed.org/index.php/Discovery_Telecon_2015-05-11
>> Pending Actions
>> Ruth Duerr: Provide a list of candidates for Service Best Practices and Validators. Done.
>> Doug Newman: Send session ideas to Erin. Done.
>> Continue 'common mechanism for discovering services' discussion
>> Presenting OPeNDAP urls wrt Best Practices - next session
>> Status of Summer ESIP presentations.
>> We have a draft agenda at https://docs.google.com/a/esipfed.org/spreadsheet/ccc?key=0ArDAFB2BsbfRdFpuQnpUVzJNcHM1VmRRY0pITjFSUkE#gid=1
>> 'Global OpenSearch' talk is submitted and waiting for a spot.
>> 'Towards Well Described Web Services' is @ 4pm on Thursday 16th.
>> Webex Info
>> To Join the online portion of the Personal Conference meeting
>> Go to https://esipfed.webex.com
>> Click the “Meeting Center” tab
>> Select the Discovery
>> If a password is required, enter the Meeting Password: 23138372
>> To start the audio portion of the Personal Conference meeting w/ phone
>> Call-in toll-free number (US/Canada): 1-877-668-4493
>> Call-in toll number (US/Canada): +1-408-600-3600
>> Call-in toll number (US/Canada)*: +1-571-918-6008
>> Attendee access code: 231 383 72
>> Doug Newman - ECHO Operations Lead
>> douglas.j.newman at nasa.gov
>> doug.newman at raytheon.com
>> Raytheon Mission Support Solutions Intelligence, Information and Services | NASA | ECS Evolution Development Program
>> Note: I am not a government employee and have no legal authority to obligate any federal, state, or local government to perform any action of payment.
> Esip-discovery mailing list
> Esip-discovery at lists.esipfed.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the Esip-discovery