[Naam API-specificatie 2]¶

Release notes¶

[Overzicht van de wijzigingen die zijn aangebracht op de API-specificatie excl. de Release notes zelf.]

User stories¶

[Lijst van alle user stories die met de betreffende release van de API-specificatie zijn geïmplementeerd.]

Getting Started¶

Handelingen¶

Informatievragen¶

Rules¶

[Beschrijvingen van het gedrag dat de API moet vertonen in de vorm van gedrags-, afleidings- beperkingsregels, etc. Ook wel aanvullende specificaties genoemd. Een mogelijke vorm is Gherkin.]

OpenAPI specificatie¶

Note

Hier kun je uitklapbare tekst zetten

Swagger Petstore 1.0.0¶

License: MIT

Servers¶

Description	URL
http://petstore.swagger.io/v1	http://petstore.swagger.io/v1

pets¶

GET /pets¶

List all pets

Input parameters

Parameter	In	Type	Default	Nullable	Description
`limit`	query	integer		No	How many items to return at one time (max 100)

Response 200 OK

application/json

[
    {
        "id": 179,
        "name": "string",
        "tag": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "maxItems": 100,
    "items": {
        "$ref": "#/components/schemas/Pet"
    }
}

Response headers

Name	Description	Schema
`x-next`	A link to the next page of responses	string

Other responses

application/json

{
    "code": 157,
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /pets¶

Create a pet

Request body

application/json

{
    "id": 190,
    "name": "string",
    "tag": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "id",
        "name"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "name": {
            "type": "string"
        },
        "tag": {
            "type": "string"
        }
    }
}

Response 201 Created

Other responses

application/json

{
    "code": 24,
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /pets/{petId}¶

Info for a specific pet

Input parameters

Parameter	In	Type	Default	Nullable	Description
`petId`	path	string		No	The id of the pet to retrieve

Response 200 OK

application/json

{
    "id": 73,
    "name": "string",
    "tag": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "required": [
        "id",
        "name"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "name": {
            "type": "string"
        },
        "tag": {
            "type": "string"
        }
    }
}

Other responses

application/json

{
    "code": 240,
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "integer",
            "format": "int32"
        },
        "message": {
            "type": "string"
        }
    }
}

Schemas¶

Error¶

Name	Type
`code`	integer(int32)
`message`	string

Pet¶

Name	Type
`id`	integer(int64)
`name`	string
`tag`	string

Pets¶

Type: Array<Pet>