diff --git a/DocuSign-Extensions.md b/DocuSign-Extensions.md index d611da5..2445639 100755 --- a/DocuSign-Extensions.md +++ b/DocuSign-Extensions.md @@ -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. diff --git a/README.md b/README.md index a2dc718..12ef6b9 100755 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ ![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? @@ -22,7 +26,7 @@ We use OpenAPI/Swagger files to build many of our developer tools including our ### 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 @@ -30,7 +34,7 @@ The DocuSign eSignature REST API is updated monthly. The Swagger file in this re ## 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 diff --git a/admin.rest.swagger-v2.1.json b/admin.rest.swagger-v2.1.json index 0866012..10d07d8 100644 --- a/admin.rest.swagger-v2.1.json +++ b/admin.rest.swagger-v2.1.json @@ -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" @@ -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": "", diff --git a/admin.rest.swagger-v2.json b/admin.rest.swagger-v2.json index 53413f8..c894996 100644 --- a/admin.rest.swagger-v2.json +++ b/admin.rest.swagger-v2.json @@ -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" @@ -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": "", diff --git a/click.rest.swagger-v1.json b/click.rest.swagger-v1.json index 06ab49b..b27f0a6 100644 --- a/click.rest.swagger-v1.json +++ b/click.rest.swagger-v1.json @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "www.docusign.net", + "host": "www.demo.docusign.net", "basePath": "/clickapi", "schemes": [ "https" diff --git a/click.rest.swagger-v2.json b/click.rest.swagger-v2.json index 0fbccd7..5e933af 100644 --- a/click.rest.swagger-v2.json +++ b/click.rest.swagger-v2.json @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "www.docusign.net", + "host": "www.demo.docusign.net", "basePath": "/clickapi", "schemes": [ "https" diff --git a/esignature.rest.swagger-v2.1.json b/esignature.rest.swagger-v2.1.json index 478c64c..b6cb1b3 100644 --- a/esignature.rest.swagger-v2.1.json +++ b/esignature.rest.swagger-v2.1.json @@ -1,4 +1,4 @@ -{ + { "swagger": "2.0", "info": { "version": "v2.1", @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "www.docusign.net", + "host": "www.demo.docusign.net", "basePath": "/restapi", "schemes": [ "https" diff --git a/esignature.rest.swagger-v2.json b/esignature.rest.swagger-v2.json index 40e35b2..799daa2 100644 --- a/esignature.rest.swagger-v2.json +++ b/esignature.rest.swagger-v2.json @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "www.docusign.net", + "host": "www.demo.docusign.net", "basePath": "/restapi", "schemes": [ "https" diff --git a/maestro.rest.swagger-v1.0.0.json b/maestro.rest.swagger-v1.0.0.json index 93a1eb9..c62a69d 100644 --- a/maestro.rest.swagger-v1.0.0.json +++ b/maestro.rest.swagger-v1.0.0.json @@ -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" @@ -32,8 +32,7 @@ "in": "path", "name": "accountId", "required": true, - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "type": "string" }, { "description": "Workflow definition ID.", @@ -41,24 +40,21 @@ "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": "", @@ -151,8 +147,7 @@ "in": "path", "name": "instanceId", "required": true, - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "type": "string" } ], "responses": { @@ -224,8 +219,7 @@ "in": "path", "name": "instanceId", "required": true, - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "type": "string" } ], "responses": { @@ -878,8 +872,7 @@ "in": "path", "name": "instanceId", "required": true, - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "type": "string" } ], "responses": { @@ -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": { diff --git a/monitor.rest.swagger-v2.0.json b/monitor.rest.swagger-v2.0.json index 968806e..4a62df9 100644 --- a/monitor.rest.swagger-v2.0.json +++ b/monitor.rest.swagger-v2.0.json @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "lens.docusign.net", + "host": "lens-d.docusign.net", "basePath": "", "schemes": [ "https" diff --git a/monitor.rest.swagger-v2.json b/monitor.rest.swagger-v2.json index e65743b..a1d1787 100644 --- a/monitor.rest.swagger-v2.json +++ b/monitor.rest.swagger-v2.json @@ -11,7 +11,7 @@ "email": "devcenter@docusign.com" } }, - "host": "lens.docusign.net", + "host": "lens-d.docusign.net", "basePath": "", "schemes": [ "https" diff --git a/rooms.rest.swagger-v2.json b/rooms.rest.swagger-v2.json index 247279d..65c22ad 100644 --- a/rooms.rest.swagger-v2.json +++ b/rooms.rest.swagger-v2.json @@ -11,7 +11,7 @@ }, "version": "v2" }, - "host": "rooms.docusign.com", + "host": "demo.rooms.docusign.com", "basePath": "/restapi", "schemes": [ "https" diff --git a/webforms.rest.swagger-v1.1.0.json b/webforms.rest.swagger-v1.1.0.json index 0d11903..b188f02 100644 --- a/webforms.rest.swagger-v1.1.0.json +++ b/webforms.rest.swagger-v1.1.0.json @@ -17,7 +17,7 @@ "DocuSignAuth": [] } ], - "host": "apps.docusign.com", + "host": "apps-d.docusign.com", "basePath": "/api/webforms", "schemes": [ "https" @@ -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",