YAP Documentation Error

Status API
Presense
http://developer.yahoo.com/social/rest_api...e-resource.html

URI
http://social.yahooapis.com/v1/user/{guid}/presence/presence

Possible? May be is...
http://social.yahooapis.com/v1/user/{guid}/presence
http://social.yahooapis.com/v1/user/{guid}/status/presence

Move the thread from http://developer.yahoo.net/forum/index.php?showtopic=397 due to no responses

1) Is that a mistake that the URI are the same for 3 different operations GET (insert), PUT (edit), and DELETE (delete)?

2) If not, can you give clear examples on how to do this properly in GET, PUT, DELETE, give a more detail sample application?

Social Directory API > Updates API > Single Update
http://developer.yahoo.com/social/rest_api...e-resource.html
Use this URI to insert, modify, or delete an update for a particular user.

Questions:
1) Is that a mistake that the URI are the same for 3 different operations GET (insert), PUT (edit), and DELETE (delete)?
2) If not, can you give clear examples on how to do this properly in GET, PUT, DELETE, give a more detail sample application?
3) Your current documentation is not detail enough to demonstrate the "how-to". There is too much guessing involved here.

(Copy & Paste from documentation)
Example JSON Response Body for GET
This example gets the update posted by the user specified by the GUID "U7KVXD6ZBCOTL2IFLQH3M5KOIA". The source of the update is APP.-yossd3e.

CODE

http://social.yahooapis.com/v1/user/U7KVXD6ZBCOTL2IFLQH3M5KOIA/updates/APP.-yossd3e/appInstallSuid1?format=json

Example JSON Request Body for PUT
An example of the insert update data on a HTTP PUT:

CODE

http://social.yahooapis.com/v1/user/U7KVXD6ZBCOTL2IFLQH3M5KOIA/updates/APP.-yossd3e/appInstallSuid1?format=json

Example JSON Response Body for DELETE
A sample call for DELETE:

CODE

http://social.yahooapis.com/v1/user/U7KVXD6ZBCOTL2IFLQH3M5KOIA/updates/APP.-yossd3e/appInstallSuid1?format=json

YAP > YML
http://developer.yahoo.com/yap/yml/index.html page
yml:visible-to-owner
yml:visible-to-user

Both items linked to the same page
http://developer.yahoo.com/yap/yml/visible-to-user.html

YAP > YML
http://developer.yahoo.com/yap/yml/index.html page
yml:visible-to-owner
yml:visible-to-user

Both items linked to the same page
http://developer.yahoo.com/yap/yml/visible-to-user.html

YML yml:a
http://developer.yahoo.com/yap/yml/a.html

Possible error?
Both attribute description are the same.

Attribute replace
replace string optional The ID of a DOM node whose contents will be replaced with the output of the view/params specified.
Attribute insert
insert string optional The ID of a DOM node whose contents will be replaced with the output of the view/params specified.

Possible error?
Your attribute description stated the allowed values are "YahooFullView" and "YahooSmallView". Your example use ="my_external_view". Is your description contain error or your example code?
<yml:a params="/path/to/the/page.php?a=b" view="my_external_view">Get more stuff</yml:a>

Problems:
I couldn't figure out how to use insert and replace from your example code. I couldn't get yml:a to show and hide text by adding <div>. If I use <yml:a view="YahooFullView" replace="output">, I couldn't call 2nd Application URL to replace on YahooFullView because each app only allow to submit a single application ID. It seems like there are something missing. It is not clear enough how to use insert and replace.

Attribute view
Name of application view, or developer hosted application page, to link to. The allowed values for application view are "YahooFullView" and "YahooSmallView".

YAP > Status API
http://developer.yahoo.com/social/rest_api...e-resource.html

Are these errors?
1) Example JSON Request Body for PUT is not matching the above Syntax
2) Missing the section for Example XML Response Body for GET

(Copy & Paste from Documentation)
JSON Syntax for PUT

CODE

{
"starttime": "Date",
"endtime": "Date",
"status": "text",
}

Example JSON Request Body for PUT

CODE

{
“status”: “Reading paper”
}

Thanks for responding and explaining so it help us to debug and remove the documentation errors to avoid confusion.

Those links are very useful b/c I couldn't find those documentation in the last 2 weeks.

YAP > YML > yml:form
http://developer.yahoo.com/yap/yml/form.html

Missing example

This is urgent...

Is this possible that you can put a very simple example to demonstrate how to use yml:form Attributes? This would save so much time to guess and trial.

YAP > OAuth
http://developer.yahoo.com/oauth/guide/oauth-auth-flow.html

Is that error?
Missing & on line 4

This refer to another reference link here

This is not an error, since %26 is the URL encoded equivalent of the ampersand (&) symbol.


I'm not sure what you mean by the above comment. Can you rephrase? :)This is a mistake on documentation sample code. I go back and forth to check each sample code, zoom into the method.

http://developer.yahoo.com/social/php_guid...l_tutorial.html

http://developer.yahoo.com/social/php_guid...-using_yql.html

Errors?
1) Error occurred even I used the correct syntax, correct key and secret? I have defined the key and secret. However Canvas View is displaying data from Array $profile, $contacts, $connections, $updates.
Notice: Use of undefined constant CONSUMER_KEY - assumed 'CONSUMER_KEY' in /var/www/html/yahoo/mysocial_yql.php on line 6
Notice: Use of undefined constant CONSUMER_SECRET - assumed 'CONSUMER_SECRET' in /var/www/html/yahoo/mysocial_yql.php on line 7

