### Docusign OpenAPI Vendor Extensions Overview

Source: https://github.com/docusign/openapi-specifications/blob/master/DocuSign-Extensions.md

Explains the general convention for Docusign's vendor-specific extensions in OpenAPI/Swagger files, which must start with `x-ds-`.

```APIDOC
Vendor Extensions:
  Prefix: x-ds-
  Purpose: Custom Docusign-specific elements within OpenAPI/Swagger specifications.
```

--------------------------------

### Docusign API OpenAPI (Swagger) File References

Source: https://github.com/docusign/openapi-specifications/blob/master/README.md

This section lists the full OpenAPI (Swagger) specification files for various Docusign REST APIs, including eSignature, Rooms, Click, Admin, Maestro, WebForms, and Navigator. These files define the API interfaces and are used for generating SDKs and API documentation.

```APIDOC
esignature.rest.swagger-v2.1.json - the full swagger file for Docusign's eSignature REST API v2.1
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json
```

```APIDOC
esignature.rest.swagger-v2.json - the full swagger file for Docusign's eSignature REST API v2
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.json
```

```APIDOC
rooms.rest.swagger-v2.json - the full swagger file for Docusign's Rooms API v2
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/rooms.rest.swagger-v2.json
```

```APIDOC
click.rest.swagger-v2.json - the full swagger file for Docusign's Click API v1
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/click.rest.swagger-v2.json
```

```APIDOC
admin.rest.swagger-v2.json - the full swagger file for Docusign's Admin API v2 and v2.1
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/admin.rest.swagger-v2.json
```

```APIDOC
maestro.rest.swagger-v1.0.0.json - the full swagger file for Docusign's Maestro API v1
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/maestro.rest.swagger-v1.0.0.json
```

```APIDOC
webforms.rest.swagger-v1.1.0.json - the full swagger file for Docusign's WebForms API v1.1
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/webforms.rest.swagger-v1.1.0.json
```

```APIDOC
navigator.rest.swagger.json - the full swagger file for Docusign's Navigator API
URL: https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/navigator.rest.swagger.json
```

--------------------------------

### OpenAPI Methods Structure and Parameters

Source: https://github.com/docusign/openapi-specifications/blob/master/DocuSign-Extensions.md

Outlines the key parameters and Docusign-specific extensions used for defining methods within the OpenAPI specification, including their resource association and naming conventions for documentation and SDKs.

```APIDOC
Method Definition:
  Resource Name Location: tags[0]
  Important Parameters:
    description: string (markdown format)
    operationId: string (unique throughout Swagger file)
    summary: string (markdown format)
    x-ds-in-sdk: boolean (is method included in SDK? Not used)
    x-ds-method: string (method name within resource's scope, used in API documentation)
    x-ds-methodname: string (method name within category's scope, used in SDKs)
    x-ds-service: string (owning category for the method)
```

--------------------------------

### OpenAPI Resources Structure and Extensions

Source: https://github.com/docusign/openapi-specifications/blob/master/DocuSign-Extensions.md

Describes how resources are defined within the OpenAPI file, including their identification via `tags[0]`, extended descriptions, and specific Docusign extensions for categorization and SDK generation.

```APIDOC
Resource Definition:
  Location: tags[0] within method's operation definition
  Description: Only one element of the `tags` array is used.
  Extended Descriptions: Top-level `tags` array holds markdown descriptions.
  Matching: Resource name matches a definition name (starts with capital letter).
  Resource Definition Extensions:
    x-ds-category: string (name of owning category, matches `x-ds-categories` name)
    x-ds-definition-name: string (name for SDK generation)
    x-ds-order: integer (for ordering, not used)
    x-ms-summary: string (not used)
```

--------------------------------

### Common Docusign API Method Names

Source: https://github.com/docusign/openapi-specifications/blob/master/DocuSign-Extensions.md

Lists common HTTP methods used across Docusign resources, along with their typical actions.

```APIDOC
Common Methods:
  - Method: create
    HTTP Method: POST
    Description: creates a new resource instance
  - Method: get
    HTTP Method: GET
    Description: get a single instance of the resource
  - Method: list
    HTTP Method: GET
    Description: list current resources
  - Method: delete
    HTTP Method: DELETE
    Description: delete a resource
  - Method: update
    HTTP Method: PUT
    Description: update a resource
```

--------------------------------

### OpenAPI Categories Structure (x-ds-categories)

Source: https://github.com/docusign/openapi-specifications/blob/master/DocuSign-Extensions.md

Details the structure of the top-level `x-ds-categories` element, an array of Category objects, and their associated parameters.

```APIDOC
x-ds-categories:
  Type: array of Category objects
  Description: Top-level element for grouping resources into categories.
  Category Object Parameters:
    name: string (markdown format)
    description: string (markdown format)
    summary: string (markdown format)
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.