v4 public api fixes #3010 (#3048)

* v4 public api fixes #3010 * docs * change to expose recipe only * docs * formatting * v4 tests * renaming * unused imports Co-authored-by: Jared Lockhart <[email protected]>
mozilla · Jul 17, 2020 · 7a56230 · 7a56230
1 parent 68200a5
commit 7a56230
Show file tree

Hide file tree

Showing 16 changed files with 741 additions and 147 deletions.
diff --git a/app/experimenter/base/management/commands/generate_docs.py b/app/experimenter/base/management/commands/generate_docs.py
@@ -36,6 +36,10 @@ def generateSchema():
             elif "/api/v3/" in path:
                 for method in paths[path]:
                     paths[path][method]["tags"] = ["Rapid: Private"]
+            elif "/api/v4/" in path:
+                for method in paths[path]:
+                    paths[path][method]["tags"] = ["Rapid: Public"]
+
         return json.dumps(schema, indent=2)
 
     @staticmethod

diff --git a/app/experimenter/docs/openapi-schema.json b/app/experimenter/docs/openapi-schema.json
@@ -8520,6 +8520,255 @@
         ]
       }
     },
+    "/api/v4/experiments/": {
+      "get": {
+        "operationId": "listExperiments",
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "readOnly": true
+                      },
+                      "arguments": {
+                        "properties": {
+                          "slug": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "userFacingName": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "userFacingDescription": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "active": {
+                            "type": "string",
+                            "readOnly": true,
+                            "default": true
+                          },
+                          "isEnrollmentPaused": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "features": {
+                            "type": "array",
+                            "items": {
+                              "type": null
+                            }
+                          },
+                          "proposedEnrollment": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "bucketConfig": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "startDate": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "endDate": {
+                            "type": "string",
+                            "readOnly": true
+                          },
+                          "branches": {
+                            "type": "array",
+                            "items": {
+                              "properties": {
+                                "slug": {
+                                  "type": "string",
+                                  "maxLength": 255,
+                                  "pattern": "^[-a-zA-Z0-9_]+$"
+                                },
+                                "ratio": {
+                                  "type": "integer",
+                                  "maximum": 2147483647,
+                                  "minimum": 0
+                                },
+                                "value": {
+                                  "type": "string",
+                                  "readOnly": true
+                                }
+                              },
+                              "required": [
+                                "slug"
+                              ]
+                            }
+                          },
+                          "referenceBranch": {
+                            "type": "string",
+                            "readOnly": true
+                          }
+                        },
+                        "required": [
+                          "branches"
+                        ],
+                        "type": "object"
+                      },
+                      "filter_expression": {
+                        "type": "string",
+                        "readOnly": true
+                      },
+                      "enabled": {
+                        "type": "string",
+                        "readOnly": true,
+                        "default": true
+                      }
+                    },
+                    "required": [
+                      "arguments"
+                    ]
+                  }
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "tags": [
+          "Rapid: Public"
+        ]
+      }
+    },
+    "/api/v4/experiments/{slug}/": {
+      "get": {
+        "operationId": "retrieveExperiment",
+        "description": "",
+        "parameters": [
+          {
+            "name": "slug",
+            "in": "path",
+            "required": true,
+            "description": "",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "readOnly": true
+                    },
+                    "arguments": {
+                      "properties": {
+                        "slug": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "userFacingName": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "userFacingDescription": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "active": {
+                          "type": "string",
+                          "readOnly": true,
+                          "default": true
+                        },
+                        "isEnrollmentPaused": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "features": {
+                          "type": "array",
+                          "items": {
+                            "type": null
+                          }
+                        },
+                        "proposedEnrollment": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "bucketConfig": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "startDate": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "endDate": {
+                          "type": "string",
+                          "readOnly": true
+                        },
+                        "branches": {
+                          "type": "array",
+                          "items": {
+                            "properties": {
+                              "slug": {
+                                "type": "string",
+                                "maxLength": 255,
+                                "pattern": "^[-a-zA-Z0-9_]+$"
+                              },
+                              "ratio": {
+                                "type": "integer",
+                                "maximum": 2147483647,
+                                "minimum": 0
+                              },
+                              "value": {
+                                "type": "string",
+                                "readOnly": true
+                              }
+                            },
+                            "required": [
+                              "slug"
+                            ]
+                          }
+                        },
+                        "referenceBranch": {
+                          "type": "string",
+                          "readOnly": true
+                        }
+                      },
+                      "required": [
+                        "branches"
+                      ],
+                      "type": "object"
+                    },
+                    "filter_expression": {
+                      "type": "string",
+                      "readOnly": true
+                    },
+                    "enabled": {
+                      "type": "string",
+                      "readOnly": true,
+                      "default": true
+                    }
+                  },
+                  "required": [
+                    "arguments"
+                  ]
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "tags": [
+          "Rapid: Public"
+        ]
+      }
+    },
     "/api/v3/experiments/": {
       "post": {
         "operationId": "createExperiment",