diff --git a/web/docs/apollo/openapi.md b/web/docs/apollo/openapi.md index 57fc170..667dd5f 100644 --- a/web/docs/apollo/openapi.md +++ b/web/docs/apollo/openapi.md @@ -8,880 +8,9 @@ Most likely, it is not desirable to edit this file by hand! # Peridot Apollo 0.1.0 Apollo Errata Management + +Endpoint: https://apollo.build.resf.org
-## non-api - -
- -### GET / -List Advisories - -**Input parameters** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterInTypeDefaultNullableDescription
pagequeryinteger1No
searchquerystringNo
sizequeryinteger50No
- -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - -
- -### GET /{advisory_name} -Get Advisory - -**Input parameters** - - - - - - - - - - - - - - - - - - - - - - -
ParameterInTypeDefaultNullableDescription
advisory_namepathstringNo
- -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - -
- -### GET /statistics/ -Statistics - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -
- -### GET /login/ -Login Page - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - -
- -### POST /login/ -Do Login -

Request body

- - - -=== "application/x-www-form-urlencoded" - - - ```json - { - "email": "string", - "password": "string" - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the request body" - ```json - { - "title": "Body_do_login_login__post", - "type": "object", - "properties": { - "email": { - "title": "Email", - "type": "string" - }, - "password": { - "title": "Password", - "type": "string" - } - } - } - ``` - - - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - -
- -### POST /login/setup -Setup Page -

Request body

- - - -=== "application/x-www-form-urlencoded" - - - ```json - { - "name": "string", - "email": "string", - "password": "string", - "confirm_password": "string" - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the request body" - ```json - { - "title": "Body_setup_page_login_setup_post", - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string" - }, - "email": { - "title": "Email", - "type": "string" - }, - "password": { - "title": "Password", - "type": "string" - }, - "confirm_password": { - "title": "Confirm Password", - "type": "string" - } - } - } - ``` - - - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - -
- -### GET /logout/ -Logout - -

- Response 200 OK -

- -=== "application/json" - - - - ??? hint "Schema of the response body" - ```json - - ``` - - - -
- -### GET /admin/ -Admin General - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -
- -### GET /red_hat/advisories -List Red Hat Advisories - -**Input parameters** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterInTypeDefaultNullableDescription
pagequeryinteger1No
sizequeryinteger50No
- -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - -
- -### GET /red_hat/advisories/{advisory_name} -Get Red Hat Advisory - -**Input parameters** - - - - - - - - - - - - - - - - - - - - - - -
ParameterInTypeDefaultNullableDescription
advisory_namepathstringNo
- -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - -
- -### POST /red_hat/advisories/{advisory_name} -Execute Red Hat Advisory Action - -**Input parameters** - - - - - - - - - - - - - - - - - - - - - - -
ParameterInTypeDefaultNullableDescription
advisory_namepathstringNo
-

Request body

- - - -=== "application/x-www-form-urlencoded" - - - ```json - { - "action": "string", - "data": "string" - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the request body" - ```json - { - "title": "Body_execute_red_hat_advisory_action_red_hat_advisories__advisory_name__post", - "required": [ - "action", - "data" - ], - "type": "object", - "properties": { - "action": { - "title": "Action", - "type": "string" - }, - "data": { - "title": "Data", - "type": "string" - } - } - } - ``` - - - -

- Response 200 OK -

- -=== "text/html" - - - ```json - "string" - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "type": "string" - } - ``` - - - -

- Response 422 Unprocessable Entity -

- -=== "application/json" - - - ```json - { - "detail": [ - { - "loc": [ - null - ], - "msg": "string", - "type": "string" - } - ] - } - ``` - ⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information. - - - - ??? hint "Schema of the response body" - ```json - { - "title": "HTTPValidationError", - "type": "object", - "properties": { - "detail": { - "title": "Detail", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationError" - } - } - } - } - ``` - - - - ## advisories