API design request for feedback

Post any bugs, problems or feature requests here.
Brend
Brend
Chriz
Chriz
Mercury
Mercury
Stuiter
Stuiter

API design request for feedback

Post Brend » Thu Jan 17, 2013 7:54 pm
User avatar
Brend
 
Hello developers,

I am currently redesigning the FWURG API: have a look at user:brend:api (styling might require a ctrl+f5).

RIght now, I am looking for feedback from all people that are interested in developing tools for FWURG. I would be especially happy with a critical review of the conceptual idea behind the API, as I have little experience with building this kind of APIs. (An example of something I'm struggling with to represent: page locking for the wiki. Only locked pages should be editted, and the API should only update pages that are locked -- otherwise people that are editting the page could be locked out, while they have the lock...)

Furthermore, I am looking for input with regard to what kind of methods you are looking for. In the optimal case, we should be able to build all tools on top of this API (though this might be in the far future), so don't hesitate to drop a large lists of things you would like to be able to do with the API!
Post Chriz » Thu Jan 17, 2013 8:19 pm
Chriz
 
I guess the post and put are pretty obvious (from the user side) The question for me would be how powerful is the GET functionality? If we can input queries for the wiki data model in there it would be nice.
I am not sure how you would query it
Maybe things like: /system/Lumo_duo_system/zones?class=developed
The javascript strata thing is already pretty nice but this might be more user friendly for smaller tools.
Player of the Praetorian Empire
Post Mercury » Thu Jan 17, 2013 9:43 pm
User avatar
Mercury
Storyteller
 
I like the current strata structure and I'm not honestly looking forward to learning an entirely new query language. That said, if this new api does half the stuff it promises, I'll be happy.

Specifically, I am really looking forward to the Posting in a thread, Posting on the wiki and creating new wiki pages!

What follows now is a list of things I cannot do that would be <Rainbow Dash Voice>So. Awesome.</Rainbow Dash Voice> to have. This is not a criticism of the proposal, nor is it intended as a list of demands, its simply all the cool functions I could possibly dream up in a few minutes that I would love to have.

New / Improved Builders:

  • upload media, rather than just delete
  • check if a certain media object name is taken (i.e. can we upload a file with a specific name?)
  • Create a new thread in a certain forum
  • Check if a certain wiki page exists
  • Append to an existing wiki page

Editing characters or systems using a tool:

  • Load the source code of a wiki page
  • Overwrite a data block only without affecting the rest of a wiki page

Forum analysis tool (things like which character posted how many times in what topic, average posting frequency each day or total number of active players):

  • Get all master accounts
  • Get all accounts belonging to a certain master account
  • Get the associated wiki page for a certain account
  • Retrieve a post X in a topic Y
  • Retrieve all posts in a topic Y
  • Retrieve all topics in a forum Z

More will follow
Post Brend » Fri Jan 18, 2013 1:03 am
User avatar
Brend
 
Mercury wrote:...its simply all the cool functions I could possibly dream up in a few minutes that I would love to have.


Which is exactly what I wanted ^_^

Mercury wrote:More will follow


Yes please.
Post Brend » Fri Jan 18, 2013 1:24 am
User avatar
Brend
 
  • Get some meta-data about a wiki page: title, existance, latest version, authors, etc.
  • Get related pages (rehash from current ad-hoc method)
  • Get followed threads (rehash from current ad-hoc method)
  • Handle batch-locking of wiki pages (or some other flow for 'batch updates' to the wiki -- related to system builder)
  • Get unread posts
  • Get notifications (unread messages, invites, etc.)

Some things that are already possible, that seem like good candidates for 'ease of use' implementations:

  • grab all Work in progress for a certain user
  • Grab all unvalidated
Post Stuiter » Fri Jan 18, 2013 6:06 pm
User avatar
Stuiter
 
looks cool
Post Brend » Fri Jun 28, 2013 4:47 pm
User avatar
Brend
 
Mercury wrote:Forum analysis tool (things like which character posted how many times in what topic, average posting frequency each day or total number of active players):

  • Get all master accounts
  • Get all accounts belonging to a certain master account
  • Get the associated wiki page for a certain account
  • Retrieve a post X in a topic Y
  • Retrieve all posts in a topic Y
  • Retrieve all topics in a forum Z


After looking at some old todo's I had open, this one caught my eye. The forum analysis tool is mostly done, I think, and I might still be interested in offering an API for retrieval of information, but just so I can say it: "Boom! Already done!"

Return to Technical