Skip to content

Commit bf77519

Browse files
authored
Add privacy and security discussion in index.bs
1 parent d6b9e44 commit bf77519

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

index.bs

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ p + dl.props { margin-top: -0.5em; }
4040

4141
For now, see the [explainer](https://github.com/webmachinelearning/proofreader-api/blob/main/README.md).
4242

43+
<h2 id="dependencies">Dependencies</h2>
44+
45+
These APIs are part of a family of APIs expected to be powered by machine learning models, which share common API surface idioms and specification patterns. Currently, the specification text for these shared parts lives in [[WRITING-ASSISTANCE-APIS#supporting]], and the common privacy and security considerations are discussed in [[WRITING-ASSISTANCE-APIS#privacy]] and [[WRITING-ASSISTANCE-APIS#security]]. Implementing these APIs requires implementing that shared infrastructure, and conforming to those privacy and security considerations. But it does not require implementing or exposing the actual writing assistance APIs. [[!WRITING-ASSISTANCE-APIS]]
46+
4347
<h2 id="proofreader-api">The proofreader API</h2>
4448

4549
<xmp class="idl">
@@ -393,7 +397,7 @@ The <dfn attribute for="Proofreader">correctionExplanationLanguage</dfn> getter
393397

394398
The proofreading should conform to the guidance given by |includeCorrectionTypes| and |includeCorrectionExplanations|.
395399

396-
The proofreading process must conform to the guidance given in [[#privacy]] and [[#security]], notably including (but not limited to) [[#privacy-user-input]] and [[#security-runtime]].
400+
The proofreading process must conform to the guidance given in [[#privacy]] and [[#security]], notably including (but not limited to) [[WRITING-ASSISTANCE-APIS#privacy-user-input]] and [[WRITING-ASSISTANCE-APIS#security-runtime]].
397401

398402
If |correctionExplanationLanguage| is non-null, the proofreading should be in that language. Otherwise, it should be in the language of |input|. If |input| contains multiple languages, or the language of |input| cannot be detected, then either the correction explanation language is [=implementation-defined=], or the implementation may treat this as an error, per the guidance in [[#proofreader-errors]].
399403

@@ -534,31 +538,11 @@ When proofreading fails, the following possible reasons may be surfaced to the w
534538

535539
Access to the proofreader API is gated behind the [=policy-controlled feature=] "<dfn permission>proofreader</dfn>", which has a [=policy-controlled feature/default allowlist=] of <code>[=default allowlist/'self'=]</code>.
536540

537-
<h2 id="supporting">Shared infrastructure</h2>
538-
539-
<h3 id="shared-apis">Common APIs</h3>
540-
541-
<xmp class="idl">
542-
[Exposed=Window, SecureContext]
543-
interface CreateMonitor : EventTarget {
544-
attribute EventHandler ondownloadprogress;
545-
};
546-
547-
callback CreateMonitorCallback = undefined (CreateMonitor monitor);
548-
549-
enum Availability {
550-
"unavailable",
551-
"downloadable",
552-
"downloading",
553-
"available"
554-
};
555-
</xmp>
556-
557541
<h2 id="privacy">Privacy considerations</h2>
558542

559-
<h3 id="privacy-user-input">User input</h3>
543+
Please see [[WRITING-ASSISTANCE-APIS#privacy]] for a discussion of privacy considerations for the translator and language detector APIs. That text was written to apply to all APIs sharing the same infrastructure, as noted in [[#dependencies]].
560544

561545
<h2 id="security">Security considerations</h2>
562546

563-
<h3 id="security-runtime">Runtime shared resources</h3>
547+
Please see [[WRITING-ASSISTANCE-APIS#security]] for a discussion of security considerations for the translator and language detector APIs. That text was written to apply to all APIs sharing the same infrastructure, as noted in [[#dependencies]].
564548

0 commit comments

Comments
 (0)