16:00:17 #startmeeting api wg 16:00:18 Meeting started Thu Dec 3 16:00:17 2015 UTC and is due to finish in 60 minutes. The chair is etoews. Information about MeetBot at http://wiki.debian.org/MeetBot. 16:00:19 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 16:00:21 The meeting name has been set to 'api_wg' 16:00:27 hi 16:00:36 hihi 16:00:52 aloha! 16:01:01 o/ 16:01:07 moo 16:01:22 we have a plethora of greetings 16:01:27 hehe 16:01:33 hi everyone! 16:01:45 o/ 16:01:47 'lo! 16:01:48 nice to see so many new nicks! 16:01:58 +1 16:02:03 hi there 16:02:22 #topic agenda 16:02:29 #link https://wiki.openstack.org/wiki/Meetings/API-WG#Agenda 16:02:45 pretty full agenda 16:03:19 #topic previous meeting action items 16:03:31 o/ 16:03:46 sounds like nothing happened in the prev meeting 16:03:55 so the one prior #link http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-11-19-16.00.html 16:04:31 where did elmiko go? 16:04:38 here 16:04:47 o/ 16:04:50 and yea, no one showed for last week's meeting 16:05:09 i think the only action item we had was for rosmaita 16:05:09 us holidays and all 16:05:20 yup 16:05:31 but usually the 00:00 meeting is not well attended 16:05:43 ya... 16:05:56 espcially for folks in and around GMT... 16:06:10 so on my action item ... 16:06:27 i reached out to jamie lennox who wrote the 'version' wiki page 16:06:31 but haven't heard back 16:07:02 the action item was to get the wiki page into a patch for the guidelines 16:07:04 rosmaita: link us to that wiki page 16:07:24 * rosmaita looking 16:07:45 #link https://wiki.openstack.org/wiki/VersionDiscovery 16:08:01 it's really quite good 16:08:31 getting a guideline around that would be great 16:08:49 i'm curious how does this overlap with json-home as well? 16:09:18 rosmaita: beyond being the original author, what did you need to talk to jammielennox about it? 16:09:34 (i notice he's in #openstack-sdks) 16:09:52 etoews: nothing 16:10:09 etoews: i offered to RST it with him as co-author 16:10:18 ah 16:10:22 just feels like plagiarism to submit it myself 16:10:58 in looking at that, that's mostly just a capture of the current world, right? 16:11:05 that looks like what nova already does 16:11:25 sdague: i think so ... and glance, too 16:11:26 I guess the media types are a little different 16:11:36 this doesn't account for microversions 16:12:06 rosmaita: yeah, I get that. license-wise the wiki is creative commons so should be fine without attribution http://creativecommons.org/licenses/by/3.0/ 16:12:19 * edleafe wanders in late... 16:12:21 rosmaita: yeh, co-authored-by is fine 16:12:44 ok, maybe i will just slap it together, then 16:13:12 (i used to be a college professor, so I am kind of sensitive to plagiarism issues ...) 16:13:20 thanks rosmaita 16:13:39 np, will work on it in my "free" time 16:13:44 hehe 16:14:08 rosmaita: if you think it might be helpful, an analysis of how it's currently done could be put into https://wiki.openstack.org/wiki/API_Working_Group/Current_Design 16:14:30 that would be cool 16:14:55 is anyone available to do an analysis that will help rosmaita version discovery guideline? 16:15:47 i can help if no one else is available 16:16:09 thanks elmiko 16:16:31 #action rosmaita to start a guideline for version discovery 16:16:47 #action elmiko to start analysis of current style of version discovery 16:16:58 #topic Glance image import refactor spec, new revision up (patch set 7) (rosmaita) 16:17:29 i don't want to take up too much time, this is just a request to please take a look 16:17:40 i put some specific things to look for on an etherpad: 16:17:50 #link https://etherpad.openstack.org/p/api-wg-glance-import-refactor 16:17:51 #link https://review.openstack.org/#/c/232371/ 16:17:58 thanks! 16:18:12 yep. good to highlight things. 16:18:19 (done) 16:18:37 looks like we already covered the version discovery topic... 16:18:48 #topic adding software projects to the wg (elmiko) 16:18:53 take it away elmiko 16:18:59 cool 16:19:11 so this is a topic that came up at summit 16:19:33 i'm curious about the possibility of expanding the purview of the api-wg slightly to include some software projects 16:19:54 elmiko: ++ I have one in mind :) 16:20:00 initially i thought we might generate some tools to help with the guidelines, but this may not be ideal 16:20:31 annegentle and i talked, very briefly, about things like fairy-slipper maybe falling under our umbrella 16:20:54 my thought was that by adding a few more "crunchy" items to the wg, we might help to add more spark to the excitement 16:21:03 and possibly build a larger footprint for the wg 16:21:27 as well as push forward some of the api related code tools 16:21:50 any have thoughts about this? 16:21:53 basically this group has the most knowledge for testing APIs, and the new framework should enable more tests/comparisons and tie-in to tempest for same requests/responses 16:22:04 so to me it's a natural fit for this group to have core status on that tool 16:22:08 we got pretty excited about this at summit because we saw it was a good way to get engagement that effectively trojan horses the guidelines 16:22:14 or at least those who want to be core and do reviews 16:22:23 heh cdent on the trojan horse 16:22:52 the reality is that guidelines are fun and all, but we seem to slowing down in our progress 16:23:13 i think it would be cool to have more "steam" behind the group, and these projects might be a way to generate it 16:23:59 i've watched as the security project added tooling and it has really helped grow interest in that group. maybe it could work for us as well? 16:24:58 does anyone have objections to pursuing this path? 16:25:16 or is it improper for us to expand the groups intent? 16:25:54 elmiko: it seems perfectly valid 16:26:12 cool! 16:26:53 I also have the nova API subteam on board to work on it 16:27:21 so it seems like a great way to spark interest esp. from those working in this space working together 16:27:33 i have no real objection to this 16:27:33 but i'd be very hesitant to increase the scope of the api wg mission statement 16:27:33 i see this as a "sidecar" effort to the api wg 16:28:13 more concretely, i would want http://specs.openstack.org/openstack/api-wg/ to continue to be focused on guidelines. 16:28:28 s/would/wouldn't/ 16:28:38 gah 16:28:50 I don't think there's any need to expand the mission, thus the "trojan horse stuff" 16:28:57 more concretely, i would want http://specs.openstack.org/openstack/api-wg/ to continue to be focused on guidelines. 16:29:13 ya. how this plugs into the wg is cool with me. 16:29:28 s/how/however/ 16:29:52 is fairy-slipper someone more official than a random github url ? 16:29:56 i can see the specs site remaining focused on the guidelines, but if we were able to create a more generic "landing page" for the wg, would you mind if we had code projects and guidelines there? 16:30:05 It is in a review to be added sdague 16:30:05 it would be nice to roll that into openstack somewhere if we expect we're going to use it 16:30:33 #link https://review.openstack.org/#/c/245352/ 16:30:44 sdague: the docs team can govern if needed but I'd prefer another placement. 16:30:49 elmiko: would the wiki page suffice? https://wiki.openstack.org/wiki/API_Working_Group 16:30:56 sdague: it's interesting, the api-wg repo isn't in projects.yaml anywhere is it? 16:31:07 etoews: i think that would be cool to start with 16:31:15 sdague: it will be added to openstack as soon as we get the core ACLs 16:31:34 annegentle: ok, just reviewed your change, needs an irc channel update 16:31:38 then I can +2 it 16:31:44 etoews: i think it would be awesome if we could one day have something like https://security.openstack.org/ as a home too 16:32:05 sdague: thanks 16:32:30 obviously not that specific url, but you get the idea 16:32:37 sure 16:33:23 elmiko: honestly though developer.openstack.org is what you want 16:33:29 so, i'll keep an eye on fairy-slipper's progress and propose something to the wiki page when it gets included. does that sound fair? 16:33:30 as we brought up at the summit the main challenge with this stuff is bootstrapping: it is supposed to enable more folk but needs more folk for it to be so 16:33:35 elmiko: and contributing to fairy-slipper gets you there 16:33:39 elmiko: sounds good 16:34:23 annegentle: do you see the wg as having a section on dev.os.o? 16:34:23 so i'm cool with this but just a heads up that i wouldn't have any bandwidth to put towards it in the foreseeable future. 16:34:47 elmiko: YES absolutely. 16:34:58 etoews: ack, i'm good with driving on this one for now 16:35:01 elmiko: guidelines/consistency are much desired by the target audience for that site 16:35:11 much, much desired 16:35:20 annegentle: ok, i'll take a look at contributing that site then. thanks 16:36:02 elmiko: do you have a specific action to take as the next step? 16:36:13 hmm 16:36:18 yea 16:36:22 people just have to remember this is a long game, the impacts are already trickling out. We've delayed a few nova api changes to make sure things like limit marker guideline are locked in, so it's consistent going forward 16:36:23 elmiko: it's the api-site repo 16:36:31 sdague: agreed 16:36:47 sdague: yea, i see this effort playing out over the M cycle from our side 16:37:15 ok, what else is on the agenda? 16:37:23 elmiko: as a next action, please review and comment on this spec: https://review.openstack.org/#/c/246660/ 16:37:23 #action elmiko to investigate adding content to developer.openstack.org and the wiki page 16:37:25 #link https://review.openstack.org/#/c/246660/ 16:37:35 elmiko: i don't think sdague is talking in terms of cycles. he's talking in terms of years. 16:37:51 hehe, oop, my bad 16:37:58 but ack, i get it 16:38:08 etoews: yeh, but cycles are half years :) 16:38:15 so they are same order of magnitude 16:38:21 yah 16:38:33 #action elmiko to review and comment on this spec: https://review.openstack.org/#/c/246660/ 16:38:41 okay. time to move on. 16:38:43 when we talked at summit we proposed the idea of adding these projects as something that would take most of the M cycle for us to make action on 16:39:16 elmiko: the next couple of topics have your name on them. did we cover them already? 16:39:31 elmiko: for sure, even that spec I linked to is targeted to M but may have more work to scope 16:39:36 example project is a different beast, i should probably just make a post to the ML about it 16:39:42 elmiko: so the spec narrows to m hopefully 16:39:57 i wanted to get some feedback before i spent crazy time on it, just in case it was a no-go from the start 16:40:09 annegentle: ack 16:40:39 etoews: as for the link guidelines, i just wanted to see what folks were thinking about the LDO vs HAL debate for the guidelines 16:40:41 elmiko: so anything else you want to bring up as a topic right now? 16:40:51 ah 16:40:53 etoews: no, i'm ok skipping it for now 16:41:00 yes. that needs some discussion. 16:41:01 the example project, that is 16:41:17 #topic link guideline 16:41:40 ok, so the pagination guideline has now been updated to follow LDO style, which is what the error guideline was using 16:41:46 but i think there is a wider discussion here 16:42:02 #link https://review.openstack.org/#/c/190743/ 16:42:17 i just noticed the change back to LDO 16:42:43 that's certainly the safe thing to do for now 16:42:52 i tried to get something going on the ML, but didn't get any responses 16:42:55 #link http://lists.openstack.org/pipermail/openstack-dev/2015-November/080291.html 16:43:10 elmiko: I think you hit the tday lull 16:43:16 yea, probably 16:43:17 sorry i didn't get a chance to dig into HAL :( 16:43:18 and how we're entering the xmas lull :( 16:43:38 I've done some HAL in the past but haven't had a chance to review the related thread or spec 16:43:39 from what i could tell, HAL looks nice but i think only jaypipes was championing it 16:43:41 (at least not recently) 16:44:00 * cdent rather likes HAL 16:44:12 is anything using it? 16:44:12 i do think a switch to something like HAL for linking should be a much more deliberate choice rather than throwing it piecemeal into guidelines. 16:44:13 but I'm not sure it has mindshare™ 16:44:15 also, if we recommend HAL it would represent a shift away from what is currently more widely used. 16:44:23 sdague: i don't think so... 16:44:24 when you look at a URL, how can you tell if it's hal or ldo? what are some patterns to look for? 16:44:31 yeh, it doesn't seem worth the transition cost 16:44:44 sdague++ 16:44:48 sdague: i kinda agree 16:45:05 annegentle: these links are within a json body of the response 16:45:10 annegentle: it seems to be mostly just how the metadata is nested 16:45:24 annegentle: the LDO style are what we see mainly see in the current designs #link https://wiki.openstack.org/wiki/API_Working_Group/Current_Design/Links 16:45:34 "links": [ 16:45:34 { 16:45:34 "rel": "help", 16:45:34 "href": "TODO(sdague): example href" 16:45:34 } ] 16:45:45 in my experience all the ways of representing links have proven to be much harder to use in practice than it seems like they should be 16:45:56 vs. 16:45:58 "_links": { 16:45:58 "self": { "href": "/orders/124" }, 16:45:58 "basket": { "href": "/baskets/97213" }, 16:45:58 "customer": { "href": "/customers/12369" } 16:45:59 }, 16:46:07 ah ok 16:46:19 that latter way is _so_ much easier to use if you are seeking a particular rel 16:46:21 i think i know what topic sdague wants to discuss next :) 16:46:51 so, honestly, we should just stick with what we have 16:46:59 it just seems like such a reverse direction to propose (using HAL) 16:47:03 because people already probably have code to get out the keys they want 16:47:11 +1 16:47:13 yah 16:47:29 etoews: I was just trying to find quick examples to clarify :) 16:47:33 well elmiko did the leg work to initiate a discussion on it. 16:47:51 no discussion followed 16:48:04 yeh, I think part of it was the entire conversation was in links 16:48:14 it would be good in future to put examples into the email 16:48:26 because I think most people didn't really know why any of it was relevant 16:48:30 sdague: good suggesstion 16:48:49 sdague: that's fair. people don't click links. 16:48:57 imo, the next step will be to generate a guideline and hash this out in the review 16:49:15 yeh, you have to communicate enough of the problem statement before clicking links, so they are interested enough to follow them 16:49:16 elmiko: it was a week I was off and disabled the lists :) 16:49:26 annegentle: a wise move ;) 16:49:26 elmiko: iff there's someone to champion it 16:49:40 etoews: exactly... 16:49:54 sdague: yea, i need to level up my ML-fu 16:50:15 anybody have a new topic they want to bring up? 16:50:47 etoews: service catalog tng kickoff 16:50:59 tng=the next generation for any non-trekkies :) 16:51:10 we're finally getting things rolling post summit 16:51:13 #topic service catalog tng kickoff 16:51:25 http://lists.openstack.org/pipermail/openstack-operators/2015-December/009061.html is a post out to operator list to get some feedback on one of the open questions 16:51:40 that links to a wiki page, which links to a bunch of other resources, like our pile of etherpads 16:51:51 but it seemed like a thing folks here may want to participate in 16:52:10 weekly meetings kick off next week 16:52:29 sounds cool 16:52:34 mostly fyi for folks here 16:52:41 * cdent wants to get in on that 16:52:53 cdent: come on over 16:53:07 elmiko: you too 16:53:21 there was a fair bit in the summit session of people trying to do things to work around perceived problems in http that aren't really there 16:53:27 so there's plenty of overlap 16:53:41 yeh 16:54:19 it seemed to be of interest to this group. We're running this more like an ephemeral working group right now, the intent is to do this thing (over a few cycles) then disband the effort 16:54:33 having declared success 16:54:47 but it's probably a 3 cycle effort to get there 16:55:25 the idea is to align about the commonalities and define some best practice, then there really isn't much more to be done? 16:55:46 elmiko: no, there are bugs 16:55:52 ah, ok 16:56:00 at least it seemed that way in the summit session 16:56:14 more like mental bugs than tech bugs 16:56:19 right 16:56:34 ah. the source of all bugs. 16:56:37 education bugs 16:57:26 #topic wrap up 16:57:50 we're not going to have time to look at any guidelines but lots of action in the pagination and microservices ones so that's good 16:58:14 sdague: will you have any time in the nearish future to start on the error code documentation effort for http://specs.openstack.org/openstack/api-wg/guidelines/errors.html 16:58:59 etoews: I'll try to do it next week 16:59:20 cool. 16:59:48 thanks everyone! 16:59:59 #endmeeting