Module

petstore_api

Module petstore_api

API

Client

Definitions

ApiResponse
Category
ClientHttp1Settings
ConnectionConfig
OAuth2ClientCredentialsGrantConfig
Pet
ProxyConfig
Tag

mohanadarshanvivekanandalingam/petstore_api

1.0.0

Prints "Hello, World!" with a main function. [//]: # (above is the module summary)

Module Overview

Provides an overview about the module when generating the API documentations. For example, refer to https://lib.ballerina.io/ballerina/io/latest

Clients

petstore_api: Client

Isolated

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://9ed865fb-bc42-4d51-ba77-92afd494df76-prod.e1-us-east-azure.choreoapis.dev/u7tw/petstore/1.0.0" - URL of the target service

updatePet

Isolated FunctionRemote Function
function updatePet(Pet payload) returns Pet|error

Update an existing pet

Parameters
  • payload Pet - Update an existent pet in the store
Return Type

addPet

Isolated FunctionRemote Function
function addPet(Pet payload) returns Pet|error

Add a new pet to the store

Parameters
  • payload Pet - Create a new pet in the store
Return Type

findPetsByTags

Isolated FunctionRemote Function
function findPetsByTags(string[]? tags) returns Pet[]|error

Finds Pets by tags

Parameters
  • tags string[]? (default ()) - Tags to filter by
Return Type

getPetById

Isolated FunctionRemote Function
function getPetById(int petId) returns Pet|error

Find pet by ID

Parameters
  • petId int - ID of pet to return
Return Type

updatePetWithForm

Isolated FunctionRemote Function
function updatePetWithForm(int petId, string? name, string? status) returns Response|error

Updates a pet in the store with form data

Parameters
  • petId int - ID of pet that needs to be updated
  • name string? (default ()) - Name of pet that needs to be updated
  • status string? (default ()) - Status of pet that needs to be updated
Return Type

deletePet

Isolated FunctionRemote Function
function deletePet(int petId, string? api_key) returns Response|error

Deletes a pet

Parameters
  • petId int - Pet id to delete
  • api_key string? (default ()) - 
Return Type

uploadFile

Isolated FunctionRemote Function
function uploadFile(int petId, byte[] payload, string? additionalMetadata) returns ApiResponse|error

uploads an image

Parameters
  • petId int - ID of pet to update
  • payload byte[] - 
  • additionalMetadata string? (default ()) - Additional Metadata
Return Type

Records

petstore_api: ApiResponse

Fields

petstore_api: Category

Fields

petstore_api: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

petstore_api: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

petstore_api: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields
  • tokenUrl string(default "https://sts.choreo.dev:443/oauth2/token") - Token URL

petstore_api: Pet

Fields
  • status string? - pet status in the store

petstore_api: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

petstore_api: Tag

Fields

Import

import mohanadarshanvivekanandalingam/petstore_api;Copy

Metadata

Released date: over 1 year ago

Version: 1.0.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Other versions

1.0.0

Dependencies

ballerina/http/2.6.1ballerina/url/2.2.4

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC