Dale Smith b368c65bb9 Removal of django-rest-swagger

The library is end of life and out of date for recent python.

This change completes the removal from Adjutant, as was
started in I102e94c8172f6ea660814dd8fcd44ed8239b2e67

A viable replacement library may be drf-yasg, and may be
implemented in the future.

Co-Authored-By: matthewnorthcott@catalystcloud.nz
Change-Id: Ifd43db86f801bd16aea358245c0e8a5392e66d55

2025-01-20 09:18:01 +13:00

1.8 KiB

Raw Blame History

Admin Logic Version 1 API reference

This is the reference for Adjutant when it is using the default configuration. Different deployments may exclude certain DelegateAPIs or include their own additional ones.

The core functionality of Adjutant is built around the concept of tasks and actions.

Actions are both concepts in the database and code that can execute whatever logic is necessary at each stage.

Tasks can bundle a number of actions and have 3 main steps.

A user submits a request to the specified endpoint.
An admin approves the request, or it is automatically approved. At this point the admin can also update invalid data inside the task.
If necessary a user will be emailed a token and will submit additional data (ie passwords or a confirmation) to finish the task.

Depending on the task and the data provided some steps may be skipped.

Authentication

The 'X-Auth-Token' header value should be provided for authentication with a valid Keystone token.

HTTP Status Codes

200

200: task-view

202

400

401

403

404

405

409

500

503

Service Discovery

Version Discovery Endpoint

Unauthenticated.

JSON containing details of the currently available versions (just v1 for now)

Normal response code: 200

Version One Details Endpoint