Move redocly config to nym-api/

nymtech · Dec 19, 2024 · 9120020 · 9120020
1 parent a7f4608
commit 9120020
Show file tree

Hide file tree

Showing 6 changed files with 7,472 additions and 101 deletions.
diff --git a/.redocly.yaml b/.redocly.yaml
diff --git a/.redocly.lint-ignore.yaml → nym-api/redocly/.redocly.lint-ignore.yaml b/.redocly.lint-ignore.yaml → nym-api/redocly/.redocly.lint-ignore.yaml
@@ -2,22 +2,18 @@
 # See https://redocly.com/docs/cli/ for more information.
 formatted-openapi.json:
   path-parameters-defined:
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/0/name
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/1/name
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/2/name
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/3/name
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/4/name
-    # - >-
-    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/5/name
-    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/0/name'
-    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/1/name'
-    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/2/name'
-    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/3/name'
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/0/name
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/1/name
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/2/name
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/3/name
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/4/name
+    - >-
+      #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/5/name
   operation-operationId-unique:
     - >-
       #/paths/~1v1~1status~1mixnodes~1active~1detailed/get/get_active_set_detailed
@@ -30,6 +26,7 @@ formatted-openapi.json:
     - '#/components/schemas/EcashTicketVerificationRejection'
     - '#/components/schemas/ExpirationDatePathParam'
     - '#/components/schemas/FullFatNode'
+    - '#/components/schemas/G2ProjectiveSchema'
     - '#/components/schemas/HistoricalPerformanceResponse'
     - '#/components/schemas/HistoricalUptimeResponse'
     - '#/components/schemas/MasterVerificationKeyResponse'
@@ -41,6 +38,7 @@ formatted-openapi.json:
     - '#/components/schemas/NymNodeDetails'
     - '#/components/schemas/PaginationRequest'
     - '#/components/schemas/PartialCoinIndicesSignatureResponse'
+    - '#/components/schemas/PayInfo'
     - '#/components/schemas/SpentCredentialsResponse'
     - '#/components/schemas/UptimeHistoryResponse'
     - '#/components/schemas/VerifyEcashCredentialBody'

diff --git a/nym-api/redocly/.redocly.yaml b/nym-api/redocly/.redocly.yaml
@@ -0,0 +1,12 @@
+extends:
+  - minimal
+apis:
+  nym-api:
+    root: ./formatted-openapi.json
+rules:
+  # https://redocly.com/docs/cli/rules/oas/operation-summary
+  operation-summary: off
+  # https://redocly.com/docs/cli/rules/oas/security-defined
+  security-defined: off
+  # https://redocly.com/docs/cli/rules/oas/operation-2xx-response
+  operation-2xx-response: off