chrome/browser/extensions/api/README.txt - Issue 10391034: Scaffolding for an experimental discovery API letting users inject links in the recommended pane of…

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Side by Side Diff: chrome/browser/extensions/api/README.txt

Issue 10391034: Scaffolding for an experimental discovery API letting users inject links in the recommended pane of… (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Now using IDL and a ProfileKeyedService. Created 8 years, 7 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
(Empty)
	1 This file describes steps and files needed when adding a new API to Chrome.

	2 Before you start coding your new API, though, make sure you follow the process

	3 described at:

	4 http://www.chromium.org/developers/design-documents/extensions/proposed-change s/apis-under-development

	5

	6 This describes the new mechanism for defining API using IDL files. Some old APIs

	7 are still described using a JSON format. Don't rely on these. For inspiration,

	8 you can look at the "alarms" API.

	9

	10 Supposing your API is called "Foo" and is currently experimental, here are the

	11 steps to add it:

	12

	13 1) Write your API specification.
	Aaron Boodman 2012/05/15 00:07:43 We shouldn't recommend that people use IDL, becaus We shouldn't recommend that people use IDL, because support for that is not yet complete. There are some features of the JSON Schema system that are not exposed yet. (In your case, it's fine to leave as IDL though) beaudoin 2012/05/16 16:56:16 Done. Show quoted text On 2012/05/15 00:07:43, Aaron Boodman wrote: > We shouldn't recommend that people use IDL, because support for that is not yet > complete. There are some features of the JSON Schema system that are not exposed > yet. > > (In your case, it's fine to leave as IDL though) Done.
	14 Create "chrome/common/extensions/api/experimental_foo.idl". This file should

	15 contain your complete API description. Look at alarms.idl for inspiration.

	16

	17 2) Add your API to the project

	18 Add "experimental_foo.idl" to the "idl_schema_files" in

	19 "chrome/common/extensions/api/api.gyp".

	20

	21 3) Write the API function handlers.

	22 Create foo_api.cc and foo_api.h under "chrome/browser/extensions/api/foo".
	Aaron Boodman 2012/05/15 00:07:43 Can you add a statement recommending use of JSON S Can you add a statement recommending use of JSON Schema Compiler and an example of where to look? beaudoin 2012/05/16 16:56:16 Done. Show quoted text On 2012/05/15 00:07:43, Aaron Boodman wrote: > Can you add a statement recommending use of JSON Schema Compiler and an example > of where to look? Done.
	23

	24 4) Write support classes for your API.

	25 If your API needs any support classes add them to

	26 "chrome/browser/extensions/api/foo". Some old APIs added their support classes

	27 directly to chrome/browser/extensions. Don't do that.
	Aaron Boodman 2012/05/15 00:07:43 Insert a step about testing here? Insert a step about testing here?
	28

	29 5) Update the project with your new files.

	30 The files you created in (3) and (4) should be added to

	31 "chrome/chrome_browser_extensions.gypi".

OLD	NEW

« no previous file with comments | « no previous file | chrome/browser/extensions/api/app/app_api.cc » ('j') | chrome/browser/extensions/api/discovery/discovery_api.cc » ('J')