api.md

ACG-EKS

Indices

• Clients API

  • Create
  • Delete (not available)
  • Get
  • List
  • Update

• Inventory API

  • List by Resource
  • List by Resource Unavailable (not available)
  • Register
  • Set Availability
  • Summary

• Renting API

  • List
  • List By Client Id
  • Register
  • Return

• Resources API

  • Create
  • Delete
  • Get
  • List
  • Update

---

Clients API

1. Create

Endpoint:

Method: POST
Type: RAW
URL: {{ClientsApiEndpoint}}/create

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
    "Name": "Pablo Maestre",
    "Email": "[email protected]"
}

2. Delete (not available yet)

Endpoint:

Method: DELETE
Type: 
URL: {{ClientsApiEndpoint}}/delete/5e11269570c0f10b912c572d

3. Get

Endpoint:

Method: GET
Type: 
URL: {{ClientsApiEndpoint}}/get/02eedaf2-d6bb-41db-b2af-c226a741da78

4. List

Endpoint:

Method: GET
Type: 
URL: {{ClientsApiEndpoint}}/list

5. Update

Endpoint:

Method: PUT
Type: RAW
URL: {{ClientsApiEndpoint}}/update/02eedaf2-d6bb-41db-b2af-c226a741da78

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"Name": "Yuranis Patricia Molina Heredia",
	"Email": "[email protected]"
}

Inventory API

1. List by Resource

Endpoint:

Method: GET
Type: 
URL: {{InventoryApiEndpoint}}/list/a0671dc6-3d6d-11ea-8dd9-38c98647e86c

2. List by Resource Unavailable

Endpoint:

Method: GET
Type: 
URL: {{InventoryApiEndpoint}}/list/a0671dc6-3d6d-11ea-8dd9-38c98647e86c

Query params:

Key	Value	Description
available	false

3. Register

Endpoint:

Method: POST
Type: RAW
URL: {{InventoryApiEndpoint}}/register

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"ResourceId": "a0671dc6-3d6d-11ea-8dd9-38c98647e86c"
}

4. Set Availability

Endpoint:

Method: PUT
Type: RAW
URL: {{InventoryApiEndpoint}}/setAvailability/9fa493c0-45bd-11ea-973b-efaa16fd349e

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"Available": true
}

5. Summary

Endpoint:

Method: GET
Type: 
URL: {{InventoryApiEndpoint}}/summary

Renting API

1. List

Endpoint:

Method: GET
Type: 
URL: {{RentingApiEndpoint}}/list

2. List By Client Id

Endpoint:

Method: GET
Type: 
URL: {{RentingApiEndpoint}}/list/by-client-id/4872e42e-b27c-4823-8f83-1383e047b5c2

3. Register

Endpoint:

Method: POST
Type: RAW
URL: {{RentingApiEndpoint}}/register

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
    "ResourceId": "a0671dc6-3d6d-11ea-8dd9-38c98647e86c",
    "ClientId": "599a9fcb-447d-4662-ac53-1ca092131ae2",
    "RegistrationDate": "06/02/2020"
}

4. Return

Endpoint:

Method: PUT
Type: RAW
URL: {{RentingApiEndpoint}}/return/e07042eb-295b-41c1-bb35-400ff4537057

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"ReturnDate": "07-02-2020"
}

Resources API

1. Create

Endpoint:

Method: POST
Type: RAW
URL: {{ResourceApiEndpoint}}/create

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"Name": "EKS course",
	"DateOfPublication": "2020",
	"Author": "Mario Mercado",
	"Tags": [
		"aws", "kubernetes", "cloud", "devops"
	],
	"Type": "DVD",
	"Description": "This is an amazing course, I think..."
}

2. Delete

Endpoint:

Method: DELETE
Type: 
URL: {{ResourceApiEndpoint}}/delete/5e0175e7618fcae0713d7543

3. Get

Endpoint:

Method: GET
Type: 
URL: {{ResourceApiEndpoint}}/get/a0671dc6-3d6d-11ea-8dd9-38c98647e86c

4. List

Endpoint:

Method: GET
Type: 
URL: {{ResourceApiEndpoint}}/list

5. Update

Endpoint:

Method: PUT
Type: RAW
URL: {{ResourceApiEndpoint}}/update/5e0175e7618fcae0713d7543

Headers:

Key	Value	Description
Content-Type	application/json

Body:

{
	"Name": "EKS course",
	"DateOfPublication": "2020",
	"Author": "Mario Mercado",
	"Tags": [
		"aws", "kubernetes", "cloud", "devops"
	],
	"Type": "DVD",
	"Description": "This is an amazing course, I think..."
}

---

Back to top

Made with ♥ by thedevsaddam | Generated at: 2020-08-20 21:56:55 by docgen