WP REST API v2 Documentation Meeting

Welcome!

The WordPress coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. development team builds WordPress! Follow this site for general updates, status reports, and the occasional code debate. There’s lots of ways to contribute:

Found a bugbug A bug is an error or unexpected result. Performance improvements, code optimization, and are considered enhancements, not defects. After feature freeze, only bugs are dealt with, with regressions (adverse changes from the previous version) being the highest priority.? Create a ticket in the bug tracker.

Want to contribute? Get started quickly with tickets marked as good first bugs for new contributors or join a bug scrub. There’s more on the reports page, like patches needing testing, and on feature projects page.

Other questions? Here is a detailed handbook for contributors, complete with tutorials.

Our current documentation for version 2 of the WP REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. is minimal at best. We need your help to build a resource for developers looking to use the WP REST API v2.

Please join us Wednesday 23:00 UTC 2015 in #core-restapi to discuss our documentation workflow, pain-points, and areas of need.

We are especially interested in you if you have:

experience using WP REST API v2
tried to use WP REST API v2, but the lack of documentation drove you away
experience with any of our authentication plugins
front-end skills and ideas on how we can improve our presentation
a passion for writing documentation
a desire to see the WP REST API in CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.
nothing else to do during our meeting time

#documentation, #feature-plugins, #rest-api

Scott Fennell 11:56 pm on September 7, 2015

Thanks so much for your work on this.

I have in fact tried and succeeded at times in using the APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways.. Other times I have failed, and have been frustrated with the docs (and myself) on those occasions.

I won’t be able to attend but I was hoping I could share a pain point I’ve had with the docs. In the auth section, it states

“The API uses nonces with the action set to wp_api”

But the the code sample uses

‘nonce’ => wp_create_nonce( ‘wp_rest’ )

I *believe* this is a typo, given that the arg for wp_create_nonce() is labeled $action : https://codex.wordpress.org/Function_Reference/wp_create_nonce
- Rachel Baker 3:36 pm on September 8, 2015
  
  Scott,
  
  Thank you for pointing out the legacy nonce information in our v2 authentication guide. I went ahead and updated the page: http://v2.wp-api.org/guide/authentication/
  
  If you find anything else, please open an issue in our docs repository: https://github.com/WP-API/docs-v2/issues
thebigA 9:10 am on September 8, 2015

Unfortunately I think that is 2:00 a.m. local time in the UK so I am not going to be able to attend this however I am kinda desperate to see better docs and examples for the APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways.. I had a long conversation with my business partner yesterday on how the lack of decent documentation is hampering efforts to build with the API.

We came to the conclusion that it was foolish to go back to home rolled AJAX and will continue with the REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/.. On this basis I am more than happy to share my experience via helping with documentation and examples
thebigA 11:38 am on September 8, 2015

Actually I think that is one in the morning and whilst I am likely to be Mr Sleepy I will endeavor to attend
Mike 2:46 pm on September 8, 2015

Looking to contribute on the documentation/design end. I’ll be there.
Tim Nash 12:20 pm on September 9, 2015

Sadly the 2am bit means won’t be able to lurk during documentation meeting. But as someone running a Course dedicated to V2 of the APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. I can certainly point to and help flesh out some of the pain points.
Michael Beil 2:46 am on September 12, 2015

I may be able to join for a few minutes.
Peter 9:22 am on September 21, 2015

As with others, since it’s starting at 1am here in the UK I won’t be able to attend, but would be interested in a European-time meeting and continuing this discussion.

Comments are closed.

Welcome!

Communication

Share this: