No description, website, or topics provided.
Java JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client-samples Mail API attachment resource (#7) Sep 12, 2017
specs-by-version Extlib release 9.0.1.v09_02 (#9) Nov 5, 2017
LICENSE Initial commit Mar 2, 2017
README.md 9.0.1 FP10 Jan 31, 2018
calendar.yaml Added alternate content types to POST and PUT operations Apr 13, 2017
data.yaml
directory.yaml Add directory.yaml (#8) Nov 5, 2017
freebusy.yaml Use summary instead of description for each operation Mar 17, 2017
mail.yaml 9.0.1 FP10 Jan 31, 2018

README.md

IBM Domino Access Services API Specifications

Domino Access Services (DAS) is a family of REST APIs. There are separate APIs for:

  • Data (since Domino 8.5.3 UP1)
  • Calendar (since Domino 9.0.1)
  • Freebusy (since Domino 9.0.1 FP10)
  • Mail (since Domino 9.0.1 FP10)
  • Directory (see the XPages extension library)

This repository contains OpenAPI specifications for DAS APIs. Each API has a separate specification. For example, the freebusy API specification is freebusy.yaml.

Recent Revisions

  • README updates for Domino 9.0.1 FP10. The mail and freebusy APIs are now included in FP10. (31-Jan-2018)
  • data.yaml changes for Extension Library version 901v08_01. Also added directory.yaml spec for new directory API. (5-November-2017)
  • mail.yaml changes for Extension Library version 901v08_01 (11-September-2017)
  • data.yaml changes for Domino 9.0.1 FP9 (22-August-2017)
  • wiki page describing how to disable selected DAS resources (22-August-2017)

Uses

You can use these OpenAPI specifications with a broad range of Swagger tools. For example:

  • Use Swagger Codegen to generate client libraries for most popular languages and frameworks. For detailed instructions, see the Generating client code article.

  • Use Swagger UI to view API documentation. When you deploy Swagger UI to your own Domino server, you can even try ad-hoc API requests without writing a line of client code. For deployment instructions, see the Swagger UI on Domino article.

For a quick demo of the Swagger tools and DAS, see the REST API Demonstration video on YouTube.

Sample Client Code

This repository also includes DAS client samples. These samples demonstrate how to use DAS APIs with Swagger generated client libraries. (NOTE: This repository does not include the generated code.)

The samples are not intended to be full-featured applications. Rather, the emphasis is on hands-on learning. You can quickly customize each sample for your own Domino server, learn from working code, and gradually tackle your own application.

To get started with the sample code, see the DAS client samples page.

Specifications by Version

Unless otherwise noted, the OpenAPI specifications in this repository are for the latest versions of Domino and the extension library. Since you may be using an earlier version of an API, we intend to archive earlier versions of the OpenAPI specifications in this repository.

Currently, this repository includes the following versions of each specification:

Release Specifications
Domino 9.0.1 - 9.0.1 FP7 calendar.yaml, data.yaml
Extension Library 901v00_17 calendar.yaml, data.yaml, freebusy.yaml, mail.yaml
Domino 9.0.1 FP8 calendar.yaml, data.yaml
Extension Library 901v08_01 calendar.yaml, data.yaml, freebusy.yaml, mail.yaml
Domino 9.0.1 FP9 calendar.yaml, data.yaml
Extension Library 901v09_01 calendar.yaml, data.yaml, freebusy.yaml, mail.yaml
Extension Library 901v09_02 calendar.yaml, data.yaml, directory.yaml, freebusy.yaml, mail.yaml
Domino 9.0.1 FP10 calendar.yaml, data.yaml, freebusy.yaml, mail.yaml

Contributions

We hope you find this repository useful and encourage you contribute back when possible. For example:

  • If you find a problem with one of the OpenAPI specifications, report the issue. If you are feeling ambitious, fix the problem yourself and create a pull request.

  • If you find a problem with one of the client samples, create a pull request and/or report the issue.

  • Are you an expert in Android, C#, PHP or Ruby? If you don't find a client sample for your favorite language or platform, write your own sample and create a pull request.

References

For more information about Domino Access Services, see the DAS topic on the IBM Notes and Domino Application Development wiki. For DAS APIs added by the XPages Extension Library, see the extlib project on OpenNTF.

For more about the Swagger framework see swagger.io and the Swagger repositories on GitHub.

For more about OpenAPI, see the OpenAPI Specification.

OpenNTF

This project is an OpenNTF project, and is available under the Apache Licence V2.0. All other aspects of the project, including contributions, defect reports, discussions, feature requests and reviews are subject to the OpenNTF Terms of Use - available at http://openntf.org/Internal/home.nsf/dx/Terms_of_Use.