docs.syslogic.com.br Open in urlscan Pro
2606:4700:10::ac43:1ecf  Public Scan

URL: https://docs.syslogic.com.br/
Submission: On June 06 via api from US — Scanned from DE

Form analysis 1 forms found in the DOM

GET https://docs.syslogic.com.br/search.json

<form class="simple_form doc-search__form" data-action="ajax:success->doc-search#onPostSuccess ajax:error->doc-search#onPostError ajax:beforeSend->doc-search#onBeforeSend" data-doc-search-target="form"
  action="https://docs.syslogic.com.br/search.json" accept-charset="UTF-8" data-remote="true" method="get">
  <svg width="14" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" data-doc-search-target="searchIcon">
    <path d="m13 13-3-3M6.143 11.286A5.143 5.143 0 1 0 6.143 1a5.143 5.143 0 0 0 0 10.286Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path>
  </svg>
  <div class="loader doc-search__loader" aria-label="Loading" aria-live="assertive" aria-hidden="true" data-loader-type="bars" data-doc-search-target="loader"></div>
  <input label="false" autocomplete="off" type="hidden" name="uid" id="uid" value="0.fbfd35c30f209">
  <input label="false" autocomplete="off" autofocus="autofocus" data-doc-search-target="input" data-action="input->doc-search#submitOnType" class="string required" required="required" aria-required="true" placeholder="Search" type="text" name="query"
    id="query">
  <button type="button" class="esc-button" data-action="click->dialog#close">ESC</button>
</form>

Text Content

First api Show Menu
Search… Ctrl+K

ESC





Example searches: “/v3”, “Find out more about Swagger”, “status”,
“application/json”, “application/x-www-form-urlencoded”


Toggle dark mode

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

 * API Changelog

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

Download source
 * JSON OpenAPI specification
 * YAML OpenAPI specification

Find out more about Swagger


TOPICS

 * Introduction
 * Authentication


ENDPOINTS

 * pet
   * Update an existing pet
     PUT
   * Add a new pet to the store
     POST
   * Finds Pets by status
     GET
   * Finds Pets by tags
     GET
   * Find pet by ID
     GET
   * Updates a pet in the store with form data
     POST
   * Deletes a pet
     DELETE
   * Uploads an image
     POST
 * store
   * Returns pet inventories by status
     GET
   * Place an order for a pet
     POST
   * Find purchase order by ID
     GET
   * Delete purchase order by ID
     DELETE
 * user
   * Create user
     POST
   * Creates list of users with given input array
     POST
   * Logs user into the system
     GET
   * Logs out current logged in user session
     GET
   * Get user by user name
     GET
   * Update user
     PUT
   * Delete user
     DELETE

Powered by Bump.sh
Dismiss highlight Show more

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

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

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



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




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


SWAGGER PETSTORE - OPENAPI 3.0
1.0.17

Base URL

/v3

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:

 * The Pet Store repository
 * The source API definition for the Pet Store

This is the documentation for version 1.0.17 of the API. Last update on Jun 6,
2024.

This API is provided under license Apache 2.0.


AUTHENTICATION

The API accepts 2 different authentication methods:

 * petstore_auth (oauth2)
 * Api key (http_api_key)


PETSTORE_AUTH (OAUTH2)

Retrieve an Access Token with the OAuth 2.0 flows described below before
accessing the API. Once you have an access token, send it in the Authorization
HTTP header to authenticate with the API.








API KEY (HTTP_API_KEY)

Send an authentication token in the api_key header to authenticate with the API.


PET

Everything about your Pets

Find out more


UPDATE AN EXISTING PET

PUT /pet
petstore_auth

Update an existing pet by Id

application/json
application/json application/xml application/x-www-form-urlencoded

BODY REQUIRED

Update an existent pet in the store

 * id integer(int64)
 * name string Required
 * category object
   Hide category attributes Show category attributes
    * id integer(int64)
    * name string

 * photoUrls array[string] Required
 * tags array[object]
   Hide tags attributes Show tags attributes object
    * id integer(int64)
    * name string

 * status string
   
   pet status in the store
   
   Values are available, pending, or sold.

BODY REQUIRED

Update an existent pet in the store

 * id integer(int64)
 * name string Required
 * category object
   Hide category attributes Show category attributes
    * id integer(int64)
    * name string

 * photoUrls array[string] Required
 * tags array[object]
   Hide tags attributes Show tags attributes object
    * id integer(int64)
    * name string

 * status string
   
   pet status in the store
   
   Values are available, pending, or sold.

BODY REQUIRED

Update an existent pet in the store

 * id integer(int64)
 * name string Required
 * category object
   Hide category attributes Show category attributes
    * id integer(int64)
    * name string

 * photoUrls array[string] Required
 * tags array[object]
   Hide tags attributes Show tags attributes object
    * id integer(int64)
    * name string

 * status string
   
   pet status in the store
   
   Values are available, pending, or sold.

RESPONSES

 * • 200
   application/xml
   application/xml application/json
   
   Successful operation
   
   Hide response attributes Show response attributes object
    * id integer(int64)
    * name string Required
    * category object
      Hide category attributes Show category attributes
       * id integer(int64)
       * name string
   
    * photoUrls array[string] Required
    * tags array[object]
      Hide tags attributes Show tags attributes object
       * id integer(int64)
       * name string
   
    * status string
      
      pet status in the store
      
      Values are available, pending, or sold.
   
   Hide response attributes Show response attributes object
    * id integer(int64)
    * name string Required
    * category object
      Hide category attributes Show category attributes
       * id integer(int64)
       * name string
   
    * photoUrls array[string] Required
    * tags array[object]
      Hide tags attributes Show tags attributes object
       * id integer(int64)
       * name string
   
    * status string
      
      pet status in the store
      
      Values are available, pending, or sold.

 * • 400
   
   Invalid ID supplied

 * • 404
   
   Pet not found

 * • 405
   
   Validation exception

PUT /pet
cURL (application/json)
 * cURL (application/json)
 * cURL (application/xml)
 * cURL (application/x-www-form-urlencoded)

curl \
 -X PUT /v3/pet \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"id":10,"name":"doggie","category":{"id":1,"name":"Dogs"},"photoUrls":["string"],"tags":[{"id":42,"name":"string"}],"status":"available"}'

curl \
 -X PUT /v3/pet \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/xml"

curl \
 -X PUT /v3/pet \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'id=10&name=doggie&category=%7B%22id%22%3D%3E1%2C+%22name%22%3D%3E%22Dogs%22%7D&photoUrls=string&tags=%7B%22id%22%3D%3E42%2C+%22name%22%3D%3E%22string%22%7D&status=available'

Request example

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 42,
      "name": "string"
    }
  ],
  "status": "available"
}

Request example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">10</id>
  <name>doggie</name>
  <category>
    <id type="integer">1</id>
    <name>Dogs</name>
  </category>
  <photoUrls type="array">
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags type="array">
    <tag>
      <id type="integer">42</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</root>


Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">10</id>
  <name>doggie</name>
  <category>
    <id type="integer">1</id>
    <name>Dogs</name>
  </category>
  <photoUrls type="array">
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags type="array">
    <tag>
      <id type="integer">42</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</root>


Response examples (200)

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 42,
      "name": "string"
    }
  ],
  "status": "available"
}