Registro de cambios de API de proyectos
En este registro de cambios, puede obtener información sobre los últimos cambios, mejoras y actualizaciones para la API de proyectos. El registro de cambios lista los cambios realizados, ordenados por la fecha en que se publicaron. Los cambios en las versiones de la API existentes se han diseñado para que sean compatibles con las aplicaciones de cliente existentes.
3 de abril de 2024
La API de proyectos v1.0.0 ya está disponible. Asegúrate de actualizar tu versión desde beta.
Los cambios siguientes afectan a la paginación de las operaciones de list. Para obtener más información, consulte la sección paginación de los documentos de la API de proyectos.
proyectos de lista
GET /v1/projects
- El parámetro de consulta de señal de página se ha renombrado de
startatoken.- Por ejemplo, la llamada a la operación
list-projectsha cambiado deGET /v1/projects?limit=5&start={page_token}aGET /v1/projects?limit=5&token={page_token}.
- Por ejemplo, la llamada a la operación
- La primera página se devuelve sin el parámetro de consulta de señal en el URL de solicitud. Por ejemplo,
GET /v1/projects?limit=5oGET /v1/projects.- La primera página también se devuelve cuando la señal de página especificada no es válida.
- Los campos
lastypreviousya no están soportados, ni incluidos en la carga útil de respuesta.
configuración de lista
GET /v1/projects/{project_id}/configs
- Esta operación ahora está paginada.
- Se devuelve un valor predeterminado de 10 registros si no se especifica el tamaño de página en el parámetro de consulta
limit.- El tamaño máximo de página es de 100 registros.
- La primera página se devuelve sin el parámetro de consulta de señal en el URL de solicitud. Por ejemplo,
GET /v1/projects/{project_id}/configs/?limit=5oGET /v1/projects/{project_id}/configs.- La primera página también se devuelve cuando la señal de página especificada no es válida.
lista-entornos
GET /v1/projects/{project_id}/environments
- Esta operación ahora está paginada.
- Se devuelve un valor predeterminado de 10 registros si no se especifica el tamaño de página en el parámetro de consulta
limit.- El tamaño máximo de página es de 100 registros.
- La primera página se devuelve sin el parámetro de consulta
tokenen el URL de solicitud. Por ejemplo,GET /v1/projects/{project_id}/environments/?limit=5oGET /v1/projects/{project_id}/environments.- La primera página también se devuelve cuando la señal de página especificada no es válida.
Métodos para dar soporte al apilamiento de arquitecturas desplegables
Experimental
Se han añadido métodos experimentales para dar soporte a apilamiento de arquitecturas desplegables.
6 de noviembre de 2023
La última actualización incluye el siguiente cambio de última hora:
- Los modelos de
configurationsresponsepara todos los métodos ya no utilizan unpipeline_state. Toda la información de estado de unconfigurationestá disponible en la propiedadstateaumentada en el esquema canónico de unconfiguration.
Cambios en proyectos y configuraciones
create-project: POST /v1/projects
- Ahora
resource_groupylocationse van a incluir en la carga útil derequest. Ya no están soportados como parámetros de consulta.
delete-config: PATCH /v1/projects/{project_id}/configs/{id}
- El parámetro de consulta
draft_onlyestá en desuso. - La API ahora da soporte a la supresión de
configurationde un ID de proyecto especificado yversion. Consulte proyectos#delete-config-version.
Puntos finales de configuración renombrados
Los siguientes puntos finales de configuración se renombran como se indica a continuación:
POST /v1/projects/{project_id}/configs/{id}/checkse ha cambiado aPOST /v1/projects/{project_id}/configs/{id}/validate.POST /v1/projects/{project_id}/configs/{id}/installse ha cambiado aPOST /v1/projects/{project_id}/configs/{id}/deploy.POST /v1/projects/{project_id}/configs/{id}/uninstallse ha cambiado aPOST /v1/projects/{project_id}/configs/{id}/undeploy.
Puntos finales de configuración sustituidos
Los métodos drafts se han sustituido por las operaciones versions de la forma siguiente:
GET /v1/projects/{project_id}/configs/{config_id}/draftsse ha cambiado aGET /v1/projects/{project_id}/configs/{id}/versions.GET /v1/projects/{project_id}/configs/{config_id}/drafts/{version}se ha cambiado aGET /v1/projects/{project_id}/configs/{id}/versions/{version}
Estados de configuración
El modelo de estado para configurations se ha aplanado. pipeline_state ya no está disponible y la propiedad state se ha aumentado para capturar todos los estados posibles de un configuration.
Los siguientes son los nuevos valores de state:
approveddeleteddeletingdeleting_faileddiscardeddeployeddeploying_faileddeployingsupercededundeployingundeploying_failedvalidatedvalidatingvalidating_failed
Todos los puntos finales de configuration incluyen esta propiedad state en el modelo response. Para ver un ejemplo, consulte proyectos#get-config-version-response.
Configuración de nuevos metadatos
El modelo response de operaciones configurations ahora define nuevos metadatos en la raíz. Si un trabajo approve se ha ejecutado en un configuration, se incluye una propiedad approved_version en la carga útil de response. De forma similar, si se ha ejecutado un trabajo deploy en un configuration, los metadatos deployed_version y last_deployed están disponibles en
el cuerpo response. La ejecución de un trabajo validation genera los metadatos last_validated, mientras que la ejecución de un trabajo undeploy genera los metadatos last_undeployed en response.
25 de octubre de 2023
En las operaciones projects y configurations, como create y update, las propiedades de definición como name y description deben proporcionarse ahora en un derivador
definition. De forma similar, estas propiedades ahora solo están disponibles dentro de un bloque definition en la carga útil response de las operaciones create, update, get y list. Se trata de un cambio rompedor que fue lanzado originalmente el 06 de julio de 2023. Las secciones siguientes proporcionan más información sobre los métodos afectados por esta actualización.
Proyectos
create-project: POST /v1/projects
- Para
request&response,name,descriptionydestroy_on_deleteahora están envueltos dentro de un objetodefinition. - Ahora se espera que los llamadores de este punto final suministren las propiedades de definición dentro de este derivador, por ejemplo:
definition: {“name”: “test”, “description”: “This is a test project”, “destroy_on_delete”: false}.- Si no se proporciona
destroy_on_delete, se asigna un valor predeterminado detrueen una operación de creación de proyecto.
- Si no se proporciona
- Consulte proyectos#create-project-request.
- De forma similar, en el cuerpo de
response, las propiedades mencionadas anteriormente ahora están disponibles en un bloquedefinition.- Consulte proyectos#create-project-response.
update-project: PATCH /v1/projects/{id}
- Para
request&response,name,descriptionydestroy_on_deleteahora están envueltos dentro de un objetodefinition. - Ahora se espera que los llamadores de este punto final suministren las propiedades de definición dentro de este derivador, por ejemplo:
definition: {“name”: “test_update”, “description”: “This is an updated test project“}.- Consulte proyectos#update-project-request.
- De forma similar, en el cuerpo de
response, las propiedades mencionadas anteriormente ahora están disponibles en un bloquedefinition.- Consulte proyectos#update-project-response.
get-projects: GET /v1/projects/{id}
- En el
responsede esta operación,name,descriptionydestroy_on_deleteestán ahora envueltos dentro de un bloquedefinition.- Consulte proyectos#get-project-response.
list-project: GET /v1/projects
- Cada proyecto que se devuelve en la matriz
responseenvuelve las propiedadesname,descriptionydestroy_on_deleteen un bloquedefinition.- Consulte proyectos#list-projects-response.
Configuraciones
create-config: POST /v1/projects/{project_id}/configs
- Para
request&response,locator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionahora se envuelven dentro de un objetodefinition. - Ahora se espera que los llamadores de este punto final suministren las propiedades de definición dentro de este derivador, por ejemplo:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Consulte proyectos#create-config-request.
- De forma similar, en el cuerpo de
response, las propiedades mencionadas anteriormente ahora están disponibles en un bloquedefinition.- También se incluye una propiedad
settingen el bloquedefinition. - Consulte proyectos#create-config-response.
- También se incluye una propiedad
update-config: PATCH /v1/projects/{project_id}/configs/{id}
- Para
request&response,locator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionahora se envuelven dentro de un objetodefinition. - Ahora se espera que los llamadores de este punto final suministren las propiedades de definición dentro de este derivador, por ejemplo:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Consulte proyectos#update-config-request.
- De forma similar, en el cuerpo
response, las propiedades mencionadas anteriormente se mueven a un bloquedefinition.- Consulte proyectos#update-config-response.
get-config: GET /v1/projects/{id}
- En el
responsede esta operación, loslocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionysettingse envuelven ahora dentro de un objetodefinition.- Consulte proyectos#get-config-response.
list-configs: GET /v1/projects/{project_id}/configs
- En el
responsede esta operación,nameydescriptionse envuelven ahora dentro de un objetodefinition.- Consulte proyectos#list-configs-response.
6 de julio de 2023
Los modelos de respuesta para todos los métodos ahora aplican un formato de serpiente minúscula en los valores state. Este formato se espera en la respuesta cuando se llama al proyecto y a los puntos finales de configuración. Esta
actualización es un cambio de última hora.
Los valores de state del proyecto ahora pueden ser ready, deleting y deleting_failed. Para ver un ejemplo, consulte el esquema de respuesta para el método update-project.
Los valores de configuración state ahora pueden ser deleted, deleting, deleting_failed, installed, installed_failed, installing, not_installed,
uninstalling, uninstalling_failed y active. Para ver un ejemplo, consulte el esquema de respuesta para el método get-config.