Add support for "documented_in" annotation in json api schema

Add support for "documented_in" annotation in json api schema

BUG=341275
NOTRY=true

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=260306

[ahernandez, 2014-03-26 22:03:32]

Could you please take a look at this?

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
File chrome/common/extensions/docs/server2/api_data_source_test.py (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/api_data_source_test.py:93: return
Future(value=_FakeNamespace())
I needed to return a namespace object so the addition to reference resolver
doesn't cause failures.

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
File chrome/common/extensions/docs/server2/reference_resolver_test.py (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver_test.py:42: return
Future(value=FakeNamespace())
Same as above.

[not at google - send to devlin, 2014-03-26 22:11:11]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
shouldn't this be "tags/webview"?

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
File chrome/common/extensions/docs/server2/reference_resolver.py (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver.py:117: api_namespace =
self._api_models.GetModel(api_name).Get()
api_model

also this .Get() will be interesting, hopefully it won't slow things down too
much. I guess we'll see.

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver.py:118: api_name =
api_namespace.documentation_options.get('documented_in',
|api_name| is not a correct way to refer to this. perhaps

api_model = ...
filename = api_model.documentation_options.get(
    'documented_in', api_name)

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver.py:121: 'href':
'%s.html#%s-%s' % (api_name, category, name.replace('.', '-')),
we can drop the .html from these now, actually. could you do that file-wide?

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
File chrome/common/extensions/docs/server2/reference_resolver_test.py (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver_test.py:42: return
Future(value=FakeNamespace())
On 2014/03/26 22:03:32, ahernandez.miralles wrote:
> Same as above.

could you prefix them (and the existing classes I suppose) with _ ?

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver_test.py:45: class
APIDataSourceTest(unittest.TestCase):
wow. this should be called ReferenceResolverTest...

[ahernandez, 2014-03-26 22:15:38]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
On 2014/03/26 22:11:11, kalman wrote:
> shouldn't this be "tags/webview"?

I'm not sure actually. It works like this though.

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
File chrome/common/extensions/docs/server2/reference_resolver_test.py (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/doc...
chrome/common/extensions/docs/server2/reference_resolver_test.py:45: class
APIDataSourceTest(unittest.TestCase):
On 2014/03/26 22:11:11, kalman wrote:
> wow. this should be called ReferenceResolverTest...

I didn't even notice... we can pretend it's always been ReferenceResolverTest
now.

[not at google - send to devlin, 2014-03-26 22:20:10]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
On 2014/03/26 22:15:38, ahernandez.miralles wrote:
> On 2014/03/26 22:11:11, kalman wrote:
> > shouldn't this be "tags/webview"?
> 
> I'm not sure actually. It works like this though.

What do you mean it works?

[ahernandez, 2014-03-26 22:23:05]

On 2014/03/26 22:20:10, kalman wrote:
>
https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
> File chrome/common/extensions/api/webview_tag.json (right):
> 
>
https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
> chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
> On 2014/03/26 22:15:38, ahernandez.miralles wrote:
> > On 2014/03/26 22:11:11, kalman wrote:
> > > shouldn't this be "tags/webview"?
> > 
> > I'm not sure actually. It works like this though.
> 
> What do you mean it works?

The links resolve properly (i.e no errors from ReferenceResolver during
integration_test and a manual check confirmed that the links went to the correct
location)

[not at google - send to devlin, 2014-03-26 22:34:07]

> The links resolve properly (i.e no errors from ReferenceResolver during
> integration_test and a manual check confirmed that the links went to the
correct
> location)

which links are we talking about here? If I go to

http://localhost:8000/apps/tags/webview#method-clearData

the "ClearDataOptions" still links to webviewTag.html.

[ahernandez, 2014-03-26 22:37:35]

On 2014/03/26 22:34:07, kalman wrote:
> > The links resolve properly (i.e no errors from ReferenceResolver during
> > integration_test and a manual check confirmed that the links went to the
> correct
> > location)
> 
> which links are we talking about here? If I go to
> 
> http://localhost:8000/apps/tags/webview#method-clearData
> 
> the "ClearDataOptions" still links to webviewTag.html.

Interesting. I just double checked on on mine (I ran preview.py) and it worked.
I'll switch it to "tags/webview" since that works as well.

[not at google - send to devlin, 2014-03-26 22:41:44]

On 2014/03/26 22:37:35, ahernandez.miralles wrote:
> On 2014/03/26 22:34:07, kalman wrote:
> > > The links resolve properly (i.e no errors from ReferenceResolver during
> > > integration_test and a manual check confirmed that the links went to the
> > correct
> > > location)
> > 
> > which links are we talking about here? If I go to
> > 
> > http://localhost:8000/apps/tags/webview#method-clearData
> > 
> > the "ClearDataOptions" still links to webviewTag.html.
> 
> Interesting. I just double checked on on mine (I ran preview.py) and it
worked.
> I'll switch it to "tags/webview" since that works as well.

I patched in the wrong CL :\ 1 sec..

[not at google - send to devlin, 2014-03-26 22:43:32]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
On 2014/03/26 22:20:10, kalman wrote:
> On 2014/03/26 22:15:38, ahernandez.miralles wrote:
> > On 2014/03/26 22:11:11, kalman wrote:
> > > shouldn't this be "tags/webview"?
> > 
> > I'm not sure actually. It works like this though.
> 
> What do you mean it works?

Ok you're right, it works, but the documentation *does* live in "tags/webview"
not "webview" so it puzzles me that it works.

[ahernandez, 2014-03-26 22:46:20]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
On 2014/03/26 22:43:33, kalman wrote:
> On 2014/03/26 22:20:10, kalman wrote:
> > On 2014/03/26 22:15:38, ahernandez.miralles wrote:
> > > On 2014/03/26 22:11:11, kalman wrote:
> > > > shouldn't this be "tags/webview"?
> > > 
> > > I'm not sure actually. It works like this though.
> > 
> > What do you mean it works?
> 
> Ok you're right, it works, but the documentation *does* live in "tags/webview"
> not "webview" so it puzzles me that it works.

I think it has to do with the redirects.

[ahernandez, 2014-03-26 22:46:48]

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
File chrome/common/extensions/api/webview_tag.json (right):

https://codereview.chromium.org/213673002/diff/1/chrome/common/extensions/api...
chrome/common/extensions/api/webview_tag.json:12: "documented_in": "webview"
On 2014/03/26 22:46:21, ahernandez.miralles wrote:
> On 2014/03/26 22:43:33, kalman wrote:
> > On 2014/03/26 22:20:10, kalman wrote:
> > > On 2014/03/26 22:15:38, ahernandez.miralles wrote:
> > > > On 2014/03/26 22:11:11, kalman wrote:
> > > > > shouldn't this be "tags/webview"?
> > > > 
> > > > I'm not sure actually. It works like this though.
> > > 
> > > What do you mean it works?
> > 
> > Ok you're right, it works, but the documentation *does* live in
"tags/webview"
> > not "webview" so it puzzles me that it works.
> 
> I think it has to do with the redirects.

I'll change it to "tags/webview" anyways so it's clear where the file is.

[ahernandez, 2014-03-26 23:19:33]

PTAL

[not at google - send to devlin, 2014-03-26 23:54:58]

lgtm

[not at google - send to devlin, 2014-03-26 23:55:10]

you need to bump app.yaml and cron.yaml versions

[ahernandez, 2014-03-26 23:56:15]

On 2014/03/26 23:55:10, kalman wrote:
> you need to bump app.yaml and cron.yaml versions

The end number or middle number?

[not at google - send to devlin, 2014-03-26 23:58:08]

Let's say the middle.

[ahernandez, 2014-03-27 16:11:50]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-27 16:14:07]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[commit-bot: I haz the power, 2014-03-27 16:34:22]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2014-03-27 16:34:23]

Try jobs failed on following builders:
  tryserver.chromium on linux_chromium_chromeos_clang_dbg

[ahernandez, 2014-03-27 17:50:35]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-27 17:52:19]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[commit-bot: I haz the power, 2014-03-27 21:33:13]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2014-03-27 21:33:13]

Failed to apply patch for chrome/common/extensions/docs/server2/app.yaml:
While running patch -p1 --forward --force --no-backup-if-mismatch;
  patching file chrome/common/extensions/docs/server2/app.yaml
  Hunk #1 FAILED at 1.
  1 out of 1 hunk FAILED -- saving rejects to file
chrome/common/extensions/docs/server2/app.yaml.rej

Patch:       chrome/common/extensions/docs/server2/app.yaml
Index: chrome/common/extensions/docs/server2/app.yaml
diff --git a/chrome/common/extensions/docs/server2/app.yaml
b/chrome/common/extensions/docs/server2/app.yaml
index
324f88c579fc700b27d297af37a8dcf723c6b5a7..325d09d2c11bc2add36206dfac7fc15947706136
100644
--- a/chrome/common/extensions/docs/server2/app.yaml
+++ b/chrome/common/extensions/docs/server2/app.yaml
@@ -1,5 +1,5 @@
 application: chrome-apps-doc
-version: 3-14-5
+version: 3-15-0
 runtime: python27
 api_version: 1
 threadsafe: false

[ahernandez, 2014-03-28 15:31:48]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-28 15:32:27]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[commit-bot: I haz the power, 2014-03-28 16:56:56]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2014-03-28 16:56:56]

Try jobs failed on following builders:
  tryserver.chromium on mac_chromium_rel

[ahernandez, 2014-03-28 19:06:12]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-28 19:10:07]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[commit-bot: I haz the power, 2014-03-28 21:11:18]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2014-03-28 21:11:19]

Failed to apply patch for chrome/common/extensions/docs/server2/app.yaml:
While running patch -p1 --forward --force --no-backup-if-mismatch;
  patching file chrome/common/extensions/docs/server2/app.yaml
  Hunk #1 FAILED at 1.
  1 out of 1 hunk FAILED -- saving rejects to file
chrome/common/extensions/docs/server2/app.yaml.rej

Patch:       chrome/common/extensions/docs/server2/app.yaml
Index: chrome/common/extensions/docs/server2/app.yaml
diff --git a/chrome/common/extensions/docs/server2/app.yaml
b/chrome/common/extensions/docs/server2/app.yaml
index
7b9ac8b18b49a0b0753c71953fa24802ff91a0d1..db123ace763c04523b6c424e666de9fee8532c0e
100644
--- a/chrome/common/extensions/docs/server2/app.yaml
+++ b/chrome/common/extensions/docs/server2/app.yaml
@@ -1,5 +1,5 @@
 application: chrome-apps-doc
-version: 3-15-1
+version: 3-16-0
 runtime: python27
 api_version: 1
 threadsafe: false

[ahernandez, 2014-03-28 21:19:18]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-28 21:20:53]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[not at google - send to devlin, 2014-03-28 21:22:57]

lgtm

use NOTRY=true

[commit-bot: I haz the power, 2014-03-28 23:44:52]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2014-03-28 23:44:52]

Commit queue rejected this change because the description was changed
between the time the change entered the commit queue and the time it
was ready to commit. You can safely check the commit box again.

[ahernandez, 2014-03-28 23:46:40]

The CQ bit was checked by ahernandez.miralles@gmail.com

[commit-bot: I haz the power, 2014-03-28 23:50:48]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/ahernandez.miralles@gmail.com/21367300...

[commit-bot: I haz the power, 2014-03-28 23:55:21]

Change committed as 260306