OpenAPI_Photo_Management

Principle

Basic photo management API created with OpenAPI 3 that serve basic CRUD via HTTP

Table of Contents

Ressources
Requests
Schemas
Example

Ressources

• OpenAPI specification can be found here.
• Basics about HTTP requests and response codes can be found here.

Requests

Type	Route	Request Body	Response Body
POST	/photo	Photo	Status Code: 201 - Success: {message: ‘Photo successfully created’, id: photo_id} Status Code: 422 - Error: {message: err}
GET	/photos	access	Status Code: 200 - Photos: [{Photo}, ..] Status Code: 404 - Error: {message: err}
GET	/photo/{photo_id}	-	Status Code: 200 - Photo: {id: id, name: name, description: description, access: access, location: location, created_date: created_date, modified_date: modified_date} Status Code: 404 - Error: {message: err}
PUT	/photo/{photo_id}	Photo	Status Code: 200 - Success: {message: ‘Photo successfully updated’, id: photo_id} Status Code: 404 - Error: {message: err} Status Code: 422 - Error: {message: err}
DELETE	/photo/{photo_id}	-	Status Code: 204 Status Code: 404 - Error: {message: err}

Schemas

• Photo

  Attribute	Type	Conditions
  id	string	readOnly: true
  name	string	required:true maxlenght: 20
  description	string	maxlenght: 100
  access	string	required:true enum: [public, private]
  location	string	required:true
  file	string	required:true
  created_date	string	required:true format: date-time
  updated_date	string	required:true format: date-time

• Photos

  Attribute	Type	Description
  [Photo]	array	An array of photos

• Success

  Attribute	Type	Conditions
  message	string	-
  id	string	-

• Error

  Attribute	Type	Conditions
  message	string	-

Example

Photo schema:

{
  "name": "Photo_3",
  "description": "My dog selfie",
  "access": "public",
  "location": "Skopje",
  "file": "teddy_selfie.jpg",
  "created_date": "1996-08-23T17:32:28Z",
  "modified_date": "2020-12-27T23:45:28Z"
}