Angular Update Assistant

Angular Update Assistant · Acciones GPT

Angular Update Assistant API

This API assists developers in updating Angular projects by providing tailored update steps based on project specifics and options.

  • GET /stepsGet update steps for Angular projects

    Retrieves a set of steps for updating an Angular project based on the current and target versions, project complexity, and other options.

Esquema original API
{
  "openapi": "3.0.0",
  "info": {
    "title": "Angular Update Assistant API",
    "description": "This API assists developers in updating Angular projects by providing tailored update steps based on project specifics and options.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://gpt.danielkreitsch.com/api/angular-update",
      "description": "Main API server for Angular Update Assistant"
    }
  ],
  "paths": {
    "/steps": {
      "get": {
        "operationId": "getUpdateSteps",
        "summary": "Get update steps for Angular projects",
        "description": "Retrieves a set of steps for updating an Angular project based on the current and target versions, project complexity, and other options.",
        "parameters": [
          {
            "name": "currentVersion",
            "in": "query",
            "required": true,
            "description": "Current version of the Angular project",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "targetVersion",
            "in": "query",
            "required": true,
            "description": "Target version to update to",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "complexity",
            "in": "query",
            "required": false,
            "description": "Complexity level of the project (1-Basic, 2-Medium, 3-Advanced)",
            "schema": {
              "type": "string",
              "default": "1"
            }
          },
          {
            "name": "ngUpgrade",
            "in": "query",
            "required": false,
            "description": "Whether ngUpgrade is used for combining AngularJS & Angular",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "material",
            "in": "query",
            "required": false,
            "description": "Whether Angular Material is used in the project",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "windows",
            "in": "query",
            "required": false,
            "description": "Whether the project is developed on Windows",
            "schema": {
              "type": "boolean",
              "default": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with update steps",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Step"
                      }
                    },
                    "during": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Step"
                      }
                    },
                    "after": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Step"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request due to invalid input parameters"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Step": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}