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.

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

Updated host urls. Added new specs within README.md. #111

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions DocuSign-Extensions.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# DocuSign Vendor specific Extensions
# Docusign Vendor specific Extensions

The Swagger and OpenAPI specifications enable vendor specific extensions throughout Swagger files.
The extensions must start with the letter x. All DocuSign extensions start with `x-ds-`.
The extensions must start with the letter x. All Docusign extensions start with `x-ds-`.

## Categories, Resources, Methods
The OpenAPI specification does not focus on the idea of resources for APIs.
In particular, the OpenAPI `tags` element can be used to add multiple tags to a method.

DocuSign assigns each method to exactly one **resource**. Resources are usually plural nouns.
Docusign assigns each method to exactly one **resource**. Resources are usually plural nouns.
They start with a capital letter.

Methods are verbs. They are lower case.
Expand Down
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
![alt text](OpenAPI.png)

# DocuSign OpenAPI Specifications
# Docusign OpenAPI Specifications

DocuSign uses the OpenAPI (OAI) Specification - formerly known as "Swagger" - to describe its REST APIs. The goal of the OAI specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service. For more info see the official [OAI](https://github.com/OAI/OpenAPI-Specification) spec.
Docusign uses the OpenAPI (OAI) Specification - formerly known as "Swagger" - to describe its REST APIs. The goal of the OAI specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service. For more info see the official [OAI](https://github.com/OAI/OpenAPI-Specification) spec.

## The Swagger file

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json) `esignature.rest.swagger-v2.1.json` - the full swagger file for DocuSign's eSignature REST API v2.1
![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json) `esignature.rest.swagger-v2.1.json` - the full swagger file for Docusign's eSignature REST API v2.1

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.json) `esignature.rest.swagger-v2.json` - the full swagger file for DocuSign's eSignature REST API v2
![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.json) `esignature.rest.swagger-v2.json` - the full swagger file for Docusign's eSignature REST API v2

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/rooms.rest.swagger-v2.json) `rooms.rest.swagger-v2.json` - the full swagger file for DocuSign's Rooms API v2
![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/rooms.rest.swagger-v2.json) `rooms.rest.swagger-v2.json` - the full swagger file for Docusign's Rooms API v2

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/click.rest.swagger-v2.json) `click.rest.swagger-v2.json` - the full swagger file for DocuSign's Click API v1
![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/click.rest.swagger-v2.json) `click.rest.swagger-v2.json` - the full swagger file for Docusign's Click API v1

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/admin.rest.swagger-v2.json) `admin.rest.swagger-v2.json` - the full swagger file for DocuSign's Admin API v2 and v2.1
![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/admin.rest.swagger-v2.json) `admin.rest.swagger-v2.json` - the full swagger file for Docusign's Admin API v2 and v2.1

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/maestro.rest.swagger-v1.0.0.json) `maestro.rest.swagger-v1.0.0.json` - the full swagger file for Docusign's Maestro API v1

![](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/webforms.rest.swagger-v1.1.0.json) `webforms.rest.swagger-v1.1.0.json` - the full swagger file for Docusign's WebForms API v1.1

## What can I do with a Swagger file?

We use OpenAPI/Swagger files to build many of our developer tools including our [client SDKs](https://developers.docusign.com/docs/esign-rest-api/sdk-tools) using `swagger-codegen`. We also use the OAI specification to build our [API Docs](https://docs.docusign.com/esign/) and [API Explorer](https://apiexplorer.docusign.com/#/) tools. What will you build? Let us know by filing an issue in this repository.

### Vendor-specific extensions

Some post-processing is performed on our eSignature Swagger spec which includes adding a number of vendor-specific extensions prefixed with `x-ds-`. See the [DocuSign-Extensions.md](DocuSign-Extensions.md) file for more information.
Some post-processing is performed on our eSignature Swagger spec which includes adding a number of vendor-specific extensions prefixed with `x-ds-`. See the [Docusign-Extensions.md](Docusign-Extensions.md) file for more information.

### Releases

The DocuSign eSignature REST API is updated monthly. The Swagger file in this repository is also updated monthly. See the "Releases" tab for version information. The current release information is available from the [Developer Account (demo)](https://demo.docusign.net/restapi/service_information) and [production](https://www.docusign.net/restapi/service_information) platforms.

## Support

Please log issues through GitHub. We also have an active developer community on Stack Overflow, search the [DocuSignAPI](http://stackoverflow.com/questions/tagged/docusignapi) tag.
Please log issues through GitHub. We also have an active developer community on Stack Overflow, search the [DocusignAPI](http://stackoverflow.com/questions/tagged/docusignapi) tag.

## License

Expand Down
6 changes: 3 additions & 3 deletions admin.rest.swagger-v2.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/developers"
},
"host": "api.docusign.net",
"host": "api-d.docusign.net",
"basePath": "/Management",
"schemes": [
"https"
Expand Down Expand Up @@ -8275,8 +8275,8 @@
"type": "oauth2",
"description": "OAuth2 Access code Grant",
"flow": "accessCode",
"authorizationUrl": "https://account.docusign.com/oauth/auth",
"tokenUrl": "https://account.docusign.com/oauth/auth",
"authorizationUrl": "https://account-d.docusign.com/oauth/auth",
"tokenUrl": "https://account-d.docusign.com/oauth/auth",
"scopes": {
"organization_read": "",
"user_data_redact": "",
Expand Down
6 changes: 3 additions & 3 deletions admin.rest.swagger-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/developers"
},
"host": "api.docusign.net",
"host": "api-d.docusign.net",
"basePath": "/Management",
"schemes": [
"https"
Expand Down Expand Up @@ -5869,8 +5869,8 @@
"type": "oauth2",
"description": "OAuth2 Access code Grant",
"flow": "accessCode",
"authorizationUrl": "https://account.docusign.com/oauth/auth",
"tokenUrl": "https://account.docusign.com/oauth/auth",
"authorizationUrl": "https://account-d.docusign.com/oauth/auth",
"tokenUrl": "https://account-d.docusign.com/oauth/auth",
"scopes": {
"organization_read": "",
"permission_read": "",
Expand Down
2 changes: 1 addition & 1 deletion click.rest.swagger-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "www.docusign.net",
"host": "www.demo.docusign.net",
"basePath": "/clickapi",
"schemes": [
"https"
Expand Down
2 changes: 1 addition & 1 deletion click.rest.swagger-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "www.docusign.net",
"host": "www.demo.docusign.net",
"basePath": "/clickapi",
"schemes": [
"https"
Expand Down
4 changes: 2 additions & 2 deletions esignature.rest.swagger-v2.1.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
{
"swagger": "2.0",
"info": {
"version": "v2.1",
Expand All @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "www.docusign.net",
"host": "www.demo.docusign.net",
"basePath": "/restapi",
"schemes": [
"https"
Expand Down
2 changes: 1 addition & 1 deletion esignature.rest.swagger-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "www.docusign.net",
"host": "www.demo.docusign.net",
"basePath": "/restapi",
"schemes": [
"https"
Expand Down
27 changes: 10 additions & 17 deletions maestro.rest.swagger-v1.0.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"title": "Maestro API",
"version": "1.0.0"
},
"host": "apps.docusign.com",
"host": "apps-d.docusign.com",
"basePath": "/api/maestro",
"schemes": [
"https"
Expand All @@ -32,33 +32,29 @@
"in": "path",
"name": "accountId",
"required": true,
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
},
{
"description": "Workflow definition ID.",
"format": "uuid",
"in": "path",
"name": "workflowDefinitionId",
"required": true,
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
},
{
"description": "Managed Token Id registered with Docusign Account Server",
"format": "uuid",
"in": "query",
"name": "mtid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
},
{
"description": "Managed Token Secret registered with Docusign account server",
"format": "uuid",
"in": "query",
"name": "mtsec",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
},
{
"description": "",
Expand Down Expand Up @@ -151,8 +147,7 @@
"in": "path",
"name": "instanceId",
"required": true,
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
}
],
"responses": {
Expand Down Expand Up @@ -224,8 +219,7 @@
"in": "path",
"name": "instanceId",
"required": true,
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
}
],
"responses": {
Expand Down Expand Up @@ -878,8 +872,7 @@
"in": "path",
"name": "instanceId",
"required": true,
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
"type": "string"
}
],
"responses": {
Expand Down Expand Up @@ -3614,14 +3607,14 @@
},
"securityDefinitions": {
"DSAuth": {
"authorizationUrl": "https://account-tk1.tk.docusign.dev/oauth/auth",
"authorizationUrl": "https://account-d.docusign.com/oauth/auth",
"description": "Docusign AuthN/AuthZ",
"flow": "accessCode",
"scopes": {
"aow_manage": "Manage workflows scope",
"signature": "Using signature scope"
},
"tokenUrl": "https://account-tk1.tk.docusign.dev/oauth/token",
"tokenUrl": "https://account-d.docusign.com/oauth/token",
"type": "oauth2"
},
"DSBearerAuth": {
Expand Down
2 changes: 1 addition & 1 deletion monitor.rest.swagger-v2.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "lens.docusign.net",
"host": "lens-d.docusign.net",
"basePath": "",
"schemes": [
"https"
Expand Down
2 changes: 1 addition & 1 deletion monitor.rest.swagger-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"email": "devcenter@docusign.com"
}
},
"host": "lens.docusign.net",
"host": "lens-d.docusign.net",
"basePath": "",
"schemes": [
"https"
Expand Down
2 changes: 1 addition & 1 deletion rooms.rest.swagger-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
"version": "v2"
},
"host": "rooms.docusign.com",
"host": "demo.rooms.docusign.com",
"basePath": "/restapi",
"schemes": [
"https"
Expand Down
6 changes: 3 additions & 3 deletions webforms.rest.swagger-v1.1.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"DocuSignAuth": []
}
],
"host": "apps.docusign.com",
"host": "apps-d.docusign.com",
"basePath": "/api/webforms",
"schemes": [
"https"
Expand Down Expand Up @@ -574,8 +574,8 @@
"DocuSignAuth": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://account-tk1.tk.docusign.dev/oauth/auth",
"tokenUrl": "https://account-tk1.tk.docusign.dev/oauth/token",
"authorizationUrl": "https://account-d.docusign.com/oauth/auth",
"tokenUrl": "https://account-d.docusign.com/oauth/token",
"scopes": {
"webforms_read": "Read web form configuration",
"webforms_write": "Create web form and modify web form configuration",
Expand Down