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

updated links and curl requests in Catalog for upcoming V5 Api changes #6375

Merged

Conversation

gmzakpinar
Copy link
Contributor

No description provided.

Copy link
Collaborator

@MarkvanMents MarkvanMents left a 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

content/en/docs/catalog/manage/search.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/manage/search.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@MarkvanMents MarkvanMents left a 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!

content/en/docs/catalog/manage/search.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
{{% 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).
Copy link
Collaborator

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.

Copy link
Contributor

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

content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
content/en/docs/catalog/register/register-data.md Outdated Show resolved Hide resolved
@quinntracy
Copy link
Collaborator

@MarkvanMents @NammNguyen Have you both finished your updates? If so, I can mark this PR as approved so we can merge it when appropriate.

@MarkvanMents
Copy link
Collaborator

@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.

Copy link
Collaborator

@MarkvanMents MarkvanMents left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now.

@MarkvanMents
Copy link
Collaborator

Release confirmed over Slack

@MarkvanMents MarkvanMents merged commit 4a53291 into mendix:development Jun 20, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

5 participants