CODE

// Include client library.
require_once("lib/Yahoo.inc");

// Open Application
define(CONSUMER_KEY,"xxx");
define(CONSUMER_SECRET,"xxx");

// Make sure CONSUMER_KEY et are defined
$session=YahooSession::requireSession(CONSUMER_KEY,CONSUMER_SECRET);

2) Canvas View is missing Array $status, $flickr
Canvas showed Array $profile, $contacts, $connections, $updates. Possible failure on Yahoo server?

CODE

// Define YQL queries for the Social Directory APIs
$profile = "select * from social.profile where guid=me";
$contacts = "select fields.value from social.contacts where guid=me";
$connections = "select * from social.connections where guid=me";
$updates = "select * from social.updates where guid=me";
$status = "select value.status from social.presence where guid=me";
$flickr = "select * from flickr.photos.search where text='Cat' limit 10";

$api_queries = array("Profiles"=>$profile,"Contacts"=>$contacts,"Connections"=>$connections,
                "Updates"=>$updates,"Presence"=>$status,"Flickr"=>$flickr);

Fix error no.2
by limiting each array to 3 data records
Note: There is a limit on how much data you can render within Canvas View. If you exceed the buffer, it won't show the arrays.

CODE

// Define YQL queries for the Social Directory APIs
$profile = "select * from social.profile where guid=me limit 3";
$contacts = "select fields.value from social.contacts where guid=me limit 3";
$connections = "select * from social.connections where guid=me limit 3";
$updates = "select * from social.updates where guid=me limit 3";
$status = "select value.status from social.presence where guid=me limit 3";
$flickr = "select * from flickr.photos.search where text='Cat' limit 3";

$api_queries = array("Profiles"=>$profile,"Contacts"=>$contacts,"Connections"=>$connections,"Updates"=>$updates,"Presence"=>$status,"Flickr"=>$flickr);

Hi vivaty.menlopark,

Since there are a number of posts here...I'm going to list off responses to some of the action items based on your post #:

Post #22
This is a valid concern in the sample code but this is a superficial change. Since the directory path to the SDK is on a user’s server, this path will be changed anyways – this will not affect development but I have sent this same information to the docs team so they will probably revise this in the next docs iteration.

Post #23 & 24
This code sample works perfectly for me. I think this error might come up if you have no contacts or connections (but that's just a guess). Can you verify whether you do have contacts / connections please. With that information we'll take another look.

Post #27
getContactbyGuid is no longer a method in the SDK. I've sent this same note to the docs team that on http://developer.yahoo.com/social/php_guid...l_tutorial.html under “Getting User Contacts”, references to the getContactByGuid method should be removed.

Post #29
#1 – This process seems to work fine for me
#2 – There is an issue with the sample code for this one. Info sent to the docs team as well. On http://developer.yahoo.com/social/php_guid...-using_yql.html under “Querying Private Data” #2 the code needs to be updated.

#2 code sample should work if it's the following:

CODE

// Define YQL queries for the Social Directory APIs  
$profile = "select * from social.profile where guid=me";  
$contacts = "select fields.value from social.contacts where guid=me";  
$connections = "select * from social.connections where owner_guid=me";  
$updates = "select * from social.updates where guid=me";  
$status = "select value.status from social.presence where guid=me";     

$api_queries = array("Profiles"=>$profile,"Contacts"=>$contacts,"Connections"=>$connections,  
                                       "Updates"=>$updates,"Presence"=>$status);

Thank you for taking an interest in helping us build a better system for all developers, and we very much appreciate that you are taking the time to voice your concerns on the forum. I just wished to note that the Y!OS forums are generally moderated by the same people that have built and/or use the platform internally. These teams are working diligently to upgrade the platform with new features, fix bugs assigned in their queues and provide developer help on top of that. We understand your frustration if you're in a time crunch and need immediate responses, but it does take us a moderate amount of time to see your questions, test your code samples / doc changes, inform the appropriate departments and then respond. We appreciate your patience and will do our best to help you as best we can.

Jonathan LeBlanc
Senior Software Engineer
Yahoo! Developer Network

QUOTE (vivaty.menlopark @ Dec 2 2008, 02:31 PM) <{POST_SNAPBACK}>

Post #22

Agree it is superficial. However it should be corrected. Other superficial errors can be harmful if a beginner developer just copy and paste the code like I did.

Post #23
I confirmed that Canvas View won't allow you to define key and secret this way
define(CONSUMER_KEY,"xxx");
define(CONSUMER_SECRET,"xxx");
This define statement will cause errors.

Even I use a safer way to define the key and secret, I am still getting the same error reported on Post#23
$consumerKey = "xxx"
$consumerKeySecret = "xxx"

Note: I do have Contacts, Connections, and Status Message in my Yahoo Profile. I was able to pull the data array via PHP SDK and YQL. In short your mysocial.php sample code is not working. After rendering the $user_profile & $user_updates, it failed on parsing the arrays $user_contacts and the rest.

Post #27
If getContactbyGuid is no longer a method in the SDK, can you check if the sample code here is correct and valid?
$user_contacts = $yahoo_user->getContacts();
foreach($user_contacts as $contact)....
I couldn't parse any contact in this array

Post #29
See my fixes on Post #31. You are welcome to use my code in your sample code. You need to limit on the data within the buffer.

I also create a new application with new API and secret and test mysocial.php. It works. EXCEPT I can't use define statement for key and secret as it generates errors. Once I use the safer method for key and secret, then everything work.