forked from loafle/openapi-generator-original
0204bf4ae2
commit c5a0d0f7394aa742fa336fff7e7c1d3049761868
Merge: 8c4991ba3ed f8ff8c87609
Author: William Cheng <wing328hk@gmail.com>
Date: Tue Aug 17 18:28:12 2021 +0800
Merge branch 'mustache-linting' of https://github.com/NathanBaulch/openapi-generator into NathanBaulch-mustache-linting
commit f8ff8c87609b1ca36fa26fb8474806999638195e
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Thu Aug 5 14:12:47 2021 +1000
Reorder tags that handle missing values
commit f5d8a33709d6a3f846a9fe4520b78c3d637051d9
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Thu Aug 5 14:08:59 2021 +1000
Use dot notation where possible
commit 493d14921e2333f3ae19ef6fc89318b7e263a80c
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Thu Aug 5 14:10:49 2021 +1000
Remove empty tags
commit 32480dc53f48227d55531b94e307d72671373737
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Thu Aug 5 10:41:58 2021 +1000
Remove redundant sections
commit a8edabd722c34aa094b4aeb11c22664529c3a219
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Wed Aug 4 22:02:22 2021 +1000
Trim extra EOF new lines
commit e89bd7458e3594bf0d30e580bc9408e45b018a57
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date: Wed Aug 4 21:59:26 2021 +1000
Trim trailing whitespace
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
# Nim API client for OpenAPI Petstore (Package: petstore)
|
|
|
|
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
|
|
|
|
## Overview
|
|
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.0.0
|
|
- Package version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.NimClientCodegen
|
|
|
|
## Installation
|
|
|
|
Put the package under your project folder and add the following to the nimble file of your project:
|
|
|
|
```
|
|
import petstore
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
|
|
Module | Proc | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
api_pet | addPet | **POST** /pet | Add a new pet to the store
|
|
api_pet | deletePet | **DELETE** /pet/{petId} | Deletes a pet
|
|
api_pet | findPetsByStatus | **GET** /pet/findByStatus | Finds Pets by status
|
|
api_pet | findPetsByTags | **GET** /pet/findByTags | Finds Pets by tags
|
|
api_pet | getPetById | **GET** /pet/{petId} | Find pet by ID
|
|
api_pet | updatePet | **PUT** /pet | Update an existing pet
|
|
api_pet | updatePetWithForm | **POST** /pet/{petId} | Updates a pet in the store with form data
|
|
api_pet | uploadFile | **POST** /pet/{petId}/uploadImage | uploads an image
|
|
api_store | deleteOrder | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
api_store | getInventory | **GET** /store/inventory | Returns pet inventories by status
|
|
api_store | getOrderById | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
api_store | placeOrder | **POST** /store/order | Place an order for a pet
|
|
api_user | createUser | **POST** /user | Create user
|
|
api_user | createUsersWithArrayInput | **POST** /user/createWithArray | Creates list of users with given input array
|
|
api_user | createUsersWithListInput | **POST** /user/createWithList | Creates list of users with given input array
|
|
api_user | deleteUser | **DELETE** /user/{username} | Delete user
|
|
api_user | getUserByName | **GET** /user/{username} | Get user by user name
|
|
api_user | loginUser | **GET** /user/login | Logs user into the system
|
|
api_user | logoutUser | **GET** /user/logout | Logs out current logged in user session
|
|
api_user | updateUser | **PUT** /user/{username} | Updated user
|
|
|
|
|
|
To generate documentation with Nim DocGen, use:
|
|
|
|
```
|
|
nim doc --project --index:on petstore.nim
|
|
```
|