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

feat(selfDescription)!: selfDescriptionDocument can be send as json #107

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Phil91
Copy link
Member

@Phil91 Phil91 commented Jun 27, 2023

Description

the data structure for the endpoints

/api/administration/connectors/clearinghouse/selfDescription
/api/administration/registration/clearinghouse/selfDescription

have been changed for selfDescriptionDocument from string to JsonDocument

BREAKING CHANGE: data structure for endpoints changed

Why

The external requests are sending the selfDescription document as json, it's easier to take it as it is and don't have the external services convert the json to a string

Issue

N/A - Jira Issue: CPLP-2847

Checklist

Please delete options that are not relevant.

  • I have followed the contributing guidelines
  • I have performed a self-review of my own code
  • I have successfully tested my changes locally
  • I have added tests that prove my changes work
  • I have checked that new and existing tests pass locally with my changes
  • I have commented my code, particularly in hard-to-understand areas

@Phil91 Phil91 marked this pull request as ready for review June 27, 2023 08:11
@Phil91 Phil91 requested a review from ntruchsess June 27, 2023 08:11
@Phil91 Phil91 added the merge postponed the merge of this PR shall be postponed until all prerequisites are fulfilled label Jun 27, 2023
@ntruchsess ntruchsess self-assigned this Jun 28, 2023
@Phil91 Phil91 force-pushed the feature/CPLP-2847-selfDescription branch from b08a595 to 3f925bd Compare June 28, 2023 09:37
@Phil91 Phil91 requested a review from ntruchsess June 28, 2023 09:38
ntruchsess
ntruchsess previously approved these changes Jun 29, 2023
@ntruchsess ntruchsess added the breaking change PR shall be handled with extra care as it breaks existing functionality label Jun 29, 2023
@Phil91 Phil91 force-pushed the feature/CPLP-2847-selfDescription branch from 3f925bd to f40a33d Compare July 4, 2023 20:05
the data structure for the endpoints

/api/administration/Connectors/clearinghouse/selfDescription
/api/administration/registration/clearinghouse/selfDescription

have been changed for selfDescriptionDocument from string to JsonDocument

Refs: CPLP-2847
BREAKING CHANGE: data structure for endpoints changed
@ntruchsess ntruchsess force-pushed the feature/CPLP-2847-selfDescription branch 4 times, most recently from 4e16bc4 to c8c547c Compare July 14, 2023 08:07
ntruchsess
ntruchsess previously approved these changes Jul 14, 2023
@ntruchsess ntruchsess force-pushed the feature/CPLP-2847-selfDescription branch from 4ca04a8 to f15b494 Compare July 14, 2023 16:02
@sonarcloud
Copy link

sonarcloud bot commented Jul 14, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

ntruchsess
ntruchsess previously approved these changes Jul 14, 2023
@evegufy evegufy changed the base branch from dev to change-to-main June 21, 2024 14:07
@evegufy evegufy changed the base branch from change-to-main to main June 21, 2024 15:33
@evegufy evegufy dismissed ntruchsess’s stale review June 21, 2024 15:33

The base branch was changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change PR shall be handled with extra care as it breaks existing functionality merge postponed the merge of this PR shall be postponed until all prerequisites are fulfilled
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants