From 6f71afb4180b55dab7cc98aa717813a70e95e152 Mon Sep 17 00:00:00 2001 From: prafull-opensignlabs <93375423+prafull-opensignlabs@users.noreply.github.com> Date: Thu, 11 Jan 2024 17:08:54 +0530 Subject: [PATCH] Update template section name --- docs/docs/API-docs/opensign.yaml | 341 ++++++++++++++++--------------- 1 file changed, 178 insertions(+), 163 deletions(-) diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 3d5186613..0b51aa9a3 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -1,13 +1,8 @@ +--- openapi: 3.0.3 info: title: OpenSign API v1 - description: |- - This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification. - - Some useful links: - - [Official Website](https://www.opensignlabs.com) - - [Github repo](https://github.com/opensignlabs/opensign) - + description: "This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification. \n\nSome useful links:\n- [Official Website](https://www.opensignlabs.com)\n- [Github repo](https://github.com/opensignlabs/opensign)" termsOfService: http://www.opensignlabs.com/terms/ contact: email: contact@opensignlabs.com @@ -19,29 +14,29 @@ externalDocs: description: Find out more about OpenSign url: http://docs.opensignlabs.com servers: - - url: https://app.opensignlabs.com/api/v1 +- url: https://app.opensignlabs.com/api/v1 tags: - - name: OpenSign - description: OpenSource DocuSign alternative - externalDocs: - description: Find out more - url: http://www.opensignlabs.com - - name: Github repo - description: Access the source code - externalDocs: - description: Visit github - url: http://github.com/opensignlabs/opensign - - name: templates - description: Operations about templates - - name: users - description: Operations about users - - name: documents - description: Operations about documents +- name: OpenSign + description: OpenSource DocuSign alternative + externalDocs: + description: Find out more + url: http://www.opensignlabs.com +- name: Github repo + description: Access the source code + externalDocs: + description: Visit github + url: http://github.com/opensignlabs/opensign +- name: templates + description: Operations about templates +- name: users + description: Operations about users +- name: documents + description: Operations about documents paths: /getuser: put: tags: - - users + - users summary: Update an existing pet description: Update an existing pet by Id operationId: updatePet @@ -59,26 +54,26 @@ paths: $ref: '#/components/schemas/Pet' required: true responses: - '200': + "200": description: Successful operation content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: '#/components/schemas/Pet' application/xml: schema: $ref: '#/components/schemas/Pet' - '400': + "400": description: Invalid ID supplied - '404': + "404": description: Pet not found - '405': + "405": description: Validation exception security: - - api_key: [] + - api_key: [] post: tags: - - users + - users summary: Add a new pet to the store description: Add a new pet to the store operationId: addPet @@ -96,183 +91,199 @@ paths: $ref: '#/components/schemas/Pet' required: true responses: - '200': + "200": description: Successful operation content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: '#/components/schemas/Pet' application/xml: schema: $ref: '#/components/schemas/Pet' - '405': + "405": description: Invalid input security: - - api_key: [] + - api_key: [] /documentlist: get: tags: - - documents + - documents summary: Finds Pets by status description: Multiple status values can be provided with comma separated strings operationId: findPetsByStatus parameters: - - name: status - in: query - description: Status values that need to be considered for filter - required: false - explode: true - schema: - type: string - default: available - enum: - - available - - pending - - sold + - name: status + in: query + description: Status values that need to be considered for filter + required: false + style: form + explode: true + schema: + type: string + default: available + enum: + - available + - pending + - sold responses: - '200': + "200": description: successful operation content: application/json: schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: '#/components/schemas/Pet' application/xml: schema: type: array items: $ref: '#/components/schemas/Pet' - '400': + "400": description: Invalid status value security: - - api_key: [] + - api_key: [] /document/: get: tags: - - documents + - documents summary: Finds Pets by tags - description: Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + description: "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing." operationId: findPetsByTags parameters: - - name: tags - in: query - description: Tags to filter by - required: false - explode: true - schema: - type: array - items: - type: string + - name: tags + in: query + description: Tags to filter by + required: false + style: form + explode: true + schema: + type: array + items: + type: string responses: - '200': + "200": description: successful operation content: application/json: schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: '#/components/schemas/Pet' application/xml: schema: type: array items: $ref: '#/components/schemas/Pet' - '400': + "400": description: Invalid tag value security: - - api_key: [] + - api_key: [] /contact/{contact_id}: get: tags: - - contacts + - contacts summary: Find pet by ID description: Returns a single pet operationId: getPetById parameters: - - name: contact_id - in: path - description: ID of pet to return - required: true - schema: - type: integer - format: int64 + - name: contact_id + in: path + description: ID of pet to return + required: true + style: simple + explode: false + schema: + type: integer + format: int64 responses: - '200': + "200": description: successful operation content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: '#/components/schemas/Pet' application/xml: schema: $ref: '#/components/schemas/Pet' - '400': + "400": description: Invalid ID supplied - '404': + "404": description: Pet not found security: - - api_key: [] + - api_key: [] post: tags: - - contacts + - contacts summary: Updates a pet in the store with form data - description: '' + description: "" operationId: updatePetWithForm parameters: - - name: contact_id - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Name of pet that needs to be updated - schema: - type: string - - name: status - in: query - description: Status of pet that needs to be updated - schema: - type: string + - name: contact_id + in: path + description: ID of pet that needs to be updated + required: true + style: simple + explode: false + schema: + type: integer + format: int64 + - name: name + in: query + description: Name of pet that needs to be updated + required: false + style: form + explode: true + schema: + type: string + - name: status + in: query + description: Status of pet that needs to be updated + required: false + style: form + explode: true + schema: + type: string responses: - '405': + "405": description: Invalid input security: - - api_key: [] + - api_key: [] delete: tags: - - contacts + - contacts summary: Deletes a pet description: delete a pet operationId: deletePet parameters: - - name: api_key - in: header - description: '' - required: false - schema: - type: string - - name: contact_id - in: path - description: Pet id to delete - required: true - schema: - type: integer - format: int64 + - name: api_key + in: header + description: "" + required: false + style: simple + explode: false + schema: + type: string + - name: contact_id + in: path + description: Pet id to delete + required: true + style: simple + explode: false + schema: + type: integer + format: int64 responses: - '400': + "400": description: Invalid pet value security: - - api_key: [] + - api_key: [] /contactlist: post: tags: - - contacts + - contacts summary: uploads an image - description: '' + description: "" operationId: uploadFile requestBody: content: @@ -281,23 +292,23 @@ paths: type: string format: binary responses: - '200': + "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ApiResponse' security: - - api_key: [] + - api_key: [] /createdocument: get: tags: - - documents + - documents summary: Returns pet inventories by status description: Returns a map of status codes to quantities operationId: getInventory responses: - '200': + "200": description: successful operation content: application/json: @@ -307,11 +318,11 @@ paths: type: integer format: int32 security: - - api_key: [] + - api_key: [] /createtemplate: post: tags: - - templates + - templates summary: Place an order for a pet description: Place a new order in the store operationId: placeOrder @@ -327,66 +338,70 @@ paths: schema: $ref: '#/components/schemas/Order' responses: - '200': + "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Order' - '405': + "405": description: Invalid input /template/{template_id}: get: tags: - - templates + - templates summary: Find purchase order by ID description: For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions. operationId: getOrderById parameters: - - name: template_id - in: path - description: ID of order that needs to be fetched - required: true - schema: - type: integer - format: int64 + - name: template_id + in: path + description: ID of order that needs to be fetched + required: true + style: simple + explode: false + schema: + type: integer + format: int64 responses: - '200': + "200": description: successful operation content: application/json: schema: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/Order' application/xml: schema: $ref: '#/components/schemas/Order' - '400': + "400": description: Invalid ID supplied - '404': + "404": description: Order not found delete: tags: - - templates + - templates summary: Delete purchase order by ID description: For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors operationId: deleteOrder parameters: - - name: template_id - in: path - description: ID of the order that needs to be deleted - required: true - schema: - type: integer - format: int64 + - name: template_id + in: path + description: ID of the order that needs to be deleted + required: true + style: simple + explode: false + schema: + type: integer + format: int64 responses: - '400': + "400": description: Invalid ID supplied - '404': + "404": description: Order not found /templatelist: post: tags: - - templates + - templates summary: Create user description: This can only be done by the logged in user. operationId: createUser @@ -437,9 +452,9 @@ components: description: Order Status example: approved enum: - - placed - - approved - - delivered + - placed + - approved + - delivered complete: type: boolean xml: @@ -477,7 +492,7 @@ components: example: CA zip: type: string - example: '94301' + example: "94301" xml: name: address Category: @@ -513,10 +528,10 @@ components: example: john@email.com password: type: string - example: '12345' + example: "12345" phone: type: string - example: '12345' + example: "12345" userStatus: type: integer description: User Status @@ -536,8 +551,8 @@ components: name: tag Pet: required: - - name - - photoUrls + - name + - photoUrls type: object properties: id: @@ -567,9 +582,9 @@ components: type: string description: pet status in the store enum: - - available - - pending - - sold + - available + - pending + - sold xml: name: pet ApiResponse: @@ -606,4 +621,4 @@ components: api_key: type: apiKey name: X-Parse-ApiKey - in: header \ No newline at end of file + in: header