Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should we return all of the instance details when changing its configuration or status? #57

Open
LackOfMorals opened this issue Oct 7, 2024 · 0 comments

Comments

@LackOfMorals
Copy link

LackOfMorals commented Oct 7, 2024

When changing an instances configuration or status, we return entire instance configuration. E.g

aura instance update 74fdfdba --memory 16GB

{
	"data": {
		"cdc_enrichment_mode": "OFF",
		"cloud_provider": "gcp",
		"connection_url": "neo4j+s://74fdfdba.databases.neo4j.io",
		"id": "74fdfdba",
		"memory": "8GB",
		"metrics_integration_url": "https://customer-metrics-api.neo4j.io/api/v1/ad69ee24-25fc-5a66-af02-ff8d3cc23611/74fdfdba/metrics",
		"name": "[JG]CLI]\n",
		"region": "europe-west1",
		"secondaries_count": 0,
		"status": "resizing",
		"storage": "16GB",
		"tenant_id": "ad69ee24-25fc-5a66-af02-ff8d3cc23611",
		"type": "enterprise-db"
	}
}

In this particular case, returning all of the information can cause confusion as the memory still shows the old value of 8gb rather than the new 16gb. The new value will only be shown when the resizing operation is completed.

When an instance is configuration is changed, paused or resumed, we should only return the 'status' value to the end user with the CLI ( yes the aura API returns way more, but we don't need to show that ).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant