From trthorn2 at ncsu.edu Tue Oct 6 11:55:19 2020 From: trthorn2 at ncsu.edu (Trevor Thornton) Date: Tue, 6 Oct 2020 11:55:19 -0400 Subject: [Archivesspace_api_doc_adhoc] ArchivesSpace API documentation check-in Message-ID: Hi- Thanks to everybody who has started working on API documentation. If you're working on a piece of it and haven't added your name to the spreadsheet , please do so we know who's doing what. If you haven't started on anything yet but have time to, please check out the spreadsheet and add your name to the controller and/or endpoints you'd like to work on. Please respond to the list with any questions you have about the work, or feel free to email me personally if you'd prefer. -Trevor -- Trevor Thornton Applications Developer, Digital Library Initiatives North Carolina State University Libraries -------------- next part -------------- An HTML attachment was scrubbed... URL: From dwh2128 at columbia.edu Tue Oct 20 14:46:21 2020 From: dwh2128 at columbia.edu (David W. Hodges) Date: Tue, 20 Oct 2020 14:46:21 -0400 Subject: [Archivesspace_api_doc_adhoc] Some updates for /users/ endpoints Message-ID: Hi all. I made my way through the routes related to user management (users.rb), starting at row 257 of the spreadsheet. I staged my changes in a branch here: https://github.com/dwhodges2/archivesspace/blob/dh-docs-fixes/backend/app/controllers/users.rb I tested the existing shell scripts and added ASnake examples where I could (see below). I have a few questions/observations: 1. I am not sure I understand the distinction between "system" vs. "local" users. One route says "create a local user" and another says "get a list of system users" but they are hitting the same list as far as I can tell. Is this a meaningful distinction, or can we just simplify both to "users"? 2. "Update a user?s groups": I'm not able to confirm this route works. We have users assigned to groups in AS but when I pull any user's info it has groups = []. So I wasn't able to construct or test any examples. Is something deprecated here, or can someone point me to relevant info? 3. Should the "log in" route just refer users to the authentication section? Seems redundant and less informative here. 4. I was unable to work with "become a different user" in either shell or Python. I'm wondering what use case there would be for this, as opposed to just authenticating as a different user. In any case, I left it as it is for now but I think the default shell example needs to be tweaked as I couldn't get it to work. 5. I was not able to figure out Python examples for these: ? "Get a user?s details including their groups for the current repository" ? "Create a local user" Someone more adept at ASnake could maybe weigh in (I don't use it in production at the moment). Dave, should I create a PR for the branch above? Or let me know what the next step should be. Any feedback would be much appreciated. I replicated these notes in the spreadsheet FYI. Thanks, David -- David W. Hodges Special Collections Analyst Columbia University Libraries Butler Library 535 West 114th St. New York, NY 10027 212 854-8758 -------------- next part -------------- An HTML attachment was scrubbed... URL: From dave_mayo at harvard.edu Fri Oct 23 17:25:09 2020 From: dave_mayo at harvard.edu (Mayo, Dave) Date: Fri, 23 Oct 2020 21:25:09 +0000 Subject: [Archivesspace_api_doc_adhoc] Some updates for /users/ endpoints In-Reply-To: References: Message-ID: <2D384756-8CD9-43FF-8C9C-0858C0376A26@harvard.edu> Hi David! I?ll take a look at this over this weekend, and try to answer most of these questions as well. I think I know the answer to #4 - I think is there to support the ?admin can log in as a user to do things/check what the user can view? use case. -- Dave Mayo (he/him) Senior Digital Library Software Engineer Harvard University > HUIT > LTS From: on behalf of "David W. Hodges" Reply-To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" Date: Tuesday, October 20, 2020 at 2:46 PM To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" Subject: [Archivesspace_api_doc_adhoc] Some updates for /users/ endpoints Hi all. I made my way through the routes related to user management (users.rb), starting at row 257 of the spreadsheet. I staged my changes in a branch here: https://github.com/dwhodges2/archivesspace/blob/dh-docs-fixes/backend/app/controllers/users.rb I tested the existing shell scripts and added ASnake examples where I could (see below). I have a few questions/observations: 1. I am not sure I understand the distinction between "system" vs. "local" users. One route says "create a local user" and another says "get a list of system users" but they are hitting the same list as far as I can tell. Is this a meaningful distinction, or can we just simplify both to "users"? 2. "Update a user?s groups": I'm not able to confirm this route works. We have users assigned to groups in AS but when I pull any user's info it has groups = []. So I wasn't able to construct or test any examples. Is something deprecated here, or can someone point me to relevant info? 3. Should the "log in" route just refer users to the authentication section? Seems redundant and less informative here. 4. I was unable to work with "become a different user" in either shell or Python. I'm wondering what use case there would be for this, as opposed to just authenticating as a different user. In any case, I left it as it is for now but I think the default shell example needs to be tweaked as I couldn't get it to work. 5. I was not able to figure out Python examples for these: ? "Get a user?s details including their groups for the current repository" ? "Create a local user" Someone more adept at ASnake could maybe weigh in (I don't use it in production at the moment). Dave, should I create a PR for the branch above? Or let me know what the next step should be. Any feedback would be much appreciated. I replicated these notes in the spreadsheet FYI. Thanks, David -- David W. Hodges Special Collections Analyst Columbia University Libraries Butler Library 535 West 114th St. New York, NY 10027 212 854-8758 -------------- next part -------------- An HTML attachment was scrubbed... URL: From dave_mayo at harvard.edu Mon Oct 26 14:17:42 2020 From: dave_mayo at harvard.edu (Mayo, Dave) Date: Mon, 26 Oct 2020 18:17:42 +0000 Subject: [Archivesspace_api_doc_adhoc] Some updates for /users/ endpoints In-Reply-To: References: Message-ID: <189CD9C0-BC9C-4BDB-85E1-0F26FD7C7900@harvard.edu> Sorry for the delay! Looked into this some: 1. So, it looks like these are two separate distinctions: system means ?including hidden users,? which are: +----------------------------+ | name | +----------------------------+ | Search Indexer | | Public Interface Anonymous | | Staff System User | | Request System User | +----------------------------+ Local? doesn?t as far as I can tell mean anything? It might in context of some plugins, i.e. if someone has a plugin that adds an SSO sign in option, there?d be a distinction, but IMO it looks like it?s not signifying anything in the software as delivered. 2. Hmmm. So, re: users showing up with empty groups, I have run into this before ? IIRC, it might be an issue with permissions ? you need to have admin perms to see other users groups, I think? If it?s not that, then we?ll need to dig in. 3. It definitely ought to have a link, and possibly duplicate some info as well. Honestly, I think cross-linking them would be ideal. 5. I can maybe take a look at writing examples for this tonight. -- Dave Mayo (he/him) Senior Digital Library Software Engineer Harvard University > HUIT > LTS From: on behalf of "David W. Hodges" Reply-To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" Date: Tuesday, October 20, 2020 at 2:46 PM To: "archivesspace_api_doc_adhoc at lyralists.lyrasis.org" Subject: [Archivesspace_api_doc_adhoc] Some updates for /users/ endpoints Hi all. I made my way through the routes related to user management (users.rb), starting at row 257 of the spreadsheet. I staged my changes in a branch here: https://github.com/dwhodges2/archivesspace/blob/dh-docs-fixes/backend/app/controllers/users.rb I tested the existing shell scripts and added ASnake examples where I could (see below). I have a few questions/observations: 1. I am not sure I understand the distinction between "system" vs. "local" users. One route says "create a local user" and another says "get a list of system users" but they are hitting the same list as far as I can tell. Is this a meaningful distinction, or can we just simplify both to "users"? 2. "Update a user?s groups": I'm not able to confirm this route works. We have users assigned to groups in AS but when I pull any user's info it has groups = []. So I wasn't able to construct or test any examples. Is something deprecated here, or can someone point me to relevant info? 3. Should the "log in" route just refer users to the authentication section? Seems redundant and less informative here. 4. I was unable to work with "become a different user" in either shell or Python. I'm wondering what use case there would be for this, as opposed to just authenticating as a different user. In any case, I left it as it is for now but I think the default shell example needs to be tweaked as I couldn't get it to work. 5. I was not able to figure out Python examples for these: ? "Get a user?s details including their groups for the current repository" ? "Create a local user" Someone more adept at ASnake could maybe weigh in (I don't use it in production at the moment). Dave, should I create a PR for the branch above? Or let me know what the next step should be. Any feedback would be much appreciated. I replicated these notes in the spreadsheet FYI. Thanks, David -- David W. Hodges Special Collections Analyst Columbia University Libraries Butler Library 535 West 114th St. New York, NY 10027 212 854-8758 -------------- next part -------------- An HTML attachment was scrubbed... URL: