Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Request headers (v2)" in "REST API Ref for Edge Add-ons" #3262

Merged
merged 8 commits into from
Sep 9, 2024
Merged

Add "Request headers (v2)" in "REST API Ref for Edge Add-ons" #3262

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2088bd2
Added request header changes for v2 version of the Api
yvsubhash Sep 5, 2024
799f681
Writer/Editor pass
mikehoffms Sep 5, 2024
d143280
clarify lists of required headers
mikehoffms Sep 5, 2024
662128d
tabsets, divider cmts
mikehoffms Sep 5, 2024
41a60c0
tabset terminators
mikehoffms Sep 5, 2024
94550ad
move tabset lead-in
mikehoffms Sep 5, 2024
b3d1579
intro to versions
mikehoffms Sep 6, 2024
83c83fe
Merge branch 'main' into user/syedugundla/docs/edgeaddonsapiv2
mikehoffms Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 39 additions & 13 deletions microsoft-edge/extensions-chromium/publish/api/addons-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ms.author: msedgedevrel
ms.topic: conceptual
ms.service: microsoft-edge
ms.subservice: extensions
ms.date: 11/07/2022
ms.date: 09/05/2024
---
# REST API Reference for Microsoft Edge Add-ons

Expand Down Expand Up @@ -34,11 +34,19 @@ Uploads a package to update an existing draft submission of an add-on product.
|---|---|
| `productID` | Required. The product ID of the product to which the package must be uploaded. |

###### Request headers
###### Request headers (v1)
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved

* Required. `Authorization: Bearer <auth token>`
* Required. `Authorization: Bearer <auth token>`
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved

* Required. `Content-Type: application/zip`

###### Request headers (v2)
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved

* Required. `Authorization: ApiKey <api key>`

* Required. `Content-Type: application/zip`
* Required. `X-ClientID: <client ID>`

* Required. `Content-Type: application/zip`

###### Request body

Expand All @@ -50,7 +58,7 @@ Uploads a package to update an existing draft submission of an add-on product.

###### Response headers

* Location: `{operationID}`
* Location: `{operationID}`

###### Status codes

Expand All @@ -64,7 +72,7 @@ This API has the following expected status codes.


See also:
* Introduction: [Uploading a package to update an existing submission](using-addons-api.md#uploading-a-package-to-update-an-existing-submission)
* Introduction: [Uploading a package to update an existing submission](using-addons-api.md#uploading-a-package-to-update-an-existing-submission)


<!-- ====================================================================== -->
Expand All @@ -86,10 +94,16 @@ Gets the status of the package upload.
|---|---|
| `operationID` | Required. The operation ID of the upload request submitted in the previous step. This information is available in the response header. |

###### Request headers
###### Request headers (v1)

* Required. `Authorization: Bearer <auth token>`

###### Request headers (v2)

* Required. `Authorization: ApiKey <api key>`

* Required. `X-ClientID: <client ID>`

###### Request body

None.
Expand Down Expand Up @@ -158,7 +172,7 @@ This API has the following expected status codes.


See also:
* Introduction: [Checking the status of a package upload](using-addons-api.md#checking-the-status-of-a-package-upload)
* Introduction: [Checking the status of a package upload](using-addons-api.md#checking-the-status-of-a-package-upload)


<!-- ====================================================================== -->
Expand All @@ -180,10 +194,16 @@ Publishes the current draft of the product to Microsoft Edge Add-ons.
|---|---|
| `productID` | Required. The product ID of the product whose draft must be published. |

###### Request headers
###### Request headers (v1)

* Required. `Authorization: Bearer <auth token>`

###### Request headers (v2)

* Required. `Authorization: ApiKey <api key>`

* Required. `X-ClientID: <client ID>`

###### Request body

`<Notes for certification>`, in plain text format.
Expand All @@ -208,7 +228,7 @@ This API has the following expected status codes.


See also:
* Introduction: [Publishing the submission](using-addons-api.md#publishing-the-submission)
* Introduction: [Publishing the submission](using-addons-api.md#publishing-the-submission)


<!-- ====================================================================== -->
Expand All @@ -228,10 +248,16 @@ Checks the status of the publish operation.

None.

###### Request headers
###### Request headers (v1)

* Required. `Authorization: Bearer <auth token>`

###### Request headers (v2)

* Required. `Authorization: ApiKey <api key>`

* Required. `X-ClientID: <client ID>`

###### Request body

None.
Expand Down Expand Up @@ -383,7 +409,7 @@ This API has the following expected status codes.


See also:
* Introduction: [Checking the publishing status](using-addons-api.md#checking-the-publishing-status)
* Introduction: [Checking the publishing status](using-addons-api.md#checking-the-publishing-status)


<!-- ====================================================================== -->
Expand Down Expand Up @@ -411,4 +437,4 @@ Here's a list of common error codes and possible reasons. For a full list, see
<!-- ====================================================================== -->
## See also

* [Using the Microsoft Edge Add-ons REST API](using-addons-api.md)
* [Using the Microsoft Edge Add-ons REST API](using-addons-api.md)