-
Notifications
You must be signed in to change notification settings - Fork 724
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
updated links and curl requests in Catalog for upcoming V5 Api changes #6375
updated links and curl requests in Catalog for upcoming V5 Api changes #6375
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Gamze (@gmzakpinar)
Thanks for the PR.
Looks good. I've made a couple of review comments which may need to be looked at.
Mark
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
I've made a couple of suggestions, but nothing major.
Glad this has finally made it to publication!
{{% alert color="warning" %}} | ||
Once a version is released to production, any updated contracts should be given a new version. This applies even if you are only registering for a non-production environment. | ||
|
||
This is because changes to a particular version of a published OData service are reflected in the entities and attributes available through the Catalog, for every environment for which the service is published. For example, if you have version 1.0.0 published to both non-production and production environments, any changes you make to version 1.0.0 of the service in the non-production environment are also reflected in the service in production. | ||
{{% /alert %}} | ||
|
||
For more details on what can and cannot be provided in these fields, see the [API specification](https://datahub-spec.s3.eu-central-1.amazonaws.com/registration_v4.html#/Register/put_applications__AppUUID__environments__EnvironmentUUID__published_endpoints). | ||
For more details on what can and cannot be provided in these fields, see the [API specification](https://datahub-spec.s3.eu-central-1.amazonaws.com/registration_v5.html#/Register/put_applications__AppUUID__environments__EnvironmentUUID__published_endpoints). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can publish the spec directly on the docs site if you want. We now support Swagger.
But we can discuss this as a future change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes agreed, all our specs are currently on S3 and they are quite big with lots of schemas
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
Co-authored-by: Mark van Ments <[email protected]>
…m/gmzakpinar/mendix-docs into reg-466-update-v5-links-and-curls
@MarkvanMents @NammNguyen Have you both finished your updates? If so, I can mark this PR as approved so we can merge it when appropriate. |
I don't have anything else. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now.
Release confirmed over Slack |
No description provided.