AM-270 update docusaurus to v2.

Add search capability in docs Add openapi v3 page
ARGOeu · Aug 29, 2022 · 1d91c0e · 1d91c0e
1 parent 2bf110c
commit 1d91c0e
Show file tree

Hide file tree

Showing 83 changed files with 8,002 additions and 4,991 deletions.
diff --git a/doc/v1/docs/api_health.md b/doc/v1/docs/api_health.md
@@ -18,7 +18,7 @@ information about errors regarding the push server.
 - A user token corresponding to a `service_admin` or `admin_viewer`
 has to be provided when using the `details` parameter.
 
-```
+```bash
 curl -H "Content-Type: application/json"
  "https://{URL}/v1/status?details=true&key=token"
 ```

diff --git a/doc/v1/docs/api_metrics.md b/doc/v1/docs/api_metrics.md
@@ -6,14 +6,14 @@ Operational Metrics include metrics related to the CPU or memory usage of the am
 This request gets a list of operational metrics for the specific ams servcice
 
 ### Request
-```json
+```
 GET "/v1/metrics"
 ```
 
 
 ### Example request
 
-```json
+```bash
 curl -H "Content-Type: application/json"
  "https://{URL}/v1/metrics?key=S3CR3T"
 ```
@@ -81,14 +81,14 @@ GET "/v1/metrics/va_metrics"
 
 ### Example request
 
-```
+```bash
 curl -H "Content-Type: application/json"
  "https://{URL}/v1/metrics/va_metrics"
 ```
 
 ### Example request with URL parameters
 
-```
+```bash
 curl -H "Content-Type: application/json"
  "https://{URL}/v1/metrics/va_metrics?start_date=2019-03-01&end_date=2019-07-24&projects=ARGO,ARGO-2"
 ```

diff --git a/doc/v1/docs/api_projects.md b/doc/v1/docs/api_projects.md
@@ -11,7 +11,7 @@ GET "/v1/projects"
 ```
 
 ### Example request
-```
+```bash
 curl -X GET -H "Content-Type: application/json"
   "https://{URL}/v1/projects?key=S3CR3T"
 ```
@@ -24,7 +24,6 @@ Success Response
 
 
 ```json
-
 {
  "projects": [
     {
@@ -69,7 +68,7 @@ GET "/v1/projects/{project_name}"
 
 
 ### Example request
-```
+```bash
 curl -X GET -H "Content-Type: application/json"
   "https://{URL}/v1/projects/BRAND_NEW?key=S3CR3T"
 ```
@@ -116,9 +115,9 @@ POST "/v1/projects/{project_name}"
 ### Example request
 
 
-```
+```bash
 curl -X POST -H "Content-Type: application/json"
- -d POSTDATA "https://{URL}/v1/projects/PROJECT_NEW?key=S3CR3T"
+ -d $POSTDATA "https://{URL}/v1/projects/PROJECT_NEW?key=S3CR3T"
 ```
 
 ### Responses  
@@ -144,7 +143,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request updates information (such as name,description) on an existing project (PUT)
 
 ### Request
-```json
+```
 PUT "/v1/projects/{project_name}"
 ```
 
@@ -160,9 +159,9 @@ PUT "/v1/projects/{project_name}"
 ```
 
 ### Example request
-```
+```bash
 curl -X PUT -H "Content-Type: application/json"
- -d POSTDATA "https://{URL}/v1/projects/PROJECT_NEW?key=S3CR3T"
+ -d $POSTDATA "https://{URL}/v1/projects/PROJECT_NEW?key=S3CR3T"
 ```
 
 ### Responses  
@@ -188,7 +187,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request deletes a specific project
 
 ### Request
-```json
+```
 DELETE "/v1/projects/{project_name}"
 ```
 
@@ -197,7 +196,7 @@ DELETE "/v1/projects/{project_name}"
 
 ### Example request
 
-```json
+```bash
 curl -X DELETE -H "Content-Type: application/json"  
  "https://{URL}/v1/projects/BRAND_NEW?key=S3CR3T"
 ```
@@ -217,7 +216,7 @@ containing the projects, subscriptions and topics that the user belongs to.
 
 
 ### Example request
-```
+```bash
 curl -X GET -H "Content-Type: application/json"
   "https://{URL}/v1/projects/ARGO2/members?key=S3CR3T&details=true"
 ```
@@ -293,7 +292,7 @@ returned remove user information such as `token`, `service_roles` and `created_b
 ### [GET] Show a specific member user of the specific project
 
 ### Example request
-```
+```bash
 curl -X GET -H "Content-Type: application/json"
   "https://{URL}/v1/projects/ARGO2/members/Test?key=S3CR3T"
 ```
@@ -339,9 +338,9 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 ### [POST] Create a new member user under the specific project
 
 ### Example request
-```
+```bash
 curl -X POST -H "Content-Type: application/json"
-  -d POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser?key=S3CR3T"
+  -d $POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser?key=S3CR3T"
 ```
 
 ### Post body:
@@ -393,9 +392,9 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 ### [PUT] Updates the roles for a member user under the specific project
 
 ### Example request
-```
+```bash
 curl -X PUT -H "Content-Type: application/json"
-  -d POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser?key=S3CR3T"
+  -d $POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser?key=S3CR3T"
 ```
 
 ### Post body:
@@ -446,9 +445,9 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 ### [POST] Add/Invite a user to a project
 
 ### Example request
-```
+```bash
 curl -X POST -H "Content-Type: application/json"
-  -d POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser:add?key=S3CR3T"
+  -d $POSTDATA "https://{URL}/v1/projects/ARGO2/members/NewUser:add?key=S3CR3T"
 ```
 
 ### Post body:
@@ -495,7 +494,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 ### [POST] Remove a user from the project
 
 ### Example request
-```
+```bash
 curl -X POST -H "Content-Type: application/json"
  "https://{URL}/v1/projects/ARGO2/members/NewUser:remove?key=S3CR3T"
 ```
@@ -526,7 +525,7 @@ GET "/v1/projects/{project_name}:metrics"
 
 ### Example request
 
-```json
+```bash
 curl  -H "Content-Type: application/json"
 "https://{URL}/v1/projects/BRAND_NEW:metrics?key=S3CR3T"
 ```

diff --git a/doc/v1/docs/api_registrations.md b/doc/v1/docs/api_registrations.md
@@ -6,7 +6,7 @@ ARGO Messaging Service supports calls for registering users
 This request creates a new registration for a future user
 
 ### Request
-```json
+```
 POST "/v1/registrations
 ```
 
@@ -61,7 +61,7 @@ This request accepts a user's registration
 and as a result it creates a new user with the provided information.
 
 ### Request
-```json
+```
 POST "/v1/registrations/{uuid}:accept"
 ```
 
@@ -102,7 +102,7 @@ You can also provide a comment regarding
 the decline reason of the registration.
 
 ### Request
-```json
+```
 POST "/v1/registrations/{uuid}:decline"
 ```
 ### Post body:
@@ -135,7 +135,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request retrieves a user's registration 
 
 ### Request
-```json
+```
 GET "/v1/registrations/{uuid}"
 ```
 
@@ -174,7 +174,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request retrieves all registration in the service
 
 ### Request
-```json
+```
 GET "/v1/registrations"
 ```
 

diff --git a/doc/v1/docs/api_schemas.md b/doc/v1/docs/api_schemas.md
@@ -6,7 +6,7 @@ Schemas is a resource that works with topics by validating the published message
 This request retrieves a specific schema under the given project
 
 ### Request
-```json
+```
 GET "/v1/projects/{project_name}/schemas/{schema_name}"
 ```
 
@@ -15,9 +15,9 @@ GET "/v1/projects/{project_name}/schemas/{schema_name}"
 - schema_name: Name of the schema to be created
 
 ### Example request
-```json
+```bash
 curl -X GET -H "Content-Type: application/json"
- " https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
+ "https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
 ```
 
 ### Responses  
@@ -62,17 +62,17 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request retrieves all schemas under the given project.
 
 ### Request
-```json
+```
 GET "/v1/projects/{project_name}/schemas"
 ```
 
 ### Where
 - project_name: Name of the project in which the schema will belong
 
 ### Example request
-```json
+```bash
 curl -X GET -H "Content-Type: application/json"
- " https://{URL}/v1/projects/project-1/schemas?key=S3CR3T"
+ "https://{URL}/v1/projects/project-1/schemas?key=S3CR3T"
 ```
 
 ### Responses  
@@ -151,7 +151,7 @@ This request creates a new schema
 > JSON,AVRO
 
 ### Request
-```json
+```
 POST "/v1/projects/{project_name}/schemas/{schema_name}"
 ```
 
@@ -160,9 +160,9 @@ POST "/v1/projects/{project_name}/schemas/{schema_name}"
 - schema_name: Name of the schema to be created
 
 ### Example request
-```json
-curl -X POST -H "Content-Type: application/json -d POSTDATA"
- " https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
+```bash
+curl -X POST -H "Content-Type: application/json" -d $POSTDATA
+ "https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
 ```
 
 ### Post body:
@@ -225,7 +225,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request updates the contents of a schema. You can update `one` or `all` of the fields at a time.
 
 ### Request
-```json
+```
 PUT "/v1/projects/{project_name}/schemas/{schema_name}"
 ```
 
@@ -234,9 +234,9 @@ PUT "/v1/projects/{project_name}/schemas/{schema_name}"
 - schema_name: Name of the schema to be updated
 
 ### Example request
-```json
-curl -X PUT -H "Content-Type: application/json -d POSTDATA"
- " https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
+```bash
+curl -X PUT -H "Content-Type: application/json" -d $POSTDATA
+ "https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
 ```
 
 ### Post body:
@@ -302,7 +302,7 @@ Please refer to section [Errors](api_errors.md) to see all possible Errors
 This request deletes a schema.
 
 ### Request
-```json
+```
 DELETE "/v1/projects/{project_name}/schemas/{schema_name}"
 ```
 
@@ -311,9 +311,9 @@ DELETE "/v1/projects/{project_name}/schemas/{schema_name}"
 - schema_name: Name of the schema to be deleted
 
 ### Example request
-```json
+```bash
 curl -X DELETE -H "Content-Type: application/json"
- " https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
+ "https://{URL}/v1/projects/project-1/schemas/schema-1?key=S3CR3T"
 ```
 
 ### Responses  
@@ -322,7 +322,7 @@ If successful, the response is empty.
 
 Success Response
 `200 OK`
-```json
+```
 ```
 
 ### Errors
@@ -336,7 +336,7 @@ publish it to the topic.Instead of creating all this pipeline in order to check
 we can explicitly do it on this API call.
 
 ### Request
-```json
+```
 POST "/v1/projects/{project_name}/schemas/{schema_name}:validate"
 ```
 
@@ -345,9 +345,9 @@ POST "/v1/projects/{project_name}/schemas/{schema_name}:validate"
 - schema_name: Name of the schema to be updated
 
 ### Example request
-```json
-curl -X POST -H "Content-Type: application/json -d POSTDATA"
- " https://{URL}/v1/projects/project-1/schemas/schema-1:validate?key=S3CR3T"
+```bash
+curl -X POST -H "Content-Type: application/json" -d $POSTDATA
+ "https://{URL}/v1/projects/project-1/schemas/schema-1:validate?key=S3CR3T"
 ```
 
 ### Post body: