Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
petrsvihlik committed Mar 2, 2025
1 parent 25e82c5 commit 175a1f4
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,18 @@ Running the application only makes sense with a WOPI client as its counterpart.

[deployment guidelines](https://learn.microsoft.com/officeonlineserver/deploy-office-online-server)

Note that WopiHost will always be compatible only with the latest version of OOS because Microsoft also [supports only the latest version](https://docs.microsoft.com/en-us/officeonlineserver/office-online-server-release-schedule).
Note that WopiHost will always be compatible only with the latest version of OOS because Microsoft also [supports only the latest version](https://learn.microsoft.com/officeonlineserver/office-online-server-release-schedule).

The deployment of OOS/OWA requires the server to be part of a domain. If your server is not part of any domain (e.g. you're running it in a VM sandbox) it can be overcome by promoting your machine to a [Domain Controller](https://social.technet.microsoft.com/wiki/contents/articles/12370.windows-server-2012-set-up-your-first-domain-controller-step-by-step.aspx).
To test your OWA server [follow the instructions here](https://learn.microsoft.com/office/troubleshoot/administration/test-viewing-documents-by-using-office-online-server-viewer).
To remove the OWA instance use [`Remove-OfficeWebAppsMachine`](http://sharepointjack.com/2014/fun-configuring-office-web-apps-2013-owa/).

#### Microsoft 365 for the Web

You can [use WopiHost to integrate with Microsoft 365 for the web](https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online) which will require:
- onboarding - [apply for CSPP](https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/apply-for-cspp-program)
- extending the provided interfaces to support the required features by Microsoft; we provide a sample implementation of the interfaces that pass the interactive [WOPI-Validator](https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/build-test-ship/validator) tests
- [Test Microsoft 365 for the web integration](https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/build-test-ship/testing)
You can [use WopiHost to integrate with Microsoft 365 for the web](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/online) which will require:
- onboarding - [apply for CSPP](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/online/apply-for-cspp-program)
- extending the provided interfaces to support the required features by Microsoft; we provide a sample implementation of the interfaces that pass the interactive [WOPI-Validator](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/online/build-test-ship/validator) tests
- [Test Microsoft 365 for the web integration](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/online/build-test-ship/testing)

Cobalt
------
Expand Down Expand Up @@ -140,7 +140,7 @@ The `IWopiLockProvider` interface is used to handle file locks. One sample imple

### CheckFileInfo

The [CheckFileInfo](https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo) includes not only details about the file but also some additional properties that can be used by the WOPI client. You can either completely customize the response (by adding your own / missing properties), or update any properties before returning them.
The [CheckFileInfo](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo) includes not only details about the file but also some additional properties that can be used by the WOPI client. You can either completely customize the response (by adding your own / missing properties), or update any properties before returning them.

TODO additional details

Expand Down
2 changes: 1 addition & 1 deletion src/WopiHost.Abstractions/WopiHostCapabilities.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace WopiHost.Abstractions;

/// <summary>
/// Model according to <see href="https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-response#wopi-host-capabilities-properties">WOPI host capabilities properties</see>
/// Model according to <see href="https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-response#wopi-host-capabilities-properties">WOPI host capabilities properties</see>
/// </summary>
public class WopiHostCapabilities : IWopiHostCapabilities
{
Expand Down
8 changes: 4 additions & 4 deletions src/WopiHost.Core/Controllers/FilesController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public async Task<IActionResult> GetFile(
}

// Check expected size
// https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/getfile#request-headers
// https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/getfile#request-headers
var size = file.Exists ? file.Length : 0;
if (maximumExpectedSize is not null &&
size > maximumExpectedSize.Value)
Expand All @@ -136,7 +136,7 @@ public async Task<IActionResult> GetFile(
}

// Returns optional version
// https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/getfile#response-headers
// https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/getfile#response-headers
if (file.Version is not null)
{
Response.Headers[WopiHeaders.WOPI_ITEM_VERSION] = file.Version;
Expand Down Expand Up @@ -170,7 +170,7 @@ public async Task<IActionResult> PutFile(
return Unauthorized();
}

// https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/scenarios/createnew
// https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/online/scenarios/createnew
var file = StorageProvider.GetWopiFile(id);
// If ... missing altogether, the host should respond with a 409 Conflict
if (file is null)
Expand Down Expand Up @@ -258,7 +258,7 @@ public async Task<IActionResult> ProcessCobalt(
}

/// <summary>
/// Returns a CheckFileInfo model according to https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo
/// Returns a CheckFileInfo model according to https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo
/// </summary>
/// <param name="file">File properties of which should be returned.</param>
/// <param name="cancellationToken">Cancellation token</param>
Expand Down
2 changes: 1 addition & 1 deletion src/WopiHost/Startup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ private static Task<WopiCheckFileInfo> GetWopiCheckFileInfo(WopiCheckFileInfoCon
wopiCheckFileInfo.ClientUrl = new("https://example.com/client");
wopiCheckFileInfo.FileEmbedCommandUrl = new("https://example.com/embed");

// https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-other#breadcrumb-properties
// https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-other#breadcrumb-properties
wopiCheckFileInfo.BreadcrumbBrandName = "WopiHost";
wopiCheckFileInfo.BreadcrumbBrandUrl = new("https://example.com");
wopiCheckFileInfo.BreadcrumbDocName = "test";
Expand Down

0 comments on commit 175a1f4

Please sign in to comment